Basically superclass, though we add these numbers. More...

Inheritance diagram for tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh:

[legend]

Collaboration diagram for tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh:

[legend]

Public Member Functions
	__init__ (self, particle_set, distance_between_particles, computational_domain_offset, noise=True, additional_includes="", guard="true")
	See superclass.

	get_action_set_name (self)
	Return unique action set name.

	get_constructor_body (self)
	Define a tailored constructor body.

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

Public Member Functions inherited from peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells
	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.

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

Additional Inherited Members
Data Fields inherited from peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells
	d

	additional_includes

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

	parallel

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

Basically superclass, though we add these numbers.

Definition at line 11 of file InsertParticlesAlongCartesianMesh.py.

Constructor & Destructor Documentation

◆ init()

tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.__init__	(	self,
		particle_set,
		distance_between_particles,
		computational_domain_offset,
		noise = `True`,
		additional_includes = `""`,
		guard = `"true"`
	)

See superclass.

Reimplemented from peano4.api.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.

Definition at line 19 of file InsertParticlesAlongCartesianMesh.py.

References tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.__init__().

Referenced by tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.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.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.

Definition at line 53 of file InsertParticlesAlongCartesianMesh.py.

◆ get_attributes()

tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.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.toolbox.particles.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.InsertParticlesAlongCartesianLayoutIntoUnrefinedCells.

Definition at line 64 of file InsertParticlesAlongCartesianMesh.py.

References tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.get_attributes().

Referenced by tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.get_attributes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_constructor_body()

tracer.InsertParticlesAlongCartesianMesh.InsertParticlesAlongCartesianMesh.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.