Initialise the overlap data on hanging faces from the coarser mesh. More...

Inheritance diagram for api.InterpolateHangingFaces.InterpolateHangingFaces:

[legend]

Collaboration diagram for api.InterpolateHangingFaces.InterpolateHangingFaces:

[legend]

Data Structures
class	Scheme
	Interpolation schemes. More...

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

	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

	additional_includes

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

	parallel

Static Public Attributes
	TemplateCreateHangingFace

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

Initialise the overlap data on hanging faces from the coarser mesh.

A hanging face is a face of a fine cell which sits on the face of a coarser, unrefined cell. Peano does not store hanging faces. It creates them whenever a mesh sweep enters an adjacent fine cell and destroys them once the sweep leaves this cell again. The action set plugs into createHangingFace(): It takes the overlap data of the coarse face which the hanging face is part of and interpolates them onto the hanging face (toolbox::blockstructured::interpolateHaloLayer_AoS_...). Afterwards, the half of the hanging face which belongs to the coarse cell holds interpolated coarse data, so the fine cell can reconstruct its halo as if its neighbour were a fine cell, too.

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

Definition at line 10 of file InterpolateHangingFaces.py.

Constructor & Destructor Documentation

◆ init()

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

Parameters

patch_overlap	peano4.api.datamodel.Patch The face data which the action set interpolates. The data of the coarse face are read, the data of the hanging face are written.
scheme	InterpolateHangingFaces.Scheme Interpolation scheme. Defaults to Scheme.Linear.
guard	str C++ boolean expression over the hanging face's peano4::datamanagement::FaceMarker marker.
additional_includes	str Further include statements, e.g. required by the guard.

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

Definition at line 68 of file InterpolateHangingFaces.py.

References api.InterpolateHangingFaces.InterpolateHangingFaces.__init__().

Referenced by api.InterpolateHangingFaces.InterpolateHangingFaces.__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.InterpolateHangingFaces.InterpolateHangingFaces.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 136 of file InterpolateHangingFaces.py.

◆ get_attributes()

api.InterpolateHangingFaces.InterpolateHangingFaces.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 142 of file InterpolateHangingFaces.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

api.InterpolateHangingFaces.InterpolateHangingFaces.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 117 of file InterpolateHangingFaces.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.InterpolateHangingFaces.InterpolateHangingFaces.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 126 of file InterpolateHangingFaces.py.

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

Here is the caller graph for this function:

◆ get_body_of_prepareTraversal()

api.InterpolateHangingFaces.InterpolateHangingFaces.get_body_of_prepareTraversal ( self )

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

Definition at line 120 of file InterpolateHangingFaces.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.InterpolateHangingFaces.InterpolateHangingFaces.get_body_of_unprepareTraversal ( self )

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

Definition at line 123 of file InterpolateHangingFaces.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

api.InterpolateHangingFaces.InterpolateHangingFaces.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 111 of file InterpolateHangingFaces.py.

◆ get_destructor_body()

api.InterpolateHangingFaces.InterpolateHangingFaces.get_destructor_body ( self )

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

Definition at line 114 of file InterpolateHangingFaces.py.

◆ get_guard_of_operation()

api.InterpolateHangingFaces.InterpolateHangingFaces.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 131 of file InterpolateHangingFaces.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.InterpolateHangingFaces.InterpolateHangingFaces.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 145 of file InterpolateHangingFaces.py.

Here is the call graph for this function:

◆ user_should_modify_template()

api.InterpolateHangingFaces.InterpolateHangingFaces.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 139 of file InterpolateHangingFaces.py.