A type collecting all the overridable user routines and flag to suppress type injection from custom modules.
More...
|
| procedure, pass(this) | init (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.
|
| |
|
| logical | suppress_type_injection = .false. |
| | Setting this to true in the user_setup routine in the user file will suppress custom modules registering their types in the factories. So you have to take care of type injection in user_startup. Use if you really want full control over type injection for some reason.
|
| |
|
| procedure(user_startup_intf), pointer, nopass | 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_intf), pointer, nopass | initialize => null() |
| | Run after the entire case is initialized and restarted, but before the time loop. Good place to create auxillary fields, etc.
|
| |
| procedure(user_initial_conditions_intf), pointer, nopass | initial_conditions => null() |
| | Compute user initial conditions.
|
| |
| procedure(user_mesh_setup_intf), pointer, nopass | mesh_setup => null() |
| |
| procedure(user_compute_intf), pointer, nopass | preprocess => null() |
| | Run at the start of each time-step in the time loop.
|
| |
| procedure(user_compute_intf), pointer, nopass | compute => null() |
| | Run at the end of each time-step in the time loop, right before field output to disk.
|
| |
| procedure(user_finalize_intf), pointer, nopass | finalize => null() |
| | Runs in the end of the simulation, after the last output. Mean as a place to run free() on user-allocated objects.
|
| |
| procedure(user_source_term_intf), pointer, nopass | source_term => null() |
| | User source term interface.
|
| |
| procedure(field_dirichlet_update), pointer, nopass | dirichlet_conditions => 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_intf), pointer, nopass | material_properties => null() |
| | Routine to set material properties.
|
| |
Definition at line 142 of file user_intf.f90.
◆ init()
◆ compute
◆ dirichlet_conditions
◆ finalize
◆ initial_conditions
◆ initialize
◆ material_properties
◆ mesh_setup
◆ preprocess
◆ source_term
◆ startup
◆ suppress_type_injection
| logical user_intf::user_t::suppress_type_injection = .false. |
The documentation for this type was generated from the following file:
