Peano

Searching...

No Matches

AMR criterion based upon the particle density. More...

Inheritance diagram for peano4.toolbox.particles.ParticleAMR.ParticleAMR:

[legend]

Collaboration diagram for peano4.toolbox.particles.ParticleAMR.ParticleAMR:

[legend]

Public Member Functions
	__init__ (self, particle_set, particle_tree_analysis, min_particles_per_cell=1, max_particles_per_cell=65536, min_h=0.1, max_h=0.01)
	:: Arguments

	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_body_of_getGridControlEvents (self)

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

	get_action_set_name (self)
	Return unique action set name.

	get_static_initialisations (self, full_qualified_classname)

	get_includes (self)
	Return include statements that you need.

	get_body_of_unprepareTraversal (self)

Public Member Functions inherited from peano4.solversteps.ActionSet.ActionSet
	get_constructor_body (self)
	Define a tailored constructor body.

	get_destructor_body (self)

	get_body_of_prepareTraversal (self)

Data Fields
	d

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

	parallel

Static Private Attributes
	__Template_TouchCellLastTime

	__Template_EndTraversal

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"

Detailed Description

AMR criterion based upon the particle density.

Most codes use this criterion in combination with a classic mesh-based criterion which ensures that the mesh is not coarser than a certain maximal mesh sizes.

The algorithm relies heavily on the ParticleTreeAnalysis action set which annotates each cell in the tree with the sum of the vertices associated to the 2^d adjacent vertices. If this sum exceeds certain thresholds and, depending on the setup, some search radii of hosted particles are small enough, the code refines the tree. It is then the job of subsequent runs with UpdateParticleGridAssociation to drop the particles into the newly created cells.

As we work with cell data to guide the adaptivity yet store the particles within vertices, it is clear that refinement pattern tends to smear out. We get rather regularly refined areas around the particles. For most applications, that's totally fine, as it also ensures that

Definition at line 9 of file ParticleAMR.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.particles.ParticleAMR.ParticleAMR.__init__	(	self,
		particle_set,
		particle_tree_analysis,
		min_particles_per_cell = 1,
		max_particles_per_cell = 65536,
		min_h = 0.1,
		max_h = 0.01 )

:: Arguments

particle_set: peano4.toolbox.particles.ParticleSet Instance of the particle set that is to be used as trigger. Each particle in the set has a search radius and this one is used to guide the AMR.

particle_tree_analysis: peano4.toolbox.particles.ParticleTreeAnalysis Tree analysis algorithm. Usually is instantiated over particle_set, but you can also impose another analysis algorithm.

min_particles_per_cell: Integer (>=0) The tree is not refined if there are less than min_particles_per_cell particles within the cell. By default, this parameter is set to 1 and thus the code refines always if there are more than two particles held in a cell. You can set the value to 0. In this case, we refine whenever there's a particle in a cell and its search radius would allow us to refine further. Set it to a higher number to ensure that there's (approximately) a certain particle counter per cell.

max_particles_per_cell: Integer Forces the code to refine if there are more than max_particles_per_cell particles held. Has to be bigger or equal to min_particles_per_cell.

Whenever the AMR criterion refines, it can happen that particles do not drop down further, as their search radius is too small.

You can also set this argument to zero as well. In this case, the action sets refines all the way down until the mesh size just fits the search radius. It even refines a cell if there's only one particle in it.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 33 of file ParticleAMR.py.

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

Referenced by peano4.toolbox.particles.ParticleAMR.ParticleAMR.__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.toolbox.particles.ParticleAMR.ParticleAMR.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.

Definition at line 213 of file ParticleAMR.py.

◆ get_attributes()

peano4.toolbox.particles.ParticleAMR.ParticleAMR.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 206 of file ParticleAMR.py.

◆ get_body_of_getGridControlEvents()

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

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 201 of file ParticleAMR.py.

◆ get_body_of_operation()

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

◆ get_body_of_unprepareTraversal()

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

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 239 of file ParticleAMR.py.

◆ get_includes()

peano4.toolbox.particles.ParticleAMR.ParticleAMR.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 228 of file ParticleAMR.py.

◆ get_static_initialisations()

peano4.toolbox.particles.ParticleAMR.ParticleAMR.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 216 of file ParticleAMR.py.

◆ user_should_modify_template()

peano4.toolbox.particles.ParticleAMR.ParticleAMR.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 106 of file ParticleAMR.py.

Field Documentation

◆ __Template_EndTraversal

peano4.toolbox.particles.ParticleAMR.ParticleAMR.__Template_EndTraversal

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 176 of file ParticleAMR.py.

◆ __Template_TouchCellLastTime

peano4.toolbox.particles.ParticleAMR.ParticleAMR.__Template_TouchCellLastTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 109 of file ParticleAMR.py.

Referenced by exahype2.solvers.rkfd.actionsets.ProjectPatchOntoFaces.ProjectPatchOntoFaces.get_body_of_operation(), exahype2.tracer.DumpTracerIntoDatabase.DumpTracerIntoDatabase.get_body_of_operation(), peano4.toolbox.particles.ParticleAMR.ParticleAMR.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(), swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_operation(), and swift2.actionsets.UpdateParticleMarker.UpdateParticleMarker.get_body_of_operation().

◆ d

peano4.toolbox.particles.ParticleAMR.ParticleAMR.d

Definition at line 95 of file ParticleAMR.py.

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

python/peano4/toolbox/particles/ParticleAMR.py

Public Member Functions

Data Fields

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_attributes()

◆ get_body_of_getGridControlEvents()

◆ get_body_of_operation()

◆ get_body_of_unprepareTraversal()

◆ get_includes()

◆ get_static_initialisations()

◆ user_should_modify_template()

Field Documentation

◆ __Template_EndTraversal

◆ __Template_TouchCellLastTime

◆ d

◆ init()