Inheritance diagram for solvers.fv.actionsets.InitialCondition.InitialCondition:

[legend]

Collaboration diagram for solvers.fv.actionsets.InitialCondition.InitialCondition:

[legend]

Public Member Functions
	__init__ (self, solver, guard, grid_is_constructed, restart_from_checkpoint=False, loading_scheme="local-loading")
	solver: ADERDG Reference to creating class

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_body_of_prepareTraversal (self)

	get_action_set_name (self)
	You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

	get_includes (self)
	Return include statements that you need.

	get_static_initialisations (self, full_qualified_classname)

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_template_for_restarting (self)

	get_template_for_restart_preprocessing (self)

Public Member Functions inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	user_should_modify_template (self)
	Is the user allowed to modify the output.

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_constructor_body (self)
	Define a tailored constructor body.

	get_destructor_body (self)

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	get_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

	get_implementation_of_prepareTraversal (self)
	Return the C++ implementation of prepareTraversal()

	get_body_of_unprepareTraversal (self)

	get_implementation_of_unprepareTraversal (self)
	Return the C++ implementation of unprepareTraversal()

	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	get_implementation_of_operation (self, operation_name)
	Return the C++ implementation of an operation.

bool	may_run_in_background_task (self)
	May a task graph compiler move touchCellFirstTime() into a task.

Data Fields
	guard

	grid_is_constructed

Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order

	parallel

Static Public Attributes
str	TemplateInitialCondition

Static Public Attributes inherited from peano4.api.solversteps.ActionSet.ActionSet
int	descend_invocation_order = 0

bool	parallel = False

str	OPERATION_BEGIN_TRAVERSAL = "beginTraversal"

str	OPERATION_END_TRAVERSAL = "endTraversal"

str	OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"

str	OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"

str	OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"

str	OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"

str	OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"

str	OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"

str	OPERATION_CREATE_HANGING_FACE = "createHangingFace"

str	OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"

str	OPERATION_CREATE_CELL = "createCell"

str	OPERATION_DESTROY_CELL = "destroyCell"

str	OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"

str	OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"

str	OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"

str	OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"

str	OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"

str	OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"

Protected Attributes
	_restart_from_checkpoint

	_loading_scheme

Protected Attributes inherited from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	_solver

Detailed Description

Definition at line 9 of file InitialCondition.py.

Constructor & Destructor Documentation

◆ init()

solvers.fv.actionsets.InitialCondition.InitialCondition.__init__	(	self,
		solver,
		guard,
		grid_is_constructed,
		restart_from_checkpoint = `False`,
		loading_scheme = `"local-loading"`
	)

solver: ADERDG Reference to creating class

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 10 of file InitialCondition.py.

Member Function Documentation

◆ get_action_set_name()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_action_set_name ( self )

You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 49 of file InitialCondition.py.

◆ get_attributes()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_attributes ( self )

Return attributes as copied and pasted into the generated class.

Please note that action sets are not persistent, i.e. there is one object creation per grid sweep per tree.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 76 of file InitialCondition.py.

References solvers.fv.actionsets.InitialCondition.InitialCondition._loading_scheme, and solvers.fv.actionsets.InitialCondition.InitialCondition._restart_from_checkpoint.

◆ get_body_of_operation()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation	(	self,
		operation_name
	)

Return actual C++ code snippets to be inserted into C++ code.

See class' string constants starting with OPERATION_ for possible values of operation_name. The snippet is executed if and only if the guard returned by get_guard_of_operation() holds, i.e. the body should not evaluate the guard itself. See the section "Guard and body" in the class documentation.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 18 of file InitialCondition.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_body_of_prepareTraversal()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal ( self )

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 35 of file InitialCondition.py.

Referenced by peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_prepareTraversal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_includes()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_includes ( self )

Return include statements that you need.

All of these includes will eventually end up in the header of the generated C++ code.

Reimplemented from solvers.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 52 of file InitialCondition.py.

◆ get_static_initialisations()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_static_initialisations	(	self,
		full_qualified_classname
	)

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Definition at line 62 of file InitialCondition.py.

References solvers.fv.actionsets.InitialCondition.InitialCondition._loading_scheme, and solvers.fv.actionsets.InitialCondition.InitialCondition._restart_from_checkpoint.

◆ get_template_for_restart_preprocessing()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_template_for_restart_preprocessing ( self )

Definition at line 209 of file InitialCondition.py.

References solvers.fv.actionsets.InitialCondition.InitialCondition._loading_scheme.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal().

Here is the caller graph for this function:

◆ get_template_for_restarting()

solvers.fv.actionsets.InitialCondition.InitialCondition.get_template_for_restarting ( self )

Definition at line 114 of file InitialCondition.py.

References solvers.fv.actionsets.InitialCondition.InitialCondition._loading_scheme.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation().

Here is the caller graph for this function:

Field Documentation

◆ _loading_scheme

solvers.fv.actionsets.InitialCondition.InitialCondition._loading_scheme

protected

Definition at line 15 of file InitialCondition.py.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_attributes(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_static_initialisations(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_template_for_restart_preprocessing(), and solvers.fv.actionsets.InitialCondition.InitialCondition.get_template_for_restarting().

◆ _restart_from_checkpoint

solvers.fv.actionsets.InitialCondition.InitialCondition._restart_from_checkpoint

protected

Definition at line 14 of file InitialCondition.py.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_attributes(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal(), and solvers.fv.actionsets.InitialCondition.InitialCondition.get_static_initialisations().

◆ grid_is_constructed

solvers.fv.actionsets.InitialCondition.InitialCondition.grid_is_constructed

Definition at line 13 of file InitialCondition.py.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.rkdg.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), and solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_prepareTraversal().

◆ guard

solvers.fv.actionsets.InitialCondition.InitialCondition.guard

Definition at line 12 of file InitialCondition.py.

◆ TemplateInitialCondition

str solvers.fv.actionsets.InitialCondition.InitialCondition.TemplateInitialCondition

static

Initial value:

=  """
if ({{PREDICATE}}) {
  logTraceIn( "touchCellFirstTime(...)---InitialCondition" );
  parallelDfor( volume, {{NUMBER_OF_VOLUMES_PER_AXIS}} ) {
    int index = peano4::utils::dLinearised(volume,{{NUMBER_OF_VOLUMES_PER_AXIS}}) * ({{NUMBER_OF_UNKNOWNS}} + {{NUMBER_OF_AUXILIARY_VARIABLES}});
    repositories::{{SOLVER_INSTANCE}}.initialCondition(
      fineGridCell{{UNKNOWN_IDENTIFIER}}.value + index,
      ::exahype2::fv::getVolumeCentre( marker.x(), marker.h(), {{NUMBER_OF_VOLUMES_PER_AXIS}}, volume),
      ::exahype2::fv::getVolumeSize( marker.h(), {{NUMBER_OF_VOLUMES_PER_AXIS}} ),
      {{GRID_IS_CONSTRUCTED}}
    );
  } endParallelDfor
  
  // relevant for tracing et al which kicks in if and only if cell has been
  // updated
  fineGridCell{{SOLVER_NAME}}CellLabel.setHasUpdated(true);
 
  logTraceOut( "touchCellFirstTime(...)---InitialCondition" );
}
"""

Definition at line 93 of file InitialCondition.py.

Referenced by solvers.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), solvers.rkdg.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), exahype2.api.fv.actionsets.InitialCondition.InitialCondition.get_body_of_operation(), and exahype2.api.rkfd4.actionsets.InitialCondition.InitialCondition.get_body_of_operation().

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

python/exahype2/solvers/fv/actionsets/InitialCondition.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_includes()

◆ get_static_initialisations()

◆ get_template_for_restart_preprocessing()

◆ get_template_for_restarting()

Field Documentation

◆ _loading_scheme

◆ _restart_from_checkpoint

◆ grid_is_constructed

◆ guard

◆ TemplateInitialCondition

◆ init()