Particle tracing over the DG solver. More...

Inheritance diagram for tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing:

[legend]

Collaboration diagram for tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing:

[legend]

Public Member Functions
	__init__ (self, particle_set, solver, project_on_tracer_properties_kernel, projection_kernel_arguments="""marker,{{ORDER}},repositories::{{SOLVER_INSTANCE}}.QuadraturePoints1d,{{NUMBER_OF_UNKNOWNS}}+{{NUMBER_OF_AUXILIARY_VARIABLES}},fineGridCell{{SOLVER_NAME}}Q.value,*p""")

	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.

Public Member Functions inherited from peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets
	get_body_of_operation (self, operation_name)
	Return actual C++ code snippets to be inserted into C++ code.

	get_body_of_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

	get_body_of_prepareTraversal (self)

	get_body_of_unprepareTraversal (self)

	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_implementation_of_prepareTraversal (self)
	Return the C++ implementation of prepareTraversal()

	get_implementation_of_unprepareTraversal (self)
	Return the C++ implementation of unprepareTraversal()

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

	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
	tracerDict

Data Fields inherited from peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets
	d

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

	parallel

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"

Protected Attributes inherited from peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets
	_particle_set

Detailed Description

Particle tracing over the DG solver.

Please consult the class FiniteVolumesTracing for details on the semantics of this type. It is an exact analogon for DG.

Update plug-in points

We only update cells which are marked with getHasUpdated(). For enclave solvers, we assume that this flag is only set after a cell has updated. For Runge-Kutta type solvers, I assume that this flag is set by the computation of the final linear combination of estimates.

Definition at line 10 of file DiscontinuousGalerkinTracing.py.

Constructor & Destructor Documentation

◆ init()

tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing.__init__	(	self,
		particle_set,
		solver,
		project_on_tracer_properties_kernel,
		projection_kernel_arguments = `"""marker,{{ORDER}},repositories::{{SOLVER_INSTANCE}}.QuadraturePoints1d,{{NUMBER_OF_UNKNOWNS}}+{{NUMBER_OF_AUXILIARY_VARIABLES}},fineGridCell{{SOLVER_NAME}}Q.value,*p"""`
	)

See also: FiniteVolumesTracing.__init()__.

Reimplemented from peano4.api.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.

Definition at line 31 of file DiscontinuousGalerkinTracing.py.

Member Function Documentation

◆ get_action_set_name()

tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing.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.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.

Definition at line 109 of file DiscontinuousGalerkinTracing.py.

◆ get_attributes()

tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing.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.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.

Definition at line 131 of file DiscontinuousGalerkinTracing.py.

◆ get_includes()

tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing.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.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.

Definition at line 115 of file DiscontinuousGalerkinTracing.py.

◆ user_should_modify_template()

tracer.DiscontinuousGalerkinTracing.DiscontinuousGalerkinTracing.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.toolbox.particles.UpdateParticle_MultiLevelInteraction_Sets.UpdateParticle_MultiLevelInteraction_Sets.

Definition at line 112 of file DiscontinuousGalerkinTracing.py.