Add the Kreiss-Oliger dissipation to the right-hand side of one Runge-Kutta stage. More...

Inheritance diagram for exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation:

[legend]

Collaboration diagram for exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation:

[legend]

Public Member Functions
	__init__ (self, solver, int stage, float sigma, List[int] quantities, str guard)

	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_includes (self)
	The includes cover the kernels the numerical scheme generates (exahype2.api.rkfd4.CentralDifferencesWithRungeKutta), so all action sets can invoke them.

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

Public Member Functions inherited from exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet
	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_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
	stage

	sigma

	quantities

	guard

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 exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet
	_solver

Detailed Description

Add the Kreiss-Oliger dissipation to the right-hand side of one Runge-Kutta stage.

The action set reads the input of the stage with its halo (solver._patch_with_halo) and adds the dissipation to the stage's slot of solver._rhs_estimates via exagrype::ccz4::addKreissOligerDissipation(). It has to run after exahype2.api.rkfd4.actionsets.EvaluateRightHandSide, which overwrites the slot, within the same task. exagrype.api.FD4WithKODissipation arranges this.

Definition at line 11 of file AddKreissOligerDissipation.py.

Constructor & Destructor Documentation

◆ init()

exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.__init__	(		self,
			solver,
		int	stage,
		float	sigma,
		List[int]	quantities,
		str	guard
	)

Parameters

solver	exahype2.api.Solver Has to have an exagrype.api.FD4WithKODissipation as numerical scheme.
stage	int Number of the Runge-Kutta stage, starting with zero.
sigma	float Scaling of the dissipation.
quantities	List[int] Indices of the unknowns which are subject to the dissipation.
guard	str C++ boolean expression, evaluated per cell in touchCellFirstTime.

Reimplemented from exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.

Definition at line 25 of file AddKreissOligerDissipation.py.

References exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.__init__().

Referenced by exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_action_set_name ( self )

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

Reimplemented from exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.

Definition at line 91 of file AddKreissOligerDissipation.py.

◆ get_body_of_operation()

exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.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 53 of file AddKreissOligerDissipation.py.

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

Here is the caller graph for this function:

◆ get_guard_of_operation()

exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.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 80 of file AddKreissOligerDissipation.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()

exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_includes ( self )

The includes cover the kernels the numerical scheme generates (exahype2.api.rkfd4.CentralDifferencesWithRungeKutta), so all action sets can invoke them.

Reimplemented from exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.

Definition at line 88 of file AddKreissOligerDissipation.py.

References exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_includes().

Referenced by exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation.get_includes().

Here is the call graph for this function: