Base abstract class for simulation components. More...
Public Member Functions | |
| procedure, pass(this) | init_base => simulation_component_init_base |
| Constructor for the simulation_component_t (base) class. More... | |
| procedure, pass(this) | free_base => simulation_component_free_base |
| Destructor for the simulation_component_t (base) class. More... | |
| procedure, pass(this) | restart => simulation_component_restart_wrapper |
Wrapper for calling set_counter for the time based controllers. Serves as the public interface. More... | |
| procedure, pass(this) | compute => simulation_component_compute_wrapper |
Wrapper for calling compute_ based on the compute_controller. Serves as the public interface. More... | |
| procedure(simulation_component_init), deferred, pass | init |
| The common constructor using a JSON dictionary. More... | |
| procedure(simulation_component_free), deferred, pass | free |
| Destructor. More... | |
| procedure(simulation_component_compute), deferred, pass | compute_ |
| The main function to be executed during the run. More... | |
Public Attributes | |
| type(case_t), pointer | case |
| Pointer to the simulation case. More... | |
| type(time_based_controller_t) | compute_controller |
Controller for when to run compute. More... | |
| type(time_based_controller_t) | output_controller |
| Controller for when to do output. More... | |
| integer | order |
| The execution order, lowest excutes first. More... | |
Detailed Description
Base abstract class for simulation components.
Definition at line 48 of file simulation_component.f90.
Member Function/Subroutine Documentation
◆ compute()
| procedure, pass(this) simulation_component::simulation_component_t::compute |
Wrapper for calling compute_ based on the compute_controller. Serves as the public interface.
Definition at line 67 of file simulation_component.f90.
◆ compute_()
| procedure(simulation_component_compute), deferred, pass simulation_component::simulation_component_t::compute_ |
The main function to be executed during the run.
Definition at line 73 of file simulation_component.f90.
◆ free()
| procedure(simulation_component_free), deferred, pass simulation_component::simulation_component_t::free |
Destructor.
Definition at line 71 of file simulation_component.f90.
◆ free_base()
| procedure, pass(this) simulation_component::simulation_component_t::free_base |
Destructor for the simulation_component_t (base) class.
Definition at line 61 of file simulation_component.f90.
◆ init()
| procedure(simulation_component_init), deferred, pass simulation_component::simulation_component_t::init |
The common constructor using a JSON dictionary.
Definition at line 69 of file simulation_component.f90.
◆ init_base()
| procedure, pass(this) simulation_component::simulation_component_t::init_base |
Constructor for the simulation_component_t (base) class.
Definition at line 59 of file simulation_component.f90.
◆ restart()
| procedure, pass(this) simulation_component::simulation_component_t::restart |
Wrapper for calling set_counter for the time based controllers. Serves as the public interface.
Definition at line 64 of file simulation_component.f90.
Member Data Documentation
◆ case
| type(case_t), pointer simulation_component::simulation_component_t::case |
Pointer to the simulation case.
Definition at line 50 of file simulation_component.f90.
◆ compute_controller
| type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller |
Controller for when to run compute.
Definition at line 52 of file simulation_component.f90.
◆ order
| integer simulation_component::simulation_component_t::order |
The execution order, lowest excutes first.
Definition at line 56 of file simulation_component.f90.
◆ output_controller
| type(time_based_controller_t) simulation_component::simulation_component_t::output_controller |
Controller for when to do output.
Definition at line 54 of file simulation_component.f90.
The documentation for this type was generated from the following file:
- /home/runner/work/neko/neko/src/simulation_components/simulation_component.f90
