Fill a Finite Volume patch's initial condition, one volume at a time, by calling the solver's exahype2.api.InitPointWisely PDE term once per volume with that volume's centre. More...

Inheritance diagram for exahype2.api.fv.actionsets.InitialCondition.InitialCondition:

[legend]

Collaboration diagram for exahype2.api.fv.actionsets.InitialCondition.InitialCondition:

[legend]

Public Member Functions
	__init__ (self, solver, guard)
	solver: exahype2.api.Solver Has to have an InitPointWisely PDE term registered -

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

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

	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,...).

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

	get_includes (self)
	Return include statements that you need.

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

	get_static_initialisations (self, full_qualified_classname)

	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_body_of_prepareTraversal (self)

	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_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.

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

Data Fields
	guard

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"

Additional Inherited Members
Protected Attributes inherited from exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	_solver

Detailed Description

Fill a Finite Volume patch's initial condition, one volume at a time, by calling the solver's exahype2.api.InitPointWisely PDE term once per volume with that volume's centre.

Ported from the legacy, cell-wise python/exahype2/solvers/fv/actionsets/InitialCondition.py, which is handed a whole mesh cell's centre and extent, gridIsConstructed, and fills the whole patch itself via the legacy initialCondition() PDE term. This variant instead loops over the patch's volumes itself and calls InitPointWisely's initPointWisely() once per volume, exactly like Flux and MaxEigenvalue are evaluated once per degree of freedom -

See also: exahype2.api.InitPointWisely.

Checkpoint-restart support (restart_from_checkpoint/loading_scheme in the legacy version) has deliberately not been ported: it relies on Solver attributes (CheckpointTimeStamp, CheckpointFilesOf...) that do not exist in the new exahype2.api yet.

Definition at line 9 of file InitialCondition.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.fv.actionsets.InitialCondition.InitialCondition.__init__	(	self,
		solver,
		guard
	)

solver: exahype2.api.Solver Has to have an InitPointWisely PDE term registered -

See also: exahype2.api.fv.SetupSimulationOverRegularGrid, which asserts this before it attaches an instance of this action set.

guard: str C++ boolean expression, evaluated per cell, guarding whether the initial condition is (re)written for that cell.

Unlike the legacy, cell-wise version, this action set takes no grid_is_constructed argument: InitPointWisely fills in a degree of freedom from its coordinate alone, so - unlike the legacy cell-wise initialCondition(), which had to know whether it was still filling in default values during AMR mesh construction or the real initial condition once the grid was done - it produces a well-defined value regardless of how far mesh construction has progressed.

Reimplemented from exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Reimplemented in exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.

Definition at line 32 of file InitialCondition.py.

Member Function Documentation

◆ get_action_set_name()

exahype2.api.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 exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Reimplemented in exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.

Definition at line 77 of file InitialCondition.py.

◆ get_body_of_operation()

exahype2.api.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.

Reimplemented in exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.

Definition at line 57 of file InitialCondition.py.

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

Here is the caller graph for this function:

◆ get_guard_of_operation()

exahype2.api.fv.actionsets.InitialCondition.InitialCondition.get_guard_of_operation	(	self,
		operation_name
	)

Return the guard of an operation.

The guard is a C++ boolean expression. The body of the operation (see get_body_of_operation()) is executed if and only if the guard holds. The guard can use the same arguments as the body, i.e. the marker and the fine and coarse grid data. By default, the guard is true, i.e. the body is always executed.

See class' string constants starting with OPERATION_ for possible values of operation_name.

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

Reimplemented in exahype2.api.fv.actionsets.InitialiseNewCells.InitialiseNewCells.

Definition at line 72 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:

Field Documentation

◆ guard

exahype2.api.fv.actionsets.InitialCondition.InitialCondition.guard

Definition at line 55 of file InitialCondition.py.

◆ TemplateInitialCondition

str exahype2.api.fv.actionsets.InitialCondition.InitialCondition.TemplateInitialCondition

static

Initial value:

=  """
  logTraceIn( "touchCellFirstTime(...)---InitialCondition" );
  // @todo Tim does it make sense to retire these loops and replace them with your compiler?
  //           It is only a minor thing, but maybe we can get rid of all of these dfor macros?
  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}}.initPointWisely(
  ::exahype2::fv::getVolumeCentre( marker.x(), marker.h(), {{NUMBER_OF_VOLUMES_PER_AXIS}}, volume),
  fineGridCell{{UNKNOWN_IDENTIFIER}}.value + index
);
  } endParallelDfor
 
  logTraceOut( "touchCellFirstTime(...)---InitialCondition" );
"""

Definition at line 80 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:

src/exahype2/api/fv/actionsets/InitialCondition.py

Public Member Functions

Data Fields

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_guard_of_operation()

Field Documentation

◆ guard

◆ TemplateInitialCondition

◆ init()