Action set determining the final solution using a linear combination of previous Runge-Kutta guesses. More...

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

[legend]

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

[legend]

Public Member Functions
	__init__ (self, solver, guard, FaceProjections face_projections)
	guard_project: String (C++ code) Predicate which controls if the solution is actually projected

	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
	guard

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

	parallel

Static Public Attributes
str	TemplateProject

str	TemplateUpdateFace

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

	_face_projections

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

Detailed Description

Action set determining the final solution using a linear combination of previous Runge-Kutta guesses.

We solve the ODE

\( \partial Q = F(Q) \)

where we have multiple guesses for F according to the Butcher tableau. The final solution can be written down as linear combination over these guesses:

\( Q^{new} = Q^{old} + a_1 \cdot dt \cdot F_1(Q) + a_2 \cdot dt \cdot F_2(Q) + \dots \)

We observe the following simple facts:

The data in fineGridCell{{UNKNOWN_IDENTIFIER}}.value holds \( Q^{old} \)
The data in fineGridCell{{UNKNOWN_IDENTIFIER}}.value shall hold \( Q^{new} \) eventually. We thus can simply add the scaled estimated to it.
The estimates do not alter the auxiliary variables.
We can thus just keep the previous auxiliary variables implicitly.

Face projections

As I discuss in detail in solvers.rkdg.RungeKuttaDG.create_data_structures(), the field _estimate_projection usually holds the projection of a DG estimate, but not the real solution. At some points, I however need the real solution after a time step. Local time stepping for example depends upon it. So the final combination projects the solution again onto the faces.

In return, we could skip the projection within the first Runge-Kutta step where we effectively take the data and write it to the faces once again. But this is too much of an optimisation, I just retrigger the projection there agin.

Definition at line 16 of file ComputeFinalLinearCombination.py.

Constructor & Destructor Documentation

◆ init()

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.__init__	(		self,
			solver,
			guard,
		FaceProjections	face_projections
	)

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 166 of file ComputeFinalLinearCombination.py.

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

Referenced by solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.__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.ComputeFinalLinearCombination.ComputeFinalLinearCombination.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 207 of file ComputeFinalLinearCombination.py.

◆ get_body_of_operation()

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.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 183 of file ComputeFinalLinearCombination.py.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_includes()

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.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 solvers.rkdg.actionsets.AbstractRungeKuttaDGActionSet.AbstractRungeKuttaDGActionSet.

Definition at line 210 of file ComputeFinalLinearCombination.py.

References solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_includes().

Referenced by solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_includes().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ _butcher_tableau

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination._butcher_tableau

protected

Definition at line 179 of file ComputeFinalLinearCombination.py.

Referenced by solvers.rkdg.actionsets.AddVolumeAndFaceSolution.AddVolumeAndFaceSolution.get_body_of_operation(), solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation(), solvers.rkdg.actionsets.HandleBoundary.HandleBoundary.get_body_of_operation(), solvers.rkdg.actionsets.LinearCombinationOfEstimates.LinearCombinationOfEstimates.get_body_of_operation(), solvers.rkdg.actionsets.ProjectLinearCombinationOfEstimatesOntoFaces.ProjectLinearCombinationOfEstimatesOntoFaces.get_body_of_operation(), solvers.rkdg.actionsets.SolveRiemannProblem.SolveRiemannProblem.get_body_of_operation(), and solvers.rkdg.actionsets.SolveVolumeIntegral.SolveVolumeIntegral.get_body_of_operation().

◆ _face_projections

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination._face_projections

protected

Definition at line 180 of file ComputeFinalLinearCombination.py.

Referenced by solvers.rkdg.RungeKuttaDG.RungeKuttaDG.add_to_Peano4_datamodel(), and solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation().

◆ guard

solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.guard

Definition at line 178 of file ComputeFinalLinearCombination.py.

◆ TemplateProject

str solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.TemplateProject

static

Definition at line 55 of file ComputeFinalLinearCombination.py.

Referenced by solvers.rkdg.actionsets.AddVolumeAndFaceSolution.AddVolumeAndFaceSolution.get_body_of_operation(), solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation(), and solvers.rkdg.actionsets.SolveRiemannProblem.SolveRiemannProblem.get_body_of_operation().

◆ TemplateUpdateFace

str solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.TemplateUpdateFace

static

Initial value:

=  """
  if ( repositories::{{SOLVER_INSTANCE}}.isLastGridSweepOfTimeStep() ) {
for (int leftRight=0; leftRight<2; leftRight++) {
  if ( fineGridFace{{SOLVER_NAME}}FaceLabel.getUpdated(leftRight) ) {
    fineGridFace{{SOLVER_NAME}}FaceLabel.setOldTimeStamp( leftRight, fineGridFace{{SOLVER_NAME}}FaceLabel.getNewTimeStamp(leftRight) );
    fineGridFace{{SOLVER_NAME}}FaceLabel.setNewTimeStamp( leftRight, fineGridFace{{SOLVER_NAME}}FaceLabel.getUpdatedTimeStamp(leftRight) );
    
    ::exahype2::dg::copyOneSideOfFaceProjection(
      {{NUMBER_OF_UNKNOWNS}} + {{NUMBER_OF_AUXILIARY_VARIABLES}},
      {{ORDER}},
      {{NUMBER_OF_FACE_PROJECTIONS}},
      marker.getSelectedFaceNumber() % Dimensions,
      leftRight==1,
      fineGridFace{{UNKNOWN_IDENTIFIER}}EstimateProjection.value,
      fineGridFace{{UNKNOWN_IDENTIFIER}}OldSolutionProjection.value
    ); 
  }
}
  }
"""

Definition at line 145 of file ComputeFinalLinearCombination.py.

Referenced by solvers.rkdg.actionsets.ComputeFinalLinearCombination.ComputeFinalLinearCombination.get_body_of_operation().

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

python/exahype2/solvers/rkdg/actionsets/ComputeFinalLinearCombination.py

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Detailed Description

Face projections

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

Field Documentation

◆ _butcher_tableau

◆ _face_projections

◆ guard

◆ TemplateProject

◆ TemplateUpdateFace

◆ init()