Loading [MathJax]/extensions/tex2jax.js
Neko 0.9.99
A portable framework for high-order spectral element flow simulations
All Classes Namespaces Files Functions Variables Typedefs Enumerator Macros Pages
user_intf::user_t Type Reference

A type collecting all the overridable user routines. More...

Public Member Functions

procedure, pass(thisinit (this)
 Constructor that points non-associated routines to dummy ones. Calling a dummy routine causes an error in most cases, but sometimes the dummy routine just does nothing. E.g., the dummmy user_startup just does nothing. The association of the actual routines defined by the user happens in the user_setup routine inside the user file. A call to this routine is injected into the neko executable by makeneko.
 

Static Public Attributes

procedure(user_startup_intrf), pointer, nopass user_startup => null()
 Run as soon as the case file is read, with nothing else initialized. Use to manipulate the case file, and define custom parameters.
 
procedure(user_initialize_modules), pointer, nopass user_init_modules => null()
 Run after the entire case is initialized and restarted, but before the time loop. Good place to create auxillary fields, etc.
 
procedure(useric), pointer, nopass fluid_user_ic => null()
 Compute user initial conditions for the incompressible fluid.
 
procedure(useric_compressible), pointer, nopass fluid_compressible_user_ic => null()
 Compute user initial conditions for the compressible fluid.
 
procedure(useric_scalar), pointer, nopass scalar_user_ic => null()
 Compute user initial conditions for the scalar.
 
procedure(user_simcomp_init), pointer, nopass init_user_simcomp => null()
 Constructor for the user simcomp. Ran in the constructor of neko_simcomps.
 
procedure(usermsh), pointer, nopass user_mesh_setup => null()
 Run right after reading the mesh and allows to manipulate it.
 
procedure(usercheck), pointer, nopass user_check => null()
 Run at the end of each time-step in the time loop, right before field output to disk.
 
procedure(user_final_modules), pointer, nopass user_finalize_modules => null()
 Runs in the end of the simulation, after the last output. Mean as a place to run free() on user-allocated objects.
 
procedure(fluid_source_compute_pointwise), pointer, nopass fluid_user_f => null()
 User forcing for the fluid, pointwise interface.
 
procedure(fluid_source_compute_vector), pointer, nopass fluid_user_f_vector => null()
 User forcing for the fluid, field (vector) interface.
 
procedure(scalar_source_compute_pointwise), pointer, nopass scalar_user_f => null()
 User forcing for the scalar, pointwise interface.
 
procedure(scalar_source_compute_vector), pointer, nopass scalar_user_f_vector => null()
 User forcing for the scalar, field (vector) interface.
 
procedure(usr_inflow_eval), pointer, nopass fluid_user_if => null()
 User boundary condition for the fluid, pointwise interface.
 
procedure(usr_scalar_bc_eval), pointer, nopass scalar_user_bc => null()
 User boundary condition for the scalar, pointwise interface.
 
procedure(field_dirichlet_update), pointer, nopass user_dirichlet_update => null()
 User boundary condition for the fluid or the scalar, field interface (much more powerful than pointwise in terms of what can be done).
 
procedure(user_material_properties), pointer, nopass material_properties => null()
 Routine to set material properties.
 

Detailed Description

Definition at line 182 of file user_intf.f90.

Member Function/Subroutine Documentation

◆ init()

procedure, pass(this) user_intf::user_t::init ( class(user_t), intent(inout this)

Definition at line 242 of file user_intf.f90.

Here is the call graph for this function:

Member Data Documentation

◆ fluid_compressible_user_ic

procedure(useric_compressible), pointer, nopass user_intf::user_t::fluid_compressible_user_ic => null()
static

Definition at line 194 of file user_intf.f90.

◆ fluid_user_f

procedure(fluid_source_compute_pointwise), pointer, nopass user_intf::user_t::fluid_user_f => null()
static

Definition at line 212 of file user_intf.f90.

◆ fluid_user_f_vector

procedure(fluid_source_compute_vector), pointer, nopass user_intf::user_t::fluid_user_f_vector => null()
static

Definition at line 215 of file user_intf.f90.

◆ fluid_user_ic

procedure(useric), pointer, nopass user_intf::user_t::fluid_user_ic => null()
static

Definition at line 192 of file user_intf.f90.

◆ fluid_user_if

procedure(usr_inflow_eval), pointer, nopass user_intf::user_t::fluid_user_if => null()
static

Definition at line 224 of file user_intf.f90.

◆ init_user_simcomp

procedure(user_simcomp_init), pointer, nopass user_intf::user_t::init_user_simcomp => null()
static

Definition at line 200 of file user_intf.f90.

◆ material_properties

procedure(user_material_properties), pointer, nopass user_intf::user_t::material_properties => null()
static

Definition at line 232 of file user_intf.f90.

◆ scalar_user_bc

procedure(usr_scalar_bc_eval), pointer, nopass user_intf::user_t::scalar_user_bc => null()
static

Definition at line 226 of file user_intf.f90.

◆ scalar_user_f

procedure(scalar_source_compute_pointwise), pointer, nopass user_intf::user_t::scalar_user_f => null()
static

Definition at line 218 of file user_intf.f90.

◆ scalar_user_f_vector

procedure(scalar_source_compute_vector), pointer, nopass user_intf::user_t::scalar_user_f_vector => null()
static

Definition at line 221 of file user_intf.f90.

◆ scalar_user_ic

procedure(useric_scalar), pointer, nopass user_intf::user_t::scalar_user_ic => null()
static

Definition at line 197 of file user_intf.f90.

◆ user_check

procedure(usercheck), pointer, nopass user_intf::user_t::user_check => null()
static

Definition at line 206 of file user_intf.f90.

◆ user_dirichlet_update

procedure(field_dirichlet_update), pointer, nopass user_intf::user_t::user_dirichlet_update => null()
static

Definition at line 229 of file user_intf.f90.

◆ user_finalize_modules

procedure(user_final_modules), pointer, nopass user_intf::user_t::user_finalize_modules => null()
static

Definition at line 209 of file user_intf.f90.

◆ user_init_modules

procedure(user_initialize_modules), pointer, nopass user_intf::user_t::user_init_modules => null()
static

Definition at line 189 of file user_intf.f90.

◆ user_mesh_setup

procedure(usermsh), pointer, nopass user_intf::user_t::user_mesh_setup => null()
static

Definition at line 203 of file user_intf.f90.

◆ user_startup

procedure(user_startup_intrf), pointer, nopass user_intf::user_t::user_startup => null()
static

Definition at line 185 of file user_intf.f90.


The documentation for this type was generated from the following file: