peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells Class Reference

Gives each mesh cell a unique number. More...

Inheritance diagram for peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells:

Collaboration diagram for peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells:

Public Member Functions
	__init__ (self, task_name)
	Initialise assignment.
	get_body_of_operation (self, operation_name)
	Very simple operation which basically resets all data.
	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_includes (self)
	Return include statements that you need.
Public Member Functions inherited from peano4.api.solversteps.ActionSet.ActionSet
	get_constructor_body (self)
	Define a tailored constructor body.
	get_static_initialisations (self, full_qualified_classname)
	get_destructor_body (self)
	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_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.
	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

Protected Attributes
	_task_name

Additional Inherited Members
Data Fields inherited from peano4.api.solversteps.ActionSet.ActionSet
	descend_invocation_order
	parallel
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

Gives each mesh cell a unique number.

The numbers are unique per rank, but not globally unique. If you want to use this action set, you before have to add a marker to the mesh data model:

my_fancy_name = ...
 
cell_marker_for_tasks = peano4.api.toolbox.api.EnumerateCellsAndVertices.create_cell_marker(my_fancy_name)
self._project.datamodel.add_cell(cell_marker_for_tasks)

See also

create_vertex_marker()

Definition at line 16 of file AssignNumbersToCells.py.

Constructor & Destructor Documentation

__init__()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.__init__	(		self,
			task_name
	)

Initialise assignment.

Parameters

task_name

String The name of the task (attribute tied to the mesh entity) to be manipulated.

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

Definition at line 36 of file AssignNumbersToCells.py.

References peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.__init__().

Referenced by peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

get_action_set_name()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.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 91 of file AssignNumbersToCells.py.

get_body_of_createGridControlEventsForNextTraversal()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.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 88 of file AssignNumbersToCells.py.

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

Here is the caller graph for this function:

get_body_of_operation()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.get_body_of_operation	(		self,
			operation_name
	)

Very simple operation which basically resets all data.

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

Definition at line 53 of file AssignNumbersToCells.py.

References solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks._task_name, peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells._task_name, peano4.api.toolbox.api.EnumerateCellsAndVertices.AssignNumbersToMesh._task_name, and peano4.api.toolbox.api.EnumerateCellsAndVertices.ClearNumbersOnMesh._task_name.

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

Here is the caller graph for this function:

get_includes()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.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 97 of file AssignNumbersToCells.py.

user_should_modify_template()

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.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 94 of file AssignNumbersToCells.py.

Field Documentation

_task_name

peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells._task_name

protected

Definition at line 50 of file AssignNumbersToCells.py.

Referenced by solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks.add_to_init_solution(), solvers.api.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks.DiscontinuousGalerkinDiscretisationPointWiseRiemannSolver_Tasks.add_to_solve(), peano4.api.toolbox.api.AssignNumbersToCells.AssignNumbersToCells.get_body_of_operation(), peano4.api.toolbox.api.EnumerateCellsAndVertices.AssignNumbersToMesh.get_body_of_operation(), and peano4.api.toolbox.api.EnumerateCellsAndVertices.ClearNumbersOnMesh.get_body_of_operation().

---

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

• src/peano4/api/toolbox/api/AssignNumbersToCells.py