simulation_component Module Reference

Simulation components are objects that encapsulate functionality that can be fit to a particular compute pattern. More...

Data Types
interface	simulation_component_free
	Destructor. More...
interface	simulation_component_init
	The common constructor using a JSON dictionary. More...
type	simulation_component_t
	Base abstract class for simulation components. More...
type	simulation_component_wrapper_t
	A helper type that is needed to have an array of polymorphic objects. More...

Functions/Subroutines
subroutine	simulation_component_init_base (this, json, case)
	Simulation component factory. Both constructs and initializes the object.
subroutine	simulation_component_free_base (this)
	Destructor for the simulation_component_t (base) class.
subroutine	simulation_component_preprocess_wrapper (this, t, tstep)
	Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface.
subroutine	simulation_component_compute_wrapper (this, t, tstep)
	Wrapper for calling compute_ based on the compute_controller. Serves as the public interface.
subroutine	simulation_component_restart_wrapper (this, t)
	Wrapper for calling set_counter_ based for the controllers. Serves as the public interface.
subroutine	restart_ (this, t)
	Dummy restart function.
subroutine	preprocess_ (this, t, tstep)
	Dummy preprocessing function.
subroutine	compute_ (this, t, tstep)
	Dummy compute function.

Detailed Description

Note

The canonical way to abbreviate simulation_component is simcomp.

Function/Subroutine Documentation

compute_()

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

private

Parameters

t	The time value.
tstep	The current time-step

Definition at line 254 of file simulation_component.f90.

preprocess_()

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

private

Parameters

t	The time value.
tstep	The current time-step

Definition at line 243 of file simulation_component.f90.

restart_()

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

private

Parameters

t	The time value.

Definition at line 233 of file simulation_component.f90.

simulation_component_compute_wrapper()

subroutine simulation_component::simulation_component_compute_wrapper ( class(simulation_component_t), intent(inout)  this, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

private

Parameters

t	The time value.
tstep	The current time-step

Definition at line 207 of file simulation_component.f90.

simulation_component_free_base()

subroutine simulation_component::simulation_component_free_base ( class(simulation_component_t), intent(inout)  this )

private

Definition at line 182 of file simulation_component.f90.

simulation_component_init_base()

subroutine simulation_component::simulation_component_init_base ( class(simulation_component_t), intent(inout)  this, type(json_file), intent(inout)  json, class(case_t), intent(inout), target  case  )

private

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 129 of file simulation_component.f90.

simulation_component_preprocess_wrapper()

subroutine simulation_component::simulation_component_preprocess_wrapper ( class(simulation_component_t), intent(inout)  this, real(kind=rp), intent(in)  t, integer, intent(in)  tstep  )

private

Parameters

t	The time value.
tstep	The current time-step

Definition at line 192 of file simulation_component.f90.

simulation_component_restart_wrapper()

subroutine simulation_component::simulation_component_restart_wrapper ( class(simulation_component_t), intent(inout)  this, real(kind=rp), intent(in)  t  )

private

Parameters

t	The time value.

Definition at line 221 of file simulation_component.f90.