Peano

Searching...

No Matches

Insert particles. More...

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

[legend]

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

[legend]

Public Member Functions
	__init__ (self, particle_set, average_distance_between_particles, initialisation_call, round_down=False, noise=True, additional_includes="")
	Insert particles.

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

	get_body_of_getGridControlEvents (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.

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

	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

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

Data Fields
	d

	additional_includes

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

	parallel

Static Private Attributes
	__Template_TouchCellFirstTime

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

Insert particles.

The particles are topologically Cartesian, i.e. they are not totally random. So we embed a Cartesian "grid" of particles into each unrefined cell, and then add some noise to them. As the individual cells are not coupled with each other, and as we do not evaluate any global coordinates, the overall result will not be random, even if you switch off noise completely, as the spacing between two regular particle layouts between two neighbouring cells is not "synchronised".

Definition at line 9 of file InsertRandomParticlesIntoUnrefinedCells.py.

Constructor & Destructor Documentation

◆ init()

peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.__init__	(	self,
		particle_set,
		average_distance_between_particles,
		initialisation_call,
		round_down = False,
		noise = True,
		additional_includes = "" )

Insert particles.

:Attibutes:

particle: ParticleSet I take this as particle set.

average_distance_between_particles: Float Some positive floating point value. I call it average, as it is an average if you apply noise. Otherwise, it is the precise distance.

initialisation_call: String (C++ code snippet) Arbitrary code snippet which can work over a pointer particle. The object to which this pointer points to is properly allocated, and its coordinates are set. Furthermore, the object's search radius is initialised with zero. You can alter the particle attributes now, i.e. initialise the domain-specific data. Please also ensure you assign the particle a proper search (interaction) radius if the radius is of relevance for your application.

Please note that we create a lot of particles and then decide if we actually insert them. Only those particles where we come to the conclusion that we should insert them (as they overlap with the cell) are actually then initialised through this code snippet.

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 23 of file InsertRandomParticlesIntoUnrefinedCells.py.

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

Referenced by peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.__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.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.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 118 of file InsertRandomParticlesIntoUnrefinedCells.py.

◆ get_body_of_getGridControlEvents()

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

Reimplemented from peano4.solversteps.ActionSet.ActionSet.

Definition at line 115 of file InsertRandomParticlesIntoUnrefinedCells.py.

◆ get_body_of_operation()

peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.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 109 of file InsertRandomParticlesIntoUnrefinedCells.py.

◆ get_includes()

peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.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 124 of file InsertRandomParticlesIntoUnrefinedCells.py.

Here is the call graph for this function:

◆ user_should_modify_template()

peano4.toolbox.particles.InsertRandomParticlesIntoUnrefinedCells.InsertRandomParticlesIntoUnrefinedCells.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 121 of file InsertRandomParticlesIntoUnrefinedCells.py.