Peano

Searching...

No Matches

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

Inheritance diagram for swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis:

[legend]

Collaboration diagram for swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis:

[legend]

Public Member Functions
	marker_name (name)

	create_cell_marker (name)
	Create the cell marker that is used by the analysis.

	__init__ (self, particle_set, min_particles_per_cell=1, max_particles_per_cell=65536, min_h=0.1, max_h=0.01, scale_marker=0.95)
	Construct the action set.

	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_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_getGridControlEvents (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_TouchCellFirstTime

	__Template_CreateCell

	__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.

This implementation is almost exactly the same as the toolbox variant, but it does not work with a static field, but instead pipes all the refinement events a global variable. Actually, it fuses two different action sets of the toolbox: The actual stats over the markers which count the particles and the translation fo this info into mesh refinement and coarsening commands.

Different to the default toolbox variant, Swift's marker doesn't need to distinguish a new and an old marker and we use the marker information straightaway throughout the steps up.

Please consult the constructor, i.e. init(), for some information on algorithm variants and the implementation.

To understand the code's behaviour, it is resonable to read through Peano's generic AMR description.

Definition at line 11 of file DynamicMeshRefinementAnalysis.py.

Constructor & Destructor Documentation

◆ init()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.__init__	(	self,
		particle_set,
		min_particles_per_cell = 1,
		max_particles_per_cell = 65536,
		min_h = 0.1,
		max_h = 0.01,
		scale_marker = 0.95 )

Construct the action set.

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.

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.

scale_marker: Float In principle, many particle codes create a mesh that is by magnitudes too fine. Therefore, it makes sense to make the refinement events a little bit smaller than the actual underlying cell. However, if they are small, the peano4::grid::merge() operation might not be able to fuse them, i.e. you have to be careful that you increase the tolerance there in return.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 59 of file DynamicMeshRefinementAnalysis.py.

Member Function Documentation

◆ create_cell_marker()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.create_cell_marker ( name )

Create the cell marker that is used by the analysis.

t.b.d.

Definition at line 38 of file DynamicMeshRefinementAnalysis.py.

◆ get_action_set_name()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.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 307 of file DynamicMeshRefinementAnalysis.py.

◆ get_attributes()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.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 301 of file DynamicMeshRefinementAnalysis.py.

◆ get_body_of_operation()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.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 280 of file DynamicMeshRefinementAnalysis.py.

◆ get_body_of_unprepareTraversal()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_body_of_unprepareTraversal ( self )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 333 of file DynamicMeshRefinementAnalysis.py.

◆ get_includes()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.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 319 of file DynamicMeshRefinementAnalysis.py.

◆ get_static_initialisations()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.get_static_initialisations	(		self,
			full_qualified_classname )

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 310 of file DynamicMeshRefinementAnalysis.py.

◆ marker_name()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.marker_name ( name )

Definition at line 35 of file DynamicMeshRefinementAnalysis.py.

◆ user_should_modify_template()

swift2.actionsets.DynamicMeshRefinementAnalysis.DynamicMeshRefinementAnalysis.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 138 of file DynamicMeshRefinementAnalysis.py.