Restrict the overlap data of hanging faces onto the coarser mesh. More...

Inheritance diagram for api.RestrictHangingFaces.RestrictHangingFaces:

[legend]

Collaboration diagram for api.RestrictHangingFaces.RestrictHangingFaces:

[legend]

Data Structures
class	Scheme
	Restriction schemes. More...

Public Member Functions
	__init__ (self, patch_overlap, "RestrictHangingFaces.Scheme" scheme=None, str guard="true", str clear_guard="true", str additional_includes="")

bool	clears_faces (self)
	Does the scheme accumulate, i.e.

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

	get_body_of_unprepareTraversal (self)

	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_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_implementation_of_createGridControlEventsForNextTraversal (self)
	Return the C++ implementation of createGridControlEventsForNextTraversal()

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

	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
	scheme

	d

	guard

	clear_guard

	additional_includes

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

	parallel

Static Public Attributes
	TemplateTouchFaceFirstTime

	TemplateDestroyHangingFace

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

Restrict the overlap data of hanging faces onto the coarser mesh.

A hanging face is a face of a fine cell which sits on the face of a coarser, unrefined cell (toolbox.blockstructured.api.InterpolateHangingFaces). The action set plugs into destroyHangingFace(): It takes the half of the hanging face which belongs to the fine cell and restricts it onto the corresponding half of the coarse face (toolbox::blockstructured::restrictInnerHalfOfHaloLayer_AoS_...). Peano destroys a hanging face after touchCellLastTime() of its fine cell, i.e. after the fine cell has projected its data onto its faces. Peano touches the coarse face for the last time after all of these hanging faces have been destroyed. Afterwards, the coarse face holds the data of the coarse cell on one side and the restricted fine data on the other side.

The face overlap has to be a 2MxNxN patch: M is the overlap, N the number of volumes per patch axis.

Averaging and clearing

Averaging accumulates the fine grid values within the coarse face. The action set therefore clears the face data in touchFaceFirstTime() for each face which passes the clear guard. This clears both halves of the face. Use the action set only in a mesh sweep where all face data which are cleared are written again afterwards, e.g. by a projection onto the faces. Injection overwrites the coarse values and hence does not clear anything.

Definition at line 10 of file RestrictHangingFaces.py.

Constructor & Destructor Documentation

◆ init()

api.RestrictHangingFaces.RestrictHangingFaces.__init__	(		self,
			patch_overlap,
		"RestrictHangingFaces.Scheme"	scheme = `None`,
		str	guard = `"true"`,
		str	clear_guard = `"true"`,
		str	additional_includes = `""`
	)

Parameters

patch_overlap	peano4.api.datamodel.Patch The face data which the action set restricts. The data of the hanging face are read, the data of the coarse face are written.
scheme	RestrictHangingFaces.Scheme Restriction scheme. Defaults to Scheme.Averaging. Injection supports an overlap of one only.
guard	str C++ boolean expression over the hanging face's peano4::datamanagement::FaceMarker marker.
clear_guard	str C++ boolean expression over a persistent face's peano4::datamanagement::FaceMarker marker. Only used for averaging: The action set clears the face's data in touchFaceFirstTime() if the expression holds.
additional_includes	str Further include statements, e.g. required by the guards.

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

Definition at line 91 of file RestrictHangingFaces.py.

References api.RestrictHangingFaces.RestrictHangingFaces.__init__().

Referenced by api.RestrictHangingFaces.RestrictHangingFaces.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ clears_faces()

bool api.RestrictHangingFaces.RestrictHangingFaces.clears_faces ( self )

Does the scheme accumulate, i.e.

does it have to clear the faces first?

Definition at line 152 of file RestrictHangingFaces.py.

References api.InterpolateHangingFaces.InterpolateHangingFaces.scheme, and api.RestrictHangingFaces.RestrictHangingFaces.scheme.

Referenced by api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_operation().

Here is the caller graph for this function:

◆ get_action_set_name()

api.RestrictHangingFaces.RestrictHangingFaces.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 188 of file RestrictHangingFaces.py.

◆ get_attributes()

api.RestrictHangingFaces.RestrictHangingFaces.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 194 of file RestrictHangingFaces.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_createGridControlEventsForNextTraversal ( self )

Return the grid control events that this action set wants to trigger.

Please consult the documentation of grid control events for details on what these events are and how they are used.

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

Definition at line 162 of file RestrictHangingFaces.py.

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

Here is the caller graph for this function:

◆ get_body_of_operation()

api.RestrictHangingFaces.RestrictHangingFaces.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 171 of file RestrictHangingFaces.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()

api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_prepareTraversal ( self )

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

Definition at line 165 of file RestrictHangingFaces.py.

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

Here is the caller graph for this function:

◆ get_body_of_unprepareTraversal()

api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_unprepareTraversal ( self )

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

Definition at line 168 of file RestrictHangingFaces.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

api.RestrictHangingFaces.RestrictHangingFaces.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 156 of file RestrictHangingFaces.py.

◆ get_destructor_body()

api.RestrictHangingFaces.RestrictHangingFaces.get_destructor_body ( self )

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

Definition at line 159 of file RestrictHangingFaces.py.

◆ get_guard_of_operation()

api.RestrictHangingFaces.RestrictHangingFaces.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 181 of file RestrictHangingFaces.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.RestrictHangingFaces.RestrictHangingFaces.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 197 of file RestrictHangingFaces.py.

Here is the call graph for this function:

◆ user_should_modify_template()

api.RestrictHangingFaces.RestrictHangingFaces.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 191 of file RestrictHangingFaces.py.

Field Documentation

◆ additional_includes

api.RestrictHangingFaces.RestrictHangingFaces.additional_includes

Definition at line 149 of file RestrictHangingFaces.py.

◆ clear_guard

api.RestrictHangingFaces.RestrictHangingFaces.clear_guard

Definition at line 148 of file RestrictHangingFaces.py.

Referenced by api.RestrictHangingFaces.RestrictHangingFaces.get_guard_of_operation().

◆ d

api.RestrictHangingFaces.RestrictHangingFaces.d

Definition at line 140 of file RestrictHangingFaces.py.

◆ guard

api.RestrictHangingFaces.RestrictHangingFaces.guard

Definition at line 147 of file RestrictHangingFaces.py.

◆ scheme

api.RestrictHangingFaces.RestrictHangingFaces.scheme

Definition at line 128 of file RestrictHangingFaces.py.

Referenced by api.RestrictHangingFaces.RestrictHangingFaces.clears_faces().

◆ TemplateDestroyHangingFace

api.RestrictHangingFaces.RestrictHangingFaces.TemplateDestroyHangingFace

static

Initial value:

=  jinja2.Template(
        
    )

Definition at line 76 of file RestrictHangingFaces.py.

Referenced by api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_operation().

◆ TemplateTouchFaceFirstTime

api.RestrictHangingFaces.RestrictHangingFaces.TemplateTouchFaceFirstTime

static

Definition at line 62 of file RestrictHangingFaces.py.

Referenced by exahype2.api.fv.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_body_of_operation(), exahype2.api.rkfd4.actionsets.ApplyDirichletBoundaryConditions.ApplyDirichletBoundaryConditions.get_body_of_operation(), api.actionsets.ImposeDirichletBoundaryConditionsWithInteriorPenaltyMethod.ImposeDirichletBoundaryConditionsWithInteriorPenaltyMethod.get_body_of_operation(), api.solvers.DiscontinuousGalerkinDiscretisation.AssemblePetscMatrix.get_body_of_operation(), and api.RestrictHangingFaces.RestrictHangingFaces.get_body_of_operation().

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

src/toolbox/blockstructured/api/RestrictHangingFaces.py

Data Structures

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Averaging and clearing

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ clears_faces()

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_body_of_unprepareTraversal()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_guard_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ additional_includes

◆ clear_guard

◆ d

◆ guard

◆ scheme

◆ TemplateDestroyHangingFace

◆ TemplateTouchFaceFirstTime

◆ init()