This action set implements an analysed tree grammar. More...

Inheritance diagram for peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis:

[legend]

Collaboration diagram for peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis:

[legend]

Public Member Functions
	__init__ (self, particle_set, cell_marker=None)

	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_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_includes (self)
	Return include statements that you need.

	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

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

	d

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

	parallel

Protected Attributes
	_cell_data_name

Static Private Attributes
	__Template_TouchCellFirstTime = jinja2.Template( )

	__Template_CreateCell = jinja2.Template()

	__Template_TouchCellLastTime = jinja2.Template()

	__Template_Includes = jinja2.Template()

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 action set implements an analysed tree grammar.

The grammar goes down to the finest level and writes into each leaf cell of the tree the following data:

Number of particles within this cell
The flag ParentOfRefinedCell is set to false

We then run through the tree bottom-up and set these two flags on each spacetree cell along the following rules:

Number of particles of a refined cell in the spacetree equals the number of all the children cells plus the local particles, i.e. those particles stored on the present level.
ParentOfRefinedCell becomes true if one of the children is refined. If none of the children is refined, the flag is false.

I use the analysed tree data to determine if a tree's has to be refined further as it hosts too many particles. I also use it to steer if a tree has to be coarsened if there are not enough particles. Finally, I use the flag ParentOfRefinedCell to ensure that we always remove at most one level from the tree in one tree sweep, as I only erase refined tree nodes for which ParentOfRefinedCell does not hold.

:: Usage ::

I need a particle set to work properly. You also have to invoke add the tree cell properties to the tree and tell every observer that invokes this particle set to handle the tree marker:

my_Peano_project = ...

my_tree_analysis = ParticleTreeAnalysis(...) my_Peano_project.add_cell(my_tree_analysis.cell_marker)

my_algorithmic_step = peano4.api.solversteps.Step( ... ) my_algorithmic_step.use_cell(my_tree_analysis.cell_marker)

Attributes

particle_set: ParticleSet This is the particle set which is to be analysed.

cell_marker: peano4.api.datamodel.DaStGen2 or None If you pass in None, the class will create an appropriate cell marker itself. You can also add in a cell marker that shall be used. In both cases, you have to ensure that your code handles the cell marker accordingly, i.e. ensures that the markers are streamed properly.

Definition at line 37 of file ParticleTreeAnalysis.py.

Constructor & Destructor Documentation

◆ init()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__init__	(	self,
		particle_set,
		cell_marker = `None`
	)

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

Definition at line 100 of file ParticleTreeAnalysis.py.

References peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__init__().

Referenced by peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__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.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 171 of file ParticleTreeAnalysis.py.

◆ get_attributes()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 179 of file ParticleTreeAnalysis.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 ParticleTreeAnalysis.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.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 193 of file ParticleTreeAnalysis.py.

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

Here is the caller graph for this function:

◆ get_constructor_body()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 159 of file ParticleTreeAnalysis.py.

◆ get_destructor_body()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_destructor_body ( self )

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

Definition at line 163 of file ParticleTreeAnalysis.py.

◆ get_includes()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 189 of file ParticleTreeAnalysis.py.

◆ user_should_modify_template()

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.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 175 of file ParticleTreeAnalysis.py.

Field Documentation

◆ __Template_CreateCell

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__Template_CreateCell = jinja2.Template()

staticprivate

Definition at line 127 of file ParticleTreeAnalysis.py.

Referenced by exaparty.api.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_operation(), and peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_body_of_operation().

◆ __Template_Includes

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__Template_Includes = jinja2.Template()

staticprivate

Definition at line 183 of file ParticleTreeAnalysis.py.

Referenced by peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_includes().

◆ __Template_TouchCellFirstTime

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__Template_TouchCellFirstTime = jinja2.Template( )

staticprivate

Definition at line 119 of file ParticleTreeAnalysis.py.

◆ __Template_TouchCellLastTime

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.__Template_TouchCellLastTime = jinja2.Template()

staticprivate

Definition at line 135 of file ParticleTreeAnalysis.py.

◆ _cell_data_name

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis._cell_data_name

protected

Definition at line 106 of file ParticleTreeAnalysis.py.

◆ cell_marker

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.cell_marker

Definition at line 105 of file ParticleTreeAnalysis.py.

◆ d

peano4.api.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.d

Definition at line 111 of file ParticleTreeAnalysis.py.

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

src/peano4/api/toolbox/particles/ParticleTreeAnalysis.py

Public Member Functions

Data Fields

Protected Attributes

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_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_CreateCell

◆ __Template_Includes

◆ __Template_TouchCellFirstTime

◆ __Template_TouchCellLastTime

◆ _cell_data_name

◆ cell_marker

◆ d

◆ init()