Action set (reactions to events) More...

Inheritance diagram for peano4.api.solversteps.ActionSet.ActionSet:

[legend]

Collaboration diagram for peano4.api.solversteps.ActionSet.ActionSet:

Public Member Functions
	__init__ (self, descend_invocation_order=0, parallel=False)

	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_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_implementation_of_operation (self, operation_name)
	Return the C++ implementation 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.

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.

	get_includes (self)
	Return include statements that you need.

Data Fields
	descend_invocation_order

	parallel

Static Public Attributes
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

Action set (reactions to events)

Peano runs through the mesh tied to an observer. The observer "sees" events and issues actions tied to these events. That is the observer listens to the tree traversal for events alike "this is the first time I see (touch) a vertex". A list of events that we can listen to is specified by this class through class attributes starting with OPERATION_. Peano's documentation holds a discussion of events and their temporal and spatial ordering.

For each grid traversal, Peano expects one C++ observer. The observer is represented within Python through peano4.api.solversteps.Step, i.e. this class creates eventually one peano4.api.output.Observer which in return writes out the C++ code. Each observer can have an arbitrary number of action set classes. Each step consequently can hold an action set. The observer's job is it to take information like "I've just entered a spacetree cell" and to break it down into actions like

this vertex is read for the first time
this hanging vertex has to be created
this face is read for the first time
this cell now is entered and these are the associated faces and vertices

For each of these "actions", the generated C++ code will call the corresponding functions of all associated action sets one by one.

The cartoon above illustrates these three layers: Users or Peano extensions build up logical program steps (left top). They are basically containers with a unique name. Each step holds an arbitrary number of ActionSets. They are, first of all, mappings where each logical action is potentially tied to a C++ code snippet. When the Peano project is generated, each action set is translated into its counterpart in the output namespace which is now a complete description of this class, i.e. holds all functions required, all parameters, ... It copies over the C++ code snippet from its specifiation. This Python representation can then be dumped into a C++ class.

Lifecycle and parallelisation

Action sets are non-persistent, i.e. if you generate C++ code, remind yourself that the class implementing a particular action set will be generated once per grid sweep per tree. As a logical consequence, different action sets are in principle totally independent. If they exchange data, you have to realise this. However, there's a creational routine and a merge command, i.e. you can implement forks and joins (reductions) "natively". There are also functions to inject static data into an action set.

There will be one class per action set per context (observer) in which it is used. One object will be created per grid sweep, and it will have the tree identifier -1 by default. The actual objects that then are used are constructed from this prototype object via the augmented copy constructor. The other important role of the prototype object, i.e. the one tied to spacetree id -1, is to manage the grid traversal events. It is this object that is asked to hand out grid traversals. Consult the documentation of get_constructor_body() for details on the tree id.

If you want to realise BSP-like programming, then you typically realise the data sharing via the copy constructor. The attributes of the action set then are all thread-local, i.e. there's no need to be afraid of memory races. The join in turn should be done within OPERATION_END_TRAVERSAL. Here, you'll need a semaphore, as the fusion of objects is not per se thread-safe.

The injected C++ snippets

To inject C++ code, i.e. what has to be done, you make get_body_of_operation() return this code if the corresponding argument is passed in. This result should be plain C++ code which the generator really can take and copy n paste into the generated implementation files. If you want these injected snippets to do something solver-specific, a lot of action sets read out there environment and apply jinja2 templates to tailor the snippet to their needs. For example: If you want to do something with the adjacent vertices of a cell, you have to know what these will be called eventually. In this case, it makes sense to study the naming conventions that peano4.api.output.ActionSet will put in place.

The easiest way to find these out is to generate some code, to look into the generated output, and then to reconstruct the naming conventions. To be able to do so, it makes sense to let get_action_set_name() return a unique name, so it is easier for you to find what C++ file corresponds to which action set.

A discussion some event functions and their semantics as well as further info on the arguments can be found in the documentation of Action sets and events.

Guard and body

The C++ code of each event consists of two parts which you specify separately:

get_guard_of_operation() returns a C++ boolean expression which decides whether the event's code is executed. It defaults to true.
get_body_of_operation() returns the actual C++ code of the event, i.e. the code that is executed if the guard holds. It should not wrap itself into an if statement evaluating the guard.

Do not override get_implementation_of_operation(). It combines guard and body into the C++ code that ends up in the generated implementation file, i.e. it yields

   if (guard) {
     body
   }

The routines prepareTraversal(), unprepareTraversal() and createGridControlEventsForNextTraversal() are not tied to a vertex, face or cell and hence have no guard. Their get_implementation_of_...() routines yield the body only.

Order of invocation and concurrency level

The observer invokes the events of a step's action sets in the order of the step's action sets (reversed for the events of leaveCell()). peano4.api.solversteps.Step.Step.add_action_set() sorts the action sets according to their descend_invocation_order.

Consecutive action sets with parallel=True form a task group: Per event, the observer spawns their code as one task per action set and waits for all of them, before it continues. An action set with parallel=False, or a peano4.api.solversteps.SynchroniseActionSets.SynchroniseActionSets marker, ends a group (peano4.api.solversteps.SynchroniseActionSets.get_task_groups()). Label an action set as parallel only if its events do not depend on the events of the other action sets of its group and do not write data they read or write.

Important links

Parameters

parallel	Boolean See section on "Order of invocation and concurrency level" in class documentation.
descend_invocation_order	Integer See section on "Order of invocation and concurrency level" in class documentation.

Definition at line 6 of file ActionSet.py.

Constructor & Destructor Documentation

◆ init()

peano4.api.solversteps.ActionSet.ActionSet.__init__	(	self,
		descend_invocation_order = `0`,
		parallel = `False`
	)

Definition at line 172 of file ActionSet.py.

Member Function Documentation

◆ get_action_set_name()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 339 of file ActionSet.py.

◆ get_attributes()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 386 of file ActionSet.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 208 of file ActionSet.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.solversteps.ActionSet.ActionSet.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.

Definition at line 284 of file ActionSet.py.

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

Here is the caller graph for this function:

◆ get_body_of_prepareTraversal()

peano4.api.solversteps.ActionSet.ActionSet.get_body_of_prepareTraversal ( self )

Reimplemented in solvers.fv.actionsets.InitialCondition.InitialCondition, exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests, exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint, exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint, exahype2.api.fv.actionsets.ComputeGlobalCFLCondition.ComputeGlobalCFLCondition, exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize, exaparty.api.actionsets.DummyStep.DummyStep, exaparty.api.actionsets.ScatterGlobalMemory.ScatterGlobalMemory, solvers.api.actionsets.DGCGCoupling.AdditiveDGCGCoupling, solvers.api.actionsets.DGCGCoupling.MultiplicativeDGCGCoupling, peano4.api.solversteps.SynchroniseActionSets.SynchroniseActionSets, peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet, peano4.api.taskgraph.compiler.WaitForCellTaskActionSet.WaitForCellTaskActionSet, peano4.api.toolbox.particles.api.UpdateParallelState.UpdateParallelState, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles, peano4.api.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction, peano4.api.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles, api.InterpolateAndRestrictCells.InterpolateAndRestrictCells, api.InterpolateHangingFaces.InterpolateHangingFaces, api.RestrictHangingFaces.RestrictHangingFaces, api.actionsets.LoadBalancing.LoadBalancing, and api.actionsets.ToggleLoadBalancing.ToggleLoadBalancing.

Definition at line 231 of file ActionSet.py.

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

Here is the caller graph for this function:

◆ get_body_of_unprepareTraversal()

peano4.api.solversteps.ActionSet.ActionSet.get_body_of_unprepareTraversal ( self )

Reimplemented in exahype2.api.blockstructured.ConsumeRefinementRequests.ConsumeRefinementRequests, exahype2.api.blockstructured.DynamicMeshRefinement.DynamicMeshRefinement, exahype2.api.blockstructured.LoadCheckpoint._RefineFromCheckpoint, exahype2.api.blockstructured.LoadCheckpoint._LoadPatchesFromCheckpoint, exahype2.api.fv.actionsets.ComputeGlobalCFLCondition.ComputeGlobalCFLCondition, exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize, exaparty.api.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis, peano4.api.solversteps.SynchroniseActionSets.SynchroniseActionSets, peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet, peano4.api.taskgraph.compiler.WaitForCellTaskActionSet.WaitForCellTaskActionSet, peano4.api.toolbox.particles.api.AbstractUpdateParticleGridAssociation.AbstractUpdateParticleGridAssociation, peano4.api.toolbox.particles.ParticleAMR.ParticleAMR, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists, peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles, peano4.api.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction, peano4.api.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles, api.InterpolateAndRestrictCells.InterpolateAndRestrictCells, api.InterpolateHangingFaces.InterpolateHangingFaces, api.RestrictHangingFaces.RestrictHangingFaces, api.actionsets.LoadBalancing.LoadBalancing, and api.actionsets.ToggleLoadBalancing.ToggleLoadBalancing.

Definition at line 247 of file ActionSet.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

peano4.api.solversteps.ActionSet.ActionSet.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

Definition at line 178 of file ActionSet.py.

◆ get_destructor_body()

peano4.api.solversteps.ActionSet.ActionSet.get_destructor_body ( self )

Definition at line 205 of file ActionSet.py.

◆ get_guard_of_operation()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 298 of file ActionSet.py.

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

Here is the caller graph for this function:

◆ get_implementation_of_createGridControlEventsForNextTraversal()

peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_createGridControlEventsForNextTraversal ( self )

Return the C++ implementation of createGridControlEventsForNextTraversal()

There is no guard for this routine, i.e. the implementation is the body. Do not override this routine, but override get_body_of_createGridControlEventsForNextTraversal().

Definition at line 218 of file ActionSet.py.

Referenced by peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet.get_body_of_createGridControlEventsForNextTraversal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_implementation_of_operation()

peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_operation	(	self,
		operation_name
	)

Return the C++ implementation of an operation.

Combines the guard (see get_guard_of_operation()) and the body (see get_body_of_operation()) into

   if (guard) {

body }

If the body is empty or the guard is true, the routine yields the body only. Do not override this routine, but override get_guard_of_operation() and get_body_of_operation().

Reimplemented in peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet, and peano4.api.taskgraph.compiler.WaitForCellTaskActionSet.WaitForCellTaskActionSet.

Definition at line 315 of file ActionSet.py.

Here is the call graph for this function:

◆ get_implementation_of_prepareTraversal()

peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_prepareTraversal ( self )

Return the C++ implementation of prepareTraversal()

There is no guard for this routine, i.e. the implementation is the body. Do not override this routine, but override get_body_of_prepareTraversal().

Definition at line 234 of file ActionSet.py.

Referenced by peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet.get_body_of_prepareTraversal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_implementation_of_unprepareTraversal()

peano4.api.solversteps.ActionSet.ActionSet.get_implementation_of_unprepareTraversal ( self )

Return the C++ implementation of unprepareTraversal()

There is no guard for this routine, i.e. the implementation is the body. Do not override this routine, but override get_body_of_unprepareTraversal().

Definition at line 250 of file ActionSet.py.

Referenced by peano4.api.taskgraph.compiler.SpawnCellTaskActionSet.SpawnCellTaskActionSet.get_body_of_unprepareTraversal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_includes()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 398 of file ActionSet.py.

◆ get_static_initialisations()

peano4.api.solversteps.ActionSet.ActionSet.get_static_initialisations	(	self,
		full_qualified_classname
	)

Definition at line 201 of file ActionSet.py.

◆ may_run_in_background_task()

bool peano4.api.solversteps.ActionSet.ActionSet.may_run_in_background_task ( self )

May a task graph compiler move touchCellFirstTime() into a task.

Some task graph compilers spawn the touchCellFirstTime() event of an action set as a task (peano4.api.taskgraph.compiler.CellTaskProducerConsumer._translate()). Return False if this is not worth it, e.g. as the event is so cheap that the tasking overhead dominates. The action set is then invoked directly within the mesh traversal. By default, every action set may run in a task.

Reimplemented in exahype2.api.fv.actionsets.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.ReadjustTimeStepSizeForOptimisticGlobalTimestepping.

Definition at line 369 of file ActionSet.py.

◆ user_should_modify_template()

peano4.api.solversteps.ActionSet.ActionSet.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.

Definition at line 356 of file ActionSet.py.

Field Documentation

◆ descend_invocation_order [1/2]

int peano4.api.solversteps.ActionSet.ActionSet.descend_invocation_order = 0

static

Definition at line 169 of file ActionSet.py.

◆ descend_invocation_order [2/2]

peano4.api.solversteps.ActionSet.ActionSet.descend_invocation_order

Definition at line 173 of file ActionSet.py.

◆ OPERATION_BEGIN_TRAVERSAL

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_BEGIN_TRAVERSAL = "beginTraversal"

static

Definition at line 262 of file ActionSet.py.

◆ OPERATION_CREATE_CELL

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_CREATE_CELL = "createCell"

static

Definition at line 273 of file ActionSet.py.

◆ OPERATION_CREATE_HANGING_FACE

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_CREATE_HANGING_FACE = "createHangingFace"

static

Definition at line 271 of file ActionSet.py.

◆ OPERATION_CREATE_HANGING_VERTEX

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_CREATE_HANGING_VERTEX = "createHangingVertex"

static

Definition at line 267 of file ActionSet.py.

◆ OPERATION_CREATE_PERSISTENT_FACE

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_CREATE_PERSISTENT_FACE = "createPersistentFace"

static

Definition at line 269 of file ActionSet.py.

◆ OPERATION_CREATE_PERSISTENT_VERTEX

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_CREATE_PERSISTENT_VERTEX = "createPersistentVertex"

static

Definition at line 265 of file ActionSet.py.

◆ OPERATION_DESTROY_CELL

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_DESTROY_CELL = "destroyCell"

static

Definition at line 274 of file ActionSet.py.

◆ OPERATION_DESTROY_HANGING_FACE

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_DESTROY_HANGING_FACE = "destroyHangingFace"

static

Definition at line 272 of file ActionSet.py.

◆ OPERATION_DESTROY_HANGING_VERTEX

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_DESTROY_HANGING_VERTEX = "destroyHangingVertex"

static

Definition at line 268 of file ActionSet.py.

◆ OPERATION_DESTROY_PERSISTENT_FACE

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_DESTROY_PERSISTENT_FACE = "destroyPersistentFace"

static

Definition at line 270 of file ActionSet.py.

◆ OPERATION_DESTROY_PERSISTENT_VERTEX

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_DESTROY_PERSISTENT_VERTEX = "destroyPersistentVertex"

static

Definition at line 266 of file ActionSet.py.

◆ OPERATION_END_TRAVERSAL

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_END_TRAVERSAL = "endTraversal"

static

Definition at line 263 of file ActionSet.py.

◆ OPERATION_TOUCH_CELL_FIRST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_CELL_FIRST_TIME = "touchCellFirstTime"

static

Definition at line 280 of file ActionSet.py.

◆ OPERATION_TOUCH_CELL_LAST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_CELL_LAST_TIME = "touchCellLastTime"

static

Definition at line 281 of file ActionSet.py.

◆ OPERATION_TOUCH_FACE_FIRST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_FACE_FIRST_TIME = "touchFaceFirstTime"

static

Definition at line 278 of file ActionSet.py.

◆ OPERATION_TOUCH_FACE_LAST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_FACE_LAST_TIME = "touchFaceLastTime"

static

Definition at line 279 of file ActionSet.py.

◆ OPERATION_TOUCH_VERTEX_FIRST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_VERTEX_FIRST_TIME = "touchVertexFirstTime"

static

Definition at line 276 of file ActionSet.py.

◆ OPERATION_TOUCH_VERTEX_LAST_TIME

str peano4.api.solversteps.ActionSet.ActionSet.OPERATION_TOUCH_VERTEX_LAST_TIME = "touchVertexLastTime"

static

Definition at line 277 of file ActionSet.py.

◆ parallel [1/2]

bool peano4.api.solversteps.ActionSet.ActionSet.parallel = False

static

Definition at line 170 of file ActionSet.py.

◆ parallel [2/2]

peano4.api.solversteps.ActionSet.ActionSet.parallel

Definition at line 174 of file ActionSet.py.

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

src/peano4/api/solversteps/ActionSet.py

Public Member Functions

Data Fields

Static Public Attributes

Detailed Description

Lifecycle and parallelisation

The injected C++ snippets

Guard and body

Order of invocation and concurrency level

Important links

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_body_of_unprepareTraversal()

◆ get_constructor_body()

◆ get_destructor_body()

◆ get_guard_of_operation()

◆ get_implementation_of_createGridControlEventsForNextTraversal()

◆ get_implementation_of_operation()

◆ get_implementation_of_prepareTraversal()

◆ get_implementation_of_unprepareTraversal()

◆ get_includes()

◆ get_static_initialisations()

◆ may_run_in_background_task()

◆ user_should_modify_template()

Field Documentation

◆ descend_invocation_order [1/2]

◆ descend_invocation_order [2/2]

◆ OPERATION_BEGIN_TRAVERSAL

◆ OPERATION_CREATE_CELL

◆ OPERATION_CREATE_HANGING_FACE

◆ OPERATION_CREATE_HANGING_VERTEX

◆ OPERATION_CREATE_PERSISTENT_FACE

◆ OPERATION_CREATE_PERSISTENT_VERTEX

◆ OPERATION_DESTROY_CELL

◆ OPERATION_DESTROY_HANGING_FACE

◆ OPERATION_DESTROY_HANGING_VERTEX

◆ OPERATION_DESTROY_PERSISTENT_FACE

◆ OPERATION_DESTROY_PERSISTENT_VERTEX

◆ OPERATION_END_TRAVERSAL

◆ OPERATION_TOUCH_CELL_FIRST_TIME

◆ OPERATION_TOUCH_CELL_LAST_TIME

◆ OPERATION_TOUCH_FACE_FIRST_TIME

◆ OPERATION_TOUCH_FACE_LAST_TIME

◆ OPERATION_TOUCH_VERTEX_FIRST_TIME

◆ OPERATION_TOUCH_VERTEX_LAST_TIME

◆ parallel [1/2]

◆ parallel [2/2]

◆ init()