Initialise the patches of new cells from their parent, and hand the patches of erased cells over to their parent. More...

Inheritance diagram for api.InterpolateAndRestrictCells.InterpolateAndRestrictCells:

[legend]

Collaboration diagram for api.InterpolateAndRestrictCells.InterpolateAndRestrictCells:

[legend]

Data Structures
class	Interpolation
	Interpolation schemes. More...

class	Restriction
	Restriction schemes. More...

Public Member Functions
	__init__ (self, patch, "InterpolateAndRestrictCells.Interpolation" interpolation=None, "InterpolateAndRestrictCells.Restriction" restriction=None, 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_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_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	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
	interpolation

	restriction

	d

	additional_includes

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

	parallel

Static Public Attributes
	TemplateCreateCell

	TemplateTouchCellFirstTime

	TemplateDestroyCell

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 patches of new cells from their parent, and hand the patches of erased cells over to their parent.

The action set realises the data transfer of a dynamically adaptive mesh for patches which live on the finest mesh level only:

If a mesh sweep refines a cell, Peano creates its 3^d children. createCell() interpolates the parent's patch into each child's patch (toolbox::blockstructured::interpolateCell_AoS_...). The parent's patch is still available in this sweep, as the parent has not been refined when the sweep has started.
If a mesh sweep erases the children of a cell, the parent becomes a leaf again. touchCellFirstTime() clears the parent's patch, and destroyCell() then restricts each child's patch into the parent's patch (toolbox::blockstructured::restrictCell_AoS_...). The averaging accumulates the children's contributions, so the parent has to be cleared first.

The patch is a NxNxN patch, i.e. N volumes per axis.

Definition at line 10 of file InterpolateAndRestrictCells.py.

Constructor & Destructor Documentation

◆ init()

api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.__init__	(		self,
			patch,
		"InterpolateAndRestrictCells.Interpolation"	interpolation = `None`,
		"InterpolateAndRestrictCells.Restriction"	restriction = `None`,
		str	additional_includes = `""`
	)

Parameters

patch	peano4.api.datamodel.Patch The cell data which the action set interpolates and restricts.
interpolation	InterpolateAndRestrictCells.Interpolation Interpolation scheme. Defaults to Interpolation.Linear.
restriction	InterpolateAndRestrictCells.Restriction Restriction scheme. Defaults to Restriction.Averaging.
additional_includes	str Further include statements.

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

Definition at line 113 of file InterpolateAndRestrictCells.py.

References api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.__init__().

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

◆ get_attributes()

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

◆ get_body_of_createGridControlEventsForNextTraversal()

api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.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 167 of file InterpolateAndRestrictCells.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.InterpolateAndRestrictCells.InterpolateAndRestrictCells.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 176 of file InterpolateAndRestrictCells.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.InterpolateAndRestrictCells.InterpolateAndRestrictCells.get_body_of_prepareTraversal ( self )

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

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

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

Definition at line 173 of file InterpolateAndRestrictCells.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.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 161 of file InterpolateAndRestrictCells.py.

◆ get_destructor_body()

api.InterpolateAndRestrictCells.InterpolateAndRestrictCells.get_destructor_body ( self )

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

Definition at line 164 of file InterpolateAndRestrictCells.py.

◆ get_includes()

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

Here is the call graph for this function:

◆ user_should_modify_template()

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