Write a patch with halo onto the overlaps of all of its faces. More...

Inheritance diagram for api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces:

[legend]

Collaboration diagram for api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces:

[legend]

Public Member Functions
	__init__ (self, patch_with_halo, patch_overlap, guard="true", additional_includes="")

	get_constructor_body (self)
	Define a tailored constructor body.

	get_action_set_name (self)
	Return unique action set name.

	user_should_modify_template (self)
	Is the user allowed to modify the output.

	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_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	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.

Data Fields
	guard

	unknowns

	dofs_per_axis

	overlap

	patch_with_halo

	patch_overlap

	additional_includes

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

	parallel

Additional Inherited Members
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

Write a patch with halo onto the overlaps of all of its faces.

Counterpart of ReconstructPatchWithHalo: That action set gathers a cell's NxNxN patch and the 2MxNxN overlaps of its faces into one patch with halo of (N+2M)x(N+2M)x(N+2M) entries. This action set takes such a patch with halo and writes it back onto the face overlaps. Different to ProjectPatchOntoFaces, it writes both halves of each overlap: the half inside the cell from the patch, and the half outside of the cell from the halo. Afterwards, the overlaps hold exactly the data the patch with halo has been reconstructed from. The corners of the halo are not used.

The action set is used to restore the face data from a checkpoint (exahype2.api.blockstructured.LoadCheckpoint.LoadCheckpoint): Along the domain boundary, the outer half of each overlap holds the ghost data. A projection from the patch alone cannot restore it.

Faces between two cells receive their data from both cells. If the patches with halo are consistent, as they are in a checkpoint, both cells write the same values.

Definition at line 6 of file ProjectPatchWithHaloOntoFaces.py.

Constructor & Destructor Documentation

◆ init()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.__init__	(	self,
		patch_with_halo,
		patch_overlap,
		guard = `"true"`,
		additional_includes = `""`
	)

Parameters

patch_with_halo	peano4.api.datamodel.Patch Cell data of (N+2M)^d entries which is projected.
patch_overlap	peano4.api.datamodel.Patch Face data of 2M x N^(d-1) entries which is written.
guard	str C++ predicate. The action set only projects cells for which it holds.
additional_includes	str Further includes the generated code needs, e.g. for the guard.

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

Definition at line 31 of file ProjectPatchWithHaloOntoFaces.py.

References api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.__init__().

Referenced by api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

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

Definition at line 69 of file ProjectPatchWithHaloOntoFaces.py.

◆ get_attributes()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.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 133 of file ProjectPatchWithHaloOntoFaces.py.

◆ get_body_of_operation()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.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 75 of file ProjectPatchWithHaloOntoFaces.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.get_constructor_body ( self )

Define a tailored constructor body.

By default, the constructor of an action set is empty. If you you assign attributes to your action set, you however might want to initialise them here. We do not support initialisation lists, to all has to be done via setters unless you create attributes on the heap.

The constructor's signature will look similar to

   EnumerateAndInitSolution2petsc_actionsets_InitVertexDoFs0(int treeNumber);

where the treeNumber is -1 if this is the global instance of the action set owned by a rank, or a number greater or equal 0 if this action set is a clone of the glocal action set that's used by one tree traversal.

See also: get_attributes() to add attributes to your action set

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

Definition at line 66 of file ProjectPatchWithHaloOntoFaces.py.

◆ get_guard_of_operation()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.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 128 of file ProjectPatchWithHaloOntoFaces.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_includes()

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

Definition at line 136 of file ProjectPatchWithHaloOntoFaces.py.

Here is the call graph for this function:

◆ user_should_modify_template()

api.ProjectPatchWithHaloOntoFaces.ProjectPatchWithHaloOntoFaces.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 72 of file ProjectPatchWithHaloOntoFaces.py.