Neko  0.9.0
A portable framework for high-order spectral element flow simulations
simulation_component::simulation_component_t Type Reference

Base abstract class for simulation components. More...

Inheritance diagram for simulation_component::simulation_component_t:
Collaboration diagram for simulation_component::simulation_component_t:

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) preprocess => simulation_component_preprocess_wrapper
 Wrapper for calling preprocess_ based on the preprocess_controller. 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, pass(this) preprocess_
 The preprocessing function to be executed during the run. More...
 
procedure, pass(this) compute_
 The main function to be executed during the run. More...
 
procedure, pass(this) restart_
 The restart function to be called upon restarting simulation. More...
 

Public Attributes

type(case_t), pointer case
 Pointer to the simulation case. More...
 
type(time_based_controller_tpreprocess_controller
 Controller for when to run preprocess. More...
 
type(time_based_controller_tcompute_controller
 Controller for when to run compute. More...
 
type(time_based_controller_toutput_controller
 Controller for when to do output. More...
 
integer order
 The execution order, lowest excutes first. More...
 

Detailed Description

Definition at line 48 of file simulation_component.f90.

Member Function/Subroutine Documentation

◆ compute()

procedure, pass(this) simulation_component::simulation_component_t::compute

Definition at line 73 of file simulation_component.f90.

◆ compute_()

procedure, pass(this) simulation_component::simulation_component_t::compute_

Definition at line 81 of file simulation_component.f90.

◆ free()

procedure(simulation_component_free), deferred, pass simulation_component::simulation_component_t::free

Definition at line 77 of file simulation_component.f90.

◆ free_base()

procedure, pass(this) simulation_component::simulation_component_t::free_base

Definition at line 63 of file simulation_component.f90.

◆ init()

procedure(simulation_component_init), deferred, pass simulation_component::simulation_component_t::init

Definition at line 75 of file simulation_component.f90.

◆ init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base

Definition at line 61 of file simulation_component.f90.

◆ preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess

Definition at line 69 of file simulation_component.f90.

◆ preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_

Definition at line 79 of file simulation_component.f90.

◆ restart()

procedure, pass(this) simulation_component::simulation_component_t::restart

Definition at line 66 of file simulation_component.f90.

◆ restart_()

procedure, pass(this) simulation_component::simulation_component_t::restart_

Definition at line 83 of file simulation_component.f90.

Member Data Documentation

◆ case

type(case_t), pointer simulation_component::simulation_component_t::case

Definition at line 50 of file simulation_component.f90.

◆ compute_controller

type(time_based_controller_t) simulation_component::simulation_component_t::compute_controller

Definition at line 54 of file simulation_component.f90.

◆ order

integer simulation_component::simulation_component_t::order

Definition at line 58 of file simulation_component.f90.

◆ output_controller

type(time_based_controller_t) simulation_component::simulation_component_t::output_controller

Definition at line 56 of file simulation_component.f90.

◆ preprocess_controller

type(time_based_controller_t) simulation_component::simulation_component_t::preprocess_controller

Definition at line 52 of file simulation_component.f90.


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