Update a Finite Volume patch (solver._patch) from its halo-augmented reconstruction (solver._patch_with_halo, see toolbox.blockstructured.api.ReconstructPatchWithHalo) by applying the solver's numerical scheme (Rusanov flux, explicit Euler time stepping) once per volume. More...

Inheritance diagram for exahype2.api.fv.actionsets.UpdateCell.UpdateCell:

[legend]

Collaboration diagram for exahype2.api.fv.actionsets.UpdateCell.UpdateCell:

[legend]

Public Member Functions
	__init__ (self, solver, guard, max_eigenvalue=None)

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

Public Member Functions inherited from exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	user_should_modify_template (self)
	Is the user allowed to modify the output.

	get_includes (self)
	Return include statements that you need.

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
	guard

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

	parallel

Protected Attributes
	_max_eigenvalue

Protected Attributes inherited from exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet
	_solver

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"

Detailed Description

Update a Finite Volume patch (solver._patch) from its halo-augmented reconstruction (solver._patch_with_halo, see toolbox.blockstructured.api.ReconstructPatchWithHalo) by applying the solver's numerical scheme (Rusanov flux, explicit Euler time stepping) once per volume.

Global time stepping: all cells share one time stamp and time step size, which are taken from the solver (getMinTimeStamp() and getMinTimeStepSize()) rather than from per-cell bookkeeping.

The compute kernel returns the maximum eigenvalue over the patch it has just updated. The action set stores it in the cell data solver._max_eigenvalue. exahype2.api.fv.actionsets.ComputeGlobalCFLCondition reduces these values in a subsequent mesh traversal and derives the next time step size from them.

Definition at line 8 of file UpdateCell.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.fv.actionsets.UpdateCell.UpdateCell.__init__	(	self,
		solver,
		guard,
		max_eigenvalue = `None`
	)

Parameters

solver exahype2.api.Solver Has to have solver._patch, solver._patch_with_halo and solver._max_eigenvalue set -

See also: exahype2.api.fv.RusanovWithExplicitEuler.

Parameters

guard str C++ boolean expression, evaluated per cell in touchCellFirstTime, guarding whether that cell's patch is updated. Typically the output of the solver's grid_selector (

See also: peano4.api.toolbox.GridSelector).

Parameters

max_eigenvalue peano4.api.datamodel.DaStGen2 The cell data the maximum eigenvalue goes into (first entry). Defaults to solver._max_eigenvalue.

Reimplemented from exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 29 of file UpdateCell.py.

Member Function Documentation

◆ get_action_set_name()

exahype2.api.fv.actionsets.UpdateCell.UpdateCell.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 exahype2.api.fv.actionsets.AbstractFVActionSet.AbstractFVActionSet.

Definition at line 70 of file UpdateCell.py.

◆ get_body_of_operation()

exahype2.api.fv.actionsets.UpdateCell.UpdateCell.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 52 of file UpdateCell.py.

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

Here is the caller graph for this function:

◆ get_guard_of_operation()

exahype2.api.fv.actionsets.UpdateCell.UpdateCell.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 65 of file UpdateCell.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:

Field Documentation

◆ _max_eigenvalue

exahype2.api.fv.actionsets.UpdateCell.UpdateCell._max_eigenvalue

protected

Definition at line 50 of file UpdateCell.py.

◆ guard

exahype2.api.fv.actionsets.UpdateCell.UpdateCell.guard

Definition at line 49 of file UpdateCell.py.

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

src/exahype2/api/fv/actionsets/UpdateCell.py

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_guard_of_operation()

Field Documentation

◆ _max_eigenvalue

◆ guard

◆ init()