Inheritance diagram for exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep:

[legend]

Collaboration diagram for exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep:

[legend]

Public Member Functions
	__init__ (self, particle_set)
	Ensure that touchVertexLastTime() on vertex terminates prior to subsequent touchVertexLastTime()

	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_action_set_name (self)
	Return unique action set name.

	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_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	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.

Data Fields
	d

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

	parallel

Protected Attributes
	_particle_set

Static Private Attributes
	__Template_TouchVertexFirstTime

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

Definition at line 9 of file SynchroniseVerticesWithPreviousMeshSweep.py.

Constructor & Destructor Documentation

◆ init()

exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.__init__	(	self,
		particle_set
	)

Ensure that touchVertexLastTime() on vertex terminates prior to subsequent touchVertexLastTime()

This action set is used by MultisweepTaskGraph, where we run through the mesh, spawn graphs and immediately switch to the next mesh traversal. This way, we produce the whole task graph of multiple logical steps on-the-fly. To make the whole thing work, we have to ensure that the task of touchVertexLastTime() of one traversal finishes before the one spawned by touchVertexFirstTime() is activated.

In prinicple, we can embed this into the task creation by creating the corresponding in-dependency. I tried this in the TaskGraphKernelWrapper. However, when we write the touchVertexFirstTime() task, we really do not know if there has been another touchVertexFirstTime() task before. So instead of having complicated logic, I use an empty task to create that dependency once and for all.

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

Definition at line 10 of file SynchroniseVerticesWithPreviousMeshSweep.py.

Member Function Documentation

◆ get_action_set_name()

exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.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 74 of file SynchroniseVerticesWithPreviousMeshSweep.py.

◆ get_body_of_operation()

exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.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 68 of file SynchroniseVerticesWithPreviousMeshSweep.py.

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

Here is the caller graph for this function:

◆ get_includes()

exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.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 77 of file SynchroniseVerticesWithPreviousMeshSweep.py.

◆ user_should_modify_template()

exaparty.api.actionsets.SynchroniseVerticesWithPreviousMeshSweep.SynchroniseVerticesWithPreviousMeshSweep.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 45 of file SynchroniseVerticesWithPreviousMeshSweep.py.