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 (this, json, case)
	Constructor for the simulation_component_t (base) class.
procedure, pass(this)	free_base (this)
	Destructor for the simulation_component_t (base) class.
procedure, pass(this)	restart (this, t)
	Wrapper for calling set_counter for the time based controllers. Serves as the public interface.
procedure, pass(this)	preprocess (this, t, tstep)
	Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface.
procedure, pass(this)	compute (this, t, tstep)
	Wrapper for calling compute_ based on the compute_controller. Serves as the public interface.
procedure(simulation_component_init), deferred, pass	init (this, json, case)
	The common constructor using a JSON dictionary.
procedure(simulation_component_free), deferred, pass	free (this)
	Destructor.
procedure, pass(this)	preprocess_ (this, t, tstep)
	The preprocessing function to be executed during the run.
procedure, pass(this)	compute_ (this, t, tstep)
	The main function to be executed during the run.
procedure, pass(this)	restart_ (this, t)
	The restart function to be called upon restarting simulation.

Public Attributes
type(case_t), pointer	case
	Pointer to the simulation case.
type(time_based_controller_t)	preprocess_controller
	Controller for when to run preprocess.
type(time_based_controller_t)	compute_controller
	Controller for when to run compute.
type(time_based_controller_t)	output_controller
	Controller for when to do output.
integer	order
	The execution order, lowest excutes first.

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	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 73 of file simulation_component.f90.

compute_()

procedure, pass(this) simulation_component::simulation_component_t::compute_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 81 of file simulation_component.f90.

free()

procedure(simulation_component_free), deferred, pass simulation_component::simulation_component_t::free ( class(simulation_component_t), intent(inout)  this )

pure virtual

Definition at line 77 of file simulation_component.f90.

free_base()

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

(

class(simulation_component_t), intent(inout)

this

)

Definition at line 63 of file simulation_component.f90.

init()

procedure(simulation_component_init), deferred, pass simulation_component::simulation_component_t::init ( class(simulation_component_t), intent(inout)  this, type(json_file), intent(inout)  json, class(case_t), intent(inout), target  case  )

pure virtual

Definition at line 75 of file simulation_component.f90.

init_base()

procedure, pass(this) simulation_component::simulation_component_t::init_base	(	class(simulation_component_t), intent(inout)	this,
		type(json_file), intent(inout)	json,
		class(case_t), intent(inout), target	case
	)

Parameters

object	The object to be created and initialized.
json	JSON object initializing the simulation component.
case	The simulation case. Constructor for the simulation_component_t (base) class.

Definition at line 61 of file simulation_component.f90.

preprocess()

procedure, pass(this) simulation_component::simulation_component_t::preprocess	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 69 of file simulation_component.f90.

preprocess_()

procedure, pass(this) simulation_component::simulation_component_t::preprocess_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t,
		integer, intent(in)	tstep
	)

Parameters

t	The time value.
tstep	The current time-step

Definition at line 79 of file simulation_component.f90.

restart()

procedure, pass(this) simulation_component::simulation_component_t::restart	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t
	)

Parameters

t	The time value.

Definition at line 66 of file simulation_component.f90.

restart_()

procedure, pass(this) simulation_component::simulation_component_t::restart_	(	class(simulation_component_t), intent(inout)	this,
		real(kind=rp), intent(in)	t
	)

Parameters

t	The time value.

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:

• /home/runner/work/neko/neko/src/simulation_components/simulation_component.f90