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, time)
	Wrapper for calling preprocess_ based on the preprocess_controller. Serves as the public interface.
subroutine	simulation_component_compute_wrapper (this, time)
	Wrapper for calling compute_ based on the compute_controller. Serves as the public interface.
subroutine	simulation_component_restart_wrapper (this, time)
	Wrapper for calling set_counter_ based for the controllers.
subroutine	restart_ (this, time)
	Dummy restart function.
subroutine	preprocess_ (this, time)
	Dummy preprocessing function.
subroutine	compute_ (this, time)
	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, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 257 of file simulation_component.f90.

preprocess_()

subroutine simulation_component::preprocess_ ( class(simulation_component_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 248 of file simulation_component.f90.

restart_()

subroutine simulation_component::restart_ ( class(simulation_component_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 239 of file simulation_component.f90.

simulation_component_compute_wrapper()

subroutine simulation_component::simulation_component_compute_wrapper ( class(simulation_component_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 215 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 193 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. Simulation component allocator.
object	The object to be allocated.
type_name	The name of the simcomp type. Constructor for the simulation_component_t (base) class.

Definition at line 140 of file simulation_component.f90.

simulation_component_preprocess_wrapper()

subroutine simulation_component::simulation_component_preprocess_wrapper ( class(simulation_component_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 202 of file simulation_component.f90.

simulation_component_restart_wrapper()

subroutine simulation_component::simulation_component_restart_wrapper ( class(simulation_component_t), intent(inout)  this, type(time_state_t), intent(in)  time  )

private

Parameters

time	The current time.

Definition at line 227 of file simulation_component.f90.