Peano

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__init__	(	self,
		particle_set,
		particle_cell_update_kernel = None,
		touch_vertex_first_time_compute_particle_update_kernel = None,
		touch_vertex_last_time_compute_particle_update_kernel = None,
		prepare_traversal_kernel = "",
		unprepare_traversal_kernel = "",
		additional_includes = "",
		active_particle_set = None )

Update particles on a single level.

To be used if you want to update particles within their cell, while they either

do not interact at all; or
interact only with particles on the same mesh level.

This code snippet creates a tree walker, i.e. an action set that runs through the underlying spacetree top-down. Users can plug into what happens per cell and what happens when we touch a set of particles for the first and for the last time.

Per cell updates

Per tree node (cell) there are two different sets. The set of local particles of a cell are all of the particles whose centre is contained within the cell. The set of active particles are all particles which are associated with an adjacent vertex of the cell. In line with Peano's particle storage scheme, this effectively means that the active particles are those from the cell plus its h/2 environment.

If the active_particle_set attribute is None, then the active set and the local set are of the same type. They are however not the same sets, as one contains only the particles held within the cell. You can set the active set to another species of particles and thus couple two types of particles.

The local set is a strict subset of the active set per cell. The code has not checked beforehand if its particles overlap with the current cell.

Per vertex updates

Besides the cell kernel which is there to realise per-cell updates, we also have a vertex kernel which we call whenever a vertex is loaded for the first time. That is, you can assume that the vertex kernel has been launched for all 2^d vertices of a cell before its cell kernel is triggered. The vertex kernel has access to a local set: These sets contain all the particles whose centre lies within the square/cube around the vertex with mesh size 2h. So this area goes h along each each coordinate axis into the neighbouring cells. The vertex's local particles also have to reside on the same resolution level.

Type of updates

You can use this action set to realise particle updates without any dependencies on other particles.
You can use this action set to realise particle updates where the particle depends on other particles which are stored on the same level.

The following constraints apply:

If you work with the local set within the cell, you are on the safe side, though the association of particles to cells is not unique. There is a tiny overlap between cells, i.e. particles on the face between two cells might be associated to both cells. If you update particles, you should employ a boolean flag to memorise if a particle has been updated already or not.
If you work with the local set within a vertex, this local set overlaps with adjacent cells (see previous item), and it might even overlap with a remote subdomain.
If you change a particle position while the action set runs, you might end up with inconsistent data view.

Validity if particles change their position of cut-off radius

This particular action set constructs its active and local sets totally on-the-fly. It does not maintain any data while is marches through the mesh. Consequently, it is robust w.r.t. particle position updates or lift and drops and in general any resorting.

Arguments

Parameters

particle_set	ParticleSet
particle_particle_interaction_kernel	String holding C++ code This C++ code can access three different types of variables: There's a list of particles called activeParticles, there's a list of particles called localParticles, and there's the cell marker. See the guidebook for further info. A typical kernel resembles

      for (auto* localParticle: localParticles )
      for (auto* activeParticle: activeParticles ) {
localParticle->doSomethingFancy( activeParticle );
      }

Parameters

active_particle_set	ParticleSet or None You can compare different particles species with this argument. It allows you to make the active particles stem from another species than the local ones that you actually update. Pick None if both sets are of the same type.
touch_vertex_first_time_compute_particle_update_kernel	String or None Can be empty, but if you wanna move particles, then a minimal example string passed equals

      for (auto* localParticle: localParticles ) {
localParticle->setMoveState( globaldata::Particle::MoveState::NotMovedYet );
      }

i.e. you will have a variable localParticle available in this kernel and it is a pointer. There is no notion of an active variable for touch first or touch last.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Reimplemented in swift2.api.actionsets.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.

Definition at line 9 of file UpdateParticle_SingleLevelInteraction.py.

References peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__init__().

Referenced by peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.solversteps.ActionSet.ActionSet.

Reimplemented in swift2.api.actionsets.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.

Definition at line 274 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.solversteps.ActionSet.ActionSet.

Definition at line 296 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_getGridControlEvents ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 265 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 255 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_prepareTraversal ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 268 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_unprepareTraversal ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 271 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.solversteps.ActionSet.ActionSet.

Definition at line 301 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.solversteps.ActionSet.ActionSet.

Definition at line 280 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.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.solversteps.ActionSet.ActionSet.

Definition at line 277 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__Template_TouchCellFirstTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 213 of file UpdateParticle_SingleLevelInteraction.py.

Referenced by exahype2.tracer.InsertParticlesFromFile.InsertParticlesFromFile.get_body_of_operation(), peano4.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.get_body_of_operation(), peano4.toolbox.particles.InsertParticlesByCoordinates.InsertParticlesByCoordinates.get_body_of_operation(), peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.get_body_of_operation(), peano4.toolbox.particles.ParticleTreeAnalysis.ParticleTreeAnalysis.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists.UpdateParticle_MultiLevelInteraction_StackOfLists.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.UpdateParticle_MultiLevelInteraction_StackOfLists_ContiguousParticles.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.get_body_of_operation(), peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.UpdateParticle_SingleLevelInteraction_ContiguousParticles.get_body_of_operation(), swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_operation(), and solvers.api.actionsets.PlotVertexDataInPeanoBlockFormat.PlotVertexDataInPeanoBlockFormat.get_body_of_operation().

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__Template_TouchVertexFirstTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 175 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.__Template_TouchVertexLastTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 199 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction._particle_set

protected

Definition at line 145 of file UpdateParticle_SingleLevelInteraction.py.

peano4.toolbox.particles.UpdateParticle_SingleLevelInteraction.UpdateParticle_SingleLevelInteraction.d

Definition at line 146 of file UpdateParticle_SingleLevelInteraction.py.

Public Member Functions
	__init__ (self, particle_set, particle_cell_update_kernel=None, touch_vertex_first_time_compute_particle_update_kernel=None, touch_vertex_last_time_compute_particle_update_kernel=None, prepare_traversal_kernel="", unprepare_traversal_kernel="", additional_includes="", active_particle_set=None)
	Update particles on a single level.

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

	get_body_of_getGridControlEvents (self)

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

	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.

	get_attributes (self)
	Return attributes as copied and pasted into the generated class.

	get_constructor_body (self)
	Define a tailored constructor body.

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

Data Fields
	d

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

	parallel

Additional Inherited Members
Static Public Attributes inherited from peano4.solversteps.ActionSet.ActionSet
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"

Public Member Functions

Data Fields

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ init()

Per cell updates

Per vertex updates

Type of updates

Validity if particles change their position of cut-off radius

Arguments

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_body_of_unprepareTraversal()

◆ get_constructor_body()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchCellFirstTime

◆ __Template_TouchVertexFirstTime

◆ __Template_TouchVertexLastTime

◆ _particle_set

◆ d

Static Private Attributes
	__Template_TouchVertexFirstTime

	__Template_TouchVertexLastTime

	__Template_TouchCellFirstTime

Public Member Functions

Data Fields

Protected Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Per cell updates

Per vertex updates

Type of updates

Validity if particles change their position of cut-off radius

Arguments

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_body_of_prepareTraversal()

◆ get_body_of_unprepareTraversal()

◆ get_constructor_body()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchCellFirstTime

◆ __Template_TouchVertexFirstTime

◆ __Template_TouchVertexLastTime

◆ _particle_set

◆ d

◆ init()