Solve volume integral. More...

Inheritance diagram for solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral:

[legend]

Collaboration diagram for solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral:

[legend]

Public Member Functions
	__init__ (self, solver, spawn_volume_kernel_as_task=False)
	guard_project: String (C++ code) Predicate which controls if the solution is actually projected.

	guards (self)

	guards (self, new_guards)

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

	get_action_set_name (self)
	You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet
	user_should_modify_template (self)
	Is the user allowed to modify the output.

Public Member Functions inherited from peano4.api.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_createGridControlEventsForNextTraversal (self)
	Return the grid control events that this action set wants to trigger.

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

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

Data Fields
	guards

	spawn_volume_kernel_as_task

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

	parallel

Static Public Attributes
str	TemplateCellKernel

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
	_butcher_tableau

	_guards

Protected Attributes inherited from solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet
	_solver

Detailed Description

Solve volume integral.

Solve the volumetric part of the DG method. This includes the evaluation of the volume integral of the operator multiplied with a trial function, plus the subsequent multiplication with an inverted (lumped) mass matrix. So, eventually, we do an explicit Euler step subject to a relaxed time step size from the Butcher tableau. The input is already properly computed (see LinearCombinationOfEstimates()).

The volume integral definition is an underdetermined action set, i.e., you still have to ensure that a number of macros are actually defined when you use it:

{{COMPUTE_TIME_STEP_SIZE}} has to specify a double timeStepSize. It may be const if you want. I don't alter it.

In return, the following variables will be set by the action set:

timeStampOldSolution: double This is the time stamp of the original solution, i.e. not the one we are currently evaluating due to the Runge-Kutta scheme.
timeStamp: double This is the time stamp of the current Runge Kutta guess. It is timeStampOldSolution plus the weight of the Butcher scheme times the time step size.
QIn: double* A pointer to the actual linear combination of previous guesses according to the Butcher tableau.
QOut: For Runge-Kutta, we ahve to store all guesses of the future solution, so we can eventually combine them into one final outcome. QOut points to that segment/guess that's to be computed in this step.

Definition at line 13 of file SolveVolumeIntegral.py.

Constructor & Destructor Documentation

◆ init()

solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.__init__	(	self,
		solver,
		spawn_volume_kernel_as_task = `False`
	)

guard_project: String (C++ code) Predicate which controls if the solution is actually projected.

guard_safe_old_time_step: String (C++ code) Predicate which controls if the projection should be copied into the old solution and the time step should also be moved over.

Reimplemented from solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 141 of file SolveVolumeIntegral.py.

References solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.__init__().

Referenced by solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.get_action_set_name ( self )

You should replicate this function in each subclass, so you get meaningful action set names (otherwise, it will be AbstractFVActionSet0,1,2,...).

Reimplemented from solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 185 of file SolveVolumeIntegral.py.

◆ get_body_of_operation()

solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.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 170 of file SolveVolumeIntegral.py.