Base class of the action sets of exahype2.api.rkfd4 which work against the solver. More...

Inheritance diagram for exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet:

[legend]

Collaboration diagram for exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet:

[legend]

Public Member Functions
	__init__ (self, solver)

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

	user_should_modify_template (self)
	Is the user allowed to modify the output.

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

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

Protected Attributes
	_solver

Additional Inherited Members
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

Base class of the action sets of exahype2.api.rkfd4 which work against the solver.

It memorises the solver and provides the includes all of these action sets need.

Definition at line 6 of file AbstractRKFD4ActionSet.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.__init__	(	self,
		solver
	)

Parameters

solver exahype2.api.Solver The solver the action set works for.

Reimplemented from peano4.api.solversteps.ActionSet.ActionSet.

Reimplemented in exahype2.api.rkfd4.actionsets.ComputeMaxEigenvalue.ComputeMaxEigenvalue, exahype2.api.rkfd4.actionsets.InitialCondition.InitialCondition, exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation, exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize, exahype2.api.rkfd4.actionsets.EvaluateRightHandSide.EvaluateRightHandSide, exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection, and exahype2.api.rkfd4.actionsets.ComputeLinearCombination.ComputeLinearCombination.

Definition at line 17 of file AbstractRKFD4ActionSet.py.

References exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.__init__().

Referenced by exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ get_action_set_name()

exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.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 peano4.api.solversteps.ActionSet.ActionSet.

Reimplemented in exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation, exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection, exahype2.api.rkfd4.actionsets.ComputeLinearCombination.ComputeLinearCombination, exahype2.api.rkfd4.actionsets.ComputeMaxEigenvalue.ComputeMaxEigenvalue, exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize, exahype2.api.rkfd4.actionsets.EvaluateRightHandSide.EvaluateRightHandSide, and exahype2.api.rkfd4.actionsets.InitialCondition.InitialCondition.

Definition at line 27 of file AbstractRKFD4ActionSet.py.

◆ get_includes()

exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet.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 peano4.api.solversteps.ActionSet.ActionSet.

Reimplemented in exagrype.api.actionsets.AddKreissOligerDissipation.AddKreissOligerDissipation, exahype2.api.rkfd4.actionsets.AddLopsidedAdvection.AddLopsidedAdvection, and exahype2.api.rkfd4.actionsets.ComputeTimeStepSize.ComputeTimeStepSize.

Definition at line 40 of file AbstractRKFD4ActionSet.py.

◆ user_should_modify_template()

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

Definition at line 37 of file AbstractRKFD4ActionSet.py.

Field Documentation

◆ _solver

exahype2.api.rkfd4.actionsets.AbstractRKFD4ActionSet.AbstractRKFD4ActionSet._solver

protected

Definition at line 25 of file AbstractRKFD4ActionSet.py.

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

src/exahype2/api/rkfd4/actionsets/AbstractRKFD4ActionSet.py

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_includes()

◆ user_should_modify_template()

Field Documentation

◆ _solver

◆ init()