Setup phase counterpart to RusanovWithExplicitEuler: sets the initial condition for a Finite Volume scheme with a Rusanov Riemann solver, realised over a block-structured mesh, and prepares the data required for the first time step. More...

Inheritance diagram for exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid:

[legend]

Collaboration diagram for exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid:

[legend]

Public Member Functions
	__init__ (self, Solver solver, float volume_size)

	construct_output (self, exahype2_project, peano_project, setup_simulation)
	Create the actual sequence of tasks following the description from Adding a numerical scheme, as grid construction, numerical scheme, but also plotting all follow the same pattern of tasks and dependencies.

Data Fields
	volume_size

	FinishedInitialRegularMeshSetup

Static Public Attributes
str	FinishedInitialRegularMeshSetup = "exahype2.api.fv.SetupSimulationOverRegularGrid.FinishedInitialRegularMeshSetup"
	Tag of the task which completes the setup over the initial regular mesh.

Protected Member Functions
	_construct_task_graph (self, exahype2_project, peano_project, setup_simulation)
	Add the tasks of the setup over a regular mesh to setup_simulation.

	_report_task_graph (self, setup_simulation)
	Visualise or log the setup task graph, depending on the logger's verbosity.

Protected Attributes
	_solver
	On adaptive meshes, restrict the fine data from the hanging faces onto the coarse faces.

Protected Attributes inherited from exahype2.api.Solver.Solver.GridConstruction
	_solver

Detailed Description

Setup phase counterpart to RusanovWithExplicitEuler: sets the initial condition for a Finite Volume scheme with a Rusanov Riemann solver, realised over a block-structured mesh, and prepares the data required for the first time step.

Unlike SetupSimulationWithUserCodedRefinementCriterion, this variant does not refine the mesh at all: it assumes the mesh is already the regular grid it is going to stay, so setup only has to fill in the initial condition and project it onto the faces.

The solver this is attached to has to have an exahype2.api.InitPointWisely PDE term registered (via solver.add_pde_term(...)), as that is what fills in the initial condition this class' setup task graph relies on; construct_output() asserts this before it builds anything.

Definition at line 14 of file SetupSimulationOverRegularGrid.py.

Constructor & Destructor Documentation

◆ init()

exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.__init__	(		self,
		Solver	solver,
		float	volume_size
	)

Parameters

volume_size float Maximum edge length of one Finite Volume. Every mesh cell hosts one patch of patch_size volumes per axis. The setup refines every cell whose edge length is greater than or equal to volume_size times the patch size (peano4.api.actionsets.ConstructRegularGrid), i.e. the resulting volumes are strictly smaller than volume_size. If you want volumes of exactly 1/27 with patches of size 9, pass in a value slightly bigger than 1/27: 1/27 itself yields cells of size 1/9 and hence volumes of size 1/81.

Reimplemented from exahype2.api.Solver.Solver.GridConstruction.

Reimplemented in exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.

Definition at line 48 of file SetupSimulationOverRegularGrid.py.

References exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.__init__().

Referenced by exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.__init__().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ _construct_task_graph()

exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._construct_task_graph	(	self,
		exahype2_project,
		peano_project,
		setup_simulation
	)

protected

Add the tasks of the setup over a regular mesh to setup_simulation.

The initial condition task carries the tag FinishedInitialRegularMeshSetup.

Definition at line 86 of file SetupSimulationOverRegularGrid.py.

Referenced by exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.construct_output(), and exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.construct_output().

Here is the caller graph for this function:

◆ _report_task_graph()

exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._report_task_graph	(	self,
		setup_simulation
	)

protected

Visualise or log the setup task graph, depending on the logger's verbosity.

Definition at line 212 of file SetupSimulationOverRegularGrid.py.

Referenced by exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.construct_output().

Here is the caller graph for this function:

◆ construct_output()

exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.construct_output	(	self,
		exahype2_project,
		peano_project,
		setup_simulation
	)

Create the actual sequence of tasks following the description from Adding a numerical scheme, as grid construction, numerical scheme, but also plotting all follow the same pattern of tasks and dependencies.

The routine first builds the task graph through _construct_task_graph() and then reports it through _report_task_graph().

Reimplemented from exahype2.api.Solver.Solver.GridConstruction.

Reimplemented in exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion.SetupSimulationWithUserCodedRefinementCriterion.

Definition at line 67 of file SetupSimulationOverRegularGrid.py.

References exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._construct_task_graph(), and exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._report_task_graph().

Here is the call graph for this function:

Field Documentation

◆ _solver

exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid._solver

protected

On adaptive meshes, restrict the fine data from the hanging faces onto the coarse faces.

Only numerical schemes which support adaptive meshes offer this restriction

Sommerfeld boundary conditions initialise the ghost volumes with the initial condition (exahype2.api.blockstructured.BoundaryConditions)

Definition at line 174 of file SetupSimulationOverRegularGrid.py.

◆ FinishedInitialRegularMeshSetup [1/2]

str exahype2.api.fv.SetupSimulationOverRegularGrid.SetupSimulationOverRegularGrid.FinishedInitialRegularMeshSetup = "exahype2.api.fv.SetupSimulationOverRegularGrid.FinishedInitialRegularMeshSetup"

static

Tag of the task which completes the setup over the initial regular mesh.

The setup constructs the regular mesh and then sets the initial condition. The initial condition task carries this tag. After it, the mesh and the solution are complete, but the solution has not yet been projected onto the faces, as the projection is the very last task of the setup. Subclasses which want to modify the mesh or the solution before the time stepping starts search for the tag via peano4.api.taskgraph.Graph.find_tasks() and insert their tasks after the tagged one via peano4.api.taskgraph.Graph.insert_after(). The tasks which have followed the tagged task so far, i.e. the projection, then follow the inserted tasks (exahype2.api.fv.SetupSimulationWithUserCodedRefinementCriterion).

Definition at line 46 of file SetupSimulationOverRegularGrid.py.