This class assumes that you have NxNxN patch within your block. More...

Inheritance diagram for api.ProjectPatchOntoFaces.ProjectPatchOntoFaces:

[legend]

Collaboration diagram for api.ProjectPatchOntoFaces.ProjectPatchOntoFaces:

[legend]

Public Member Functions
	__init__ (self, patch, patch_overlap, guard, additional_includes, add_assertions=True)

	guard (self)

	guard (self, value)

	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_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_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
	d

	additional_includes

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

	parallel

Static Private Attributes
str	__Template_TouchCellLastTime_Preamble

str	__Template_TouchCellLastTime_Core

str	__Template_TouchCellLastTime_Epilogue

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

This class assumes that you have NxNxN patch within your block.

It also assumes that you have an 2MxNxN patch on your faces. M<N. The code interprets these face-associated data as overlap with the patch, hooks into touchCellLastTime, and projects the cell's patch data onto the overlap (simple copy).

And then runs over your grid and maps the patch data on the respective entries of the face patch which is an auxiliary data structure.

Attributes

patch: peano4.api.datamodel.Patch This is the input data structure, i.e. the patch from which we extract the boundary data.

patch_overlap: peano4.api.datamodel.Patch. Consult remark above about how the dimensions of this overlap patch have to match.

Definition at line 7 of file ProjectPatchOntoFaces.py.

Constructor & Destructor Documentation

◆ init()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__init__	(	self,
		patch,
		patch_overlap,
		guard,
		additional_includes,
		add_assertions = `True`
	)

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

Definition at line 33 of file ProjectPatchOntoFaces.py.

References api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__init__().

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

◆ get_attributes()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 168 of file ProjectPatchOntoFaces.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 81 of file ProjectPatchOntoFaces.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.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 152 of file ProjectPatchOntoFaces.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 73 of file ProjectPatchOntoFaces.py.

◆ get_destructor_body()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_destructor_body ( self )

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

Definition at line 77 of file ProjectPatchOntoFaces.py.

◆ get_guard_of_operation()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 162 of file ProjectPatchOntoFaces.py.

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

Here is the caller graph for this function:

◆ get_includes()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 172 of file ProjectPatchOntoFaces.py.

Here is the call graph for this function:

◆ guard() [1/2]

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.guard ( self )

Definition at line 66 of file ProjectPatchOntoFaces.py.

Here is the caller graph for this function:

◆ guard() [2/2]

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.guard	(	self,
		value
	)

Definition at line 70 of file ProjectPatchOntoFaces.py.

Here is the caller graph for this function:

◆ user_should_modify_template()

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.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 89 of file ProjectPatchOntoFaces.py.

Field Documentation

◆ __Template_TouchCellLastTime_Core

str api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__Template_TouchCellLastTime_Core

staticprivate

Definition at line 98 of file ProjectPatchOntoFaces.py.

Referenced by solvers.fv.actionsets.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__init__(), and api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_body_of_operation().

◆ __Template_TouchCellLastTime_Epilogue

str api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__Template_TouchCellLastTime_Epilogue

staticprivate

Initial value:

=  """
  logTraceOut( "touchCellLastTime(...)---ProjectPatchOntoFaces" );
"""

Definition at line 147 of file ProjectPatchOntoFaces.py.

Referenced by api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_body_of_operation().

◆ __Template_TouchCellLastTime_Preamble

str api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.__Template_TouchCellLastTime_Preamble

staticprivate

Initial value:

=  """
  logTraceIn( "touchCellLastTime(...)---ProjectPatchOntoFaces" );
"""

Definition at line 93 of file ProjectPatchOntoFaces.py.

Referenced by api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_body_of_operation().

◆ additional_includes

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.additional_includes

Definition at line 62 of file ProjectPatchOntoFaces.py.

◆ d

api.ProjectPatchOntoFaces.ProjectPatchOntoFaces.d

Definition at line 35 of file ProjectPatchOntoFaces.py.

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

src/toolbox/blockstructured/api/ProjectPatchOntoFaces.py

Public Member Functions

Data Fields

Static Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_guard_of_operation()

◆ get_includes()

◆ guard() [1/2]

◆ guard() [2/2]

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchCellLastTime_Core

◆ __Template_TouchCellLastTime_Epilogue

◆ __Template_TouchCellLastTime_Preamble

◆ additional_includes

◆ d

◆ init()