Copy patch_overlap_update - the face overlap exahype2.api.rkfd4.actionsets.ProjectPatchOntoFaces has just written the latest projection into - onto patch_overlap_current_time_step, the persistent face data toolbox.blockstructured.api.ReconstructPatchWithHalo reads from to rebuild a patch's halo. More...

Inheritance diagram for exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace:

[legend]

Collaboration diagram for exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace:

[legend]

Public Member Functions
	__init__ (self, patch_overlap_current_time_step, patch_overlap_update, guard, includes)

	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)
	Return unique action set name.

	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
	additional_includes

	d

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

	parallel

Static Public Attributes
	TemplateHandleFace

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"

Detailed Description

Copy patch_overlap_update - the face overlap exahype2.api.rkfd4.actionsets.ProjectPatchOntoFaces has just written the latest projection into - onto patch_overlap_current_time_step, the persistent face data toolbox.blockstructured.api.ReconstructPatchWithHalo reads from to rebuild a patch's halo.

Both halves of the face overlap (left and right, relative to the face's normal) are copied in full, unconditionally subject only to guard.

The class is a copy of exahype2.api.fv.actionsets.RollOverUpdatedFace, as rkfd4 does not depend on the Finite Volume package. On the C++ side, it still uses exahype2::fv::copyHalfOfHalo(), as the copy does not depend on the discretisation and there is no Finite Differences counterpart.

Definition at line 9 of file RollOverUpdatedFace.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.__init__	(	self,
		patch_overlap_current_time_step,
		patch_overlap_update,
		guard,
		includes
	)

Parameters

patch_overlap_current_time_step	peano4.api.datamodel.Patch The persistent face overlap to roll patch_overlap_update into, i.e. solver._patch_overlap_current_time_step.
patch_overlap_update	peano4.api.datamodel.Patch The face overlap exahype2.api.rkfd4.actionsets.ProjectPatchOntoFaces has just written the latest projection into, i.e. solver._patch_overlap_update. Its dim[1] is assumed to equal the cell patch's grid cells per axis, i.e. patch_overlap_update and patch_overlap_current_time_step have to be face-associated overlaps of a cell patch in the sense of exahype2.api.rkfd4.actionsets.ProjectPatchOntoFaces.
guard	str C++ boolean expression, evaluated per face in touchFaceLastTime, guarding whether that face's overlap is rolled over.
includes	str Additional includes this action set's generated code needs - callers typically pass solver._get_default_includes() + solver.user_solver_includes.

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

Reimplemented in exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.

Definition at line 57 of file RollOverUpdatedFace.py.

References exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.__init__().

Referenced by exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.get_action_set_name ( self )

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

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

Reimplemented in exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.

Definition at line 114 of file RollOverUpdatedFace.py.

◆ get_body_of_operation()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.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.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.

Definition at line 97 of file RollOverUpdatedFace.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.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.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.

Definition at line 106 of file RollOverUpdatedFace.py.

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

Here is the caller graph for this function:

◆ get_includes()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.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 peano4.api.solversteps.ActionSet.ActionSet.

Reimplemented in exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.

Definition at line 120 of file RollOverUpdatedFace.py.

Here is the call graph for this function:

◆ user_should_modify_template()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.user_should_modify_template ( self )

Is the user allowed to modify the output.

Return whether you expect the user to modify the generated code. If this is the case, then the API places the generated output in the directory actions. Otherwise, it goes into the observer directory and will be overwritten in each and every Python run.

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

Definition at line 117 of file RollOverUpdatedFace.py.

Field Documentation

◆ additional_includes

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.additional_includes

Definition at line 86 of file RollOverUpdatedFace.py.

◆ d

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.d

Definition at line 87 of file RollOverUpdatedFace.py.

◆ TemplateHandleFace

exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.TemplateHandleFace

static

Initial value:

=  jinja2.Template(
        
    )

Definition at line 28 of file RollOverUpdatedFace.py.

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

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

src/exahype2/api/rkfd4/actionsets/RollOverUpdatedFace.py

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_guard_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ additional_includes

◆ d

◆ TemplateHandleFace

◆ init()