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

[legend]

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

[legend]

Public Member Functions
	__init__ (self, particle_set, distance_between_particles, computational_domain_offset, computational_domain_size, initialisation_call="", noise=True, noise_scale=1.0, additional_includes="", guard="true")
	Insert particles.

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

	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	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_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.api.solversteps.ActionSet.ActionSet
	get_static_initialisations (self, full_qualified_classname)

	get_destructor_body (self)

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

	additional_includes

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

	parallel

Static Private Attributes
	__Template_TouchCellFirstTime

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

Definition at line 9 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

Constructor & Destructor Documentation

◆ init()

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.__init__	(	self,
		particle_set,
		distance_between_particles,
		computational_domain_offset,
		computational_domain_size,
		initialisation_call = `""`,
		noise = `True`,
		noise_scale = `1.0`,
		additional_includes = `""`,
		guard = `"true"`
	)

Insert particles.

:Attibutes:

particle: ParticleSet I take this as particle set.

average_distance_between_particles: Float Some positive floating point value.

initialisation_call: String (C code) Within this code snippet, you have a variable particle which is a pointer to your particle type. You can use it to set the particle attributes.

noise: Bool If True, add noise to particle coordinates

noise_scale: If noise=True, the noise added to particle coordinates is +-0.5 * particle distance multiplied by this factor

computational_domain_offset: [Float] Has to be an array with Dimensions entries that specifies the global domain offset. You can pass in an array of floats, and this is definitely the default use case. However, you can also pass in an arbitrary array of strings, as long as these strings make sense in the generated C++ code and eventually return a double each.

computational_domain_size: [Float] Defines size of domain.

guard: String (C code) A simple boolean expression. You can decide if a particle is inserted or not.

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.api.solversteps.ActionSet.ActionSet.

Reimplemented in exaparty.api.input.InsertRandomParticlesIntoCells.InsertRandomParticlesIntoCells, tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh, exaparty.api.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid, and exaparty.api.input.InsertNoisyParticlesAlongCartesianGrid.InsertNoisyParticlesAlongCartesianGrid.

Definition at line 10 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

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

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

Reimplemented in tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh, exaparty.api.input.InsertNoisyParticlesAlongCartesianGrid.InsertNoisyParticlesAlongCartesianGrid, exaparty.api.input.InsertParticlesAlongCartesianGrid.InsertParticlesAlongCartesianGrid, and exaparty.api.input.InsertRandomParticlesIntoCells.InsertRandomParticlesIntoCells.

Definition at line 148 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

◆ get_attributes()

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

Reimplemented in tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.

Definition at line 165 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

◆ get_body_of_createGridControlEventsForNextTraversal()

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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 145 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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 134 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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.

Reimplemented in tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.

Definition at line 170 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

◆ get_guard_of_operation()

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.get_guard_of_operation	(	self,
		operation_name
	)

Return the guard of an operation.

The guard is a C++ boolean expression. The body of the operation (see get_body_of_operation()) is executed if and only if the guard holds. The guard can use the same arguments as the body, i.e. the marker and the fine and coarse grid data. By default, the guard is true, i.e. the body is always executed.

See class' string constants starting with OPERATION_ for possible values of operation_name.

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

Definition at line 140 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

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

Here is the caller graph for this function:

◆ get_includes()

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

Here is the call graph for this function:

◆ user_should_modify_template()

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

Field Documentation

◆ __Template_TouchCellFirstTime

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.__Template_TouchCellFirstTime

staticprivate

Initial value:

=  jinja2.Template(
        
    )

Definition at line 93 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

◆ additional_includes

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.additional_includes

Definition at line 91 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

◆ d

peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.d

Definition at line 77 of file InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.py.

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

src/peano4/api/toolbox/particles/InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.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_createGridControlEventsForNextTraversal()

◆ get_body_of_operation()

◆ get_constructor_body()

◆ get_guard_of_operation()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ __Template_TouchCellFirstTime

◆ additional_includes

◆ d

◆ init()