Roll over the face data, and set the ghost grid cells along the domain boundary through exahype2.api.SommerfeldBoundaryConditions first. More...

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

[legend]

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

[legend]

Public Member Functions
	__init__ (self, solver, patch_overlap_current_time_step, patch_overlap_update, guard, includes, origin, time_step_size=None)

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

	get_action_set_name (self)
	Return unique action set name.

	get_includes (self)
	Return include statements that you need.

Public Member Functions inherited from exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace
	get_guard_of_operation (self, operation_name)
	Return the guard of an operation.

	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.

Static Public Member Functions
	create_roll_over (solver, exahype2_project, guard, includes, time_step_size=None)
	Create the roll over of the solver's face data.

Static Public Attributes
	TemplateSommerfeldBoundaryConditions

	TemplateInitialGhostCells

Static Public Attributes inherited from exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace
	TemplateHandleFace

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
	_time_step_size

Additional Inherited Members
Data Fields inherited from exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace
	additional_includes

	d

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

	parallel

Detailed Description

Roll over the face data, and set the ghost grid cells along the domain boundary through exahype2.api.SommerfeldBoundaryConditions first.

The action set replaces exahype2.api.rkfd4.actionsets.RollOverUpdatedFace if the solver uses Sommerfeld boundary conditions. Such a solver has no separate boundary task (exahype2.api.rkfd4.actionsets.ApplyDirichletBoundaryConditions). In touchFaceLastTime(), the action set first writes the ghost grid cells into the ghost half of patch_overlap_update, and then rolls over both halves into patch_overlap_current_time_step like RollOverUpdatedFace. Faces within the domain and faces along periodic axes are rolled over unchanged. There are two variants:

With a time_step_size, the action set advances the ghost grid cells through exahype2::blockstructured::applySommerfeldBoundaryConditions(). patch_overlap_current_time_step still holds the old solution, i.e. both its halves are valid, and patch_overlap_update holds the new interior solution. The projection of every Runge-Kutta stage uses this variant: It advances the ghost grid cells from the time stamp of the stage to the one of the next stage, i.e. time_step_size is \( (c_{k+1}-c_k) \\Delta t \), or \( (1-c_{s-1}) \\Delta t \) after the last stage (exahype2.api.rkfd4.CentralDifferencesWithRungeKutta).
Without a time_step_size, the action set initialises the ghost grid cells with the initial condition, i.e. it evaluates the solver's initPointWisely() at their centres through exahype2::blockstructured::applyDirichletBoundaryConditions(). The grid construction uses this variant, so the first time step finds valid ghost grid cells.

The C++ header documents the conditions, their discretisation and why they replace the roll over. The class mirrors exahype2.api.fv.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions, as rkfd4 does not depend on the Finite Volume package.

Definition at line 11 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.__init__	(	self,
		solver,
		patch_overlap_current_time_step,
		patch_overlap_update,
		guard,
		includes,
		origin,
		time_step_size = `None`
	)

Parameters

solver	exahype2.api.Solver The solver whose maxEigenvalue(), sommerfeldFarFieldSolution() and initPointWisely() are invoked.
patch_overlap_current_time_step	peano4.api.datamodel.Patch

See also: RollOverUpdatedFace.

Parameters

patch_overlap_update peano4.api.datamodel.Patch

See also: RollOverUpdatedFace.

Parameters

guard str

See also: RollOverUpdatedFace.

Parameters

includes str

See also: RollOverUpdatedFace.

Parameters

origin	List[float] Centre of the system, one entry per dimension, exahype2.api.blockstructured.SommerfeldBoundaryConditions.SommerfeldBoundaryConditions.get_origin().
time_step_size	str C++ expression for the time step size by which the ghost grid cells are advanced, or None to initialise the ghost grid cells with the initial condition instead.

Reimplemented from exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.

Definition at line 100 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ create_roll_over()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.create_roll_over	(	solver,
		exahype2_project,
		guard,
		includes,
		time_step_size = `None`
	)

static

Create the roll over of the solver's face data.

Returns: RollOverUpdatedFace RollOverUpdatedFaceWithSommerfeldBoundaryConditions if the solver uses exahype2.api.SommerfeldBoundaryConditions, and a plain RollOverUpdatedFace otherwise, i.e. for Dirichlet boundary conditions or a domain without boundary.

Parameters

solver	exahype2.api.Solver The solver whose solver._patch_overlap_update is rolled over into solver._patch_overlap_current_time_step. Its boundary condition terms have to be consistent with the domain, exahype2.api.blockstructured.BoundaryConditions.get_boundary_conditions().
exahype2_project	exahype2.api.Project Provides the periodic boundary conditions.
guard	str

See also: RollOverUpdatedFace.

Parameters

includes str

See also: RollOverUpdatedFace.

Parameters

time_step_size str

See also: the constructor. Ignored for a plain RollOverUpdatedFace.

Definition at line 175 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

◆ get_action_set_name()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_action_set_name ( self )

Return unique action set name.

Returns a description (word) for the mapping which is also used as class name for the generated type. As a consequence, the result should be one word (if possible) and uppercase. Also, every subclass should overwrite this routine.

The generator will take the result and construct eventually classes similar to MyStep2Dummy.h and MyStep2Dummy.cpp or similar for the example below, where we return Dummy.

Reimplemented from exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.

Definition at line 162 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

◆ get_body_of_operation()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.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 exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.

Definition at line 148 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

Referenced by exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation(), and 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()

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.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 exahype2.api.rkfd4.actionsets.RollOverUpdatedFace.RollOverUpdatedFace.

Definition at line 165 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

References exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_includes().

Referenced by exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_includes().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ _time_step_size

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions._time_step_size

protected

Definition at line 141 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

Referenced by exahype2.api.fv.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation(), and exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation().

◆ TemplateInitialGhostCells

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.TemplateInitialGhostCells

static

Initial value:

=  jinja2.Template(
        
    )

Definition at line 81 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

Referenced by exahype2.api.fv.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation(), and exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation().

◆ TemplateSommerfeldBoundaryConditions

exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.TemplateSommerfeldBoundaryConditions

static

Initial value:

=  jinja2.Template(
        
    )

Definition at line 50 of file RollOverUpdatedFaceWithSommerfeldBoundaryConditions.py.

Referenced by exahype2.api.fv.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation(), and exahype2.api.rkfd4.actionsets.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.RollOverUpdatedFaceWithSommerfeldBoundaryConditions.get_body_of_operation().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ create_roll_over()

◆ get_action_set_name()

◆ get_body_of_operation()

◆ get_includes()

Field Documentation

◆ _time_step_size

◆ TemplateInitialGhostCells

◆ TemplateSommerfeldBoundaryConditions

◆ init()