Setup phase of the fourth-order Finite Differences with Runge-Kutta time stepping (exahype2.api.rkfd4): sets the initial condition over a regular block-structured mesh and prepares the data required for the first time step. More...

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

[legend]

Collaboration diagram for exahype2.api.rkfd4.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

Protected Attributes
	_solver

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

Detailed Description

Setup phase of the fourth-order Finite Differences with Runge-Kutta time stepping (exahype2.api.rkfd4): sets the initial condition over a regular block-structured mesh and prepares the data required for the first time step.

The mesh is not refined adaptively: setup constructs the regular grid the simulation is going to stay on, fills in the initial condition and projects it onto the faces, where the first Runge-Kutta stage picks it up to reconstruct the halo of each patch.

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.

The class is a copy of exahype2.api.fv.SetupSimulationOverRegularGrid, as rkfd4 does not depend on the Finite Volume package. It works against the data the numerical scheme assigns to the solver: solver._patch, solver._patch_overlap_update and solver._patch_overlap_current_time_step, plus the numerical scheme's patch_size.

Definition at line 14 of file SetupSimulationOverRegularGrid.py.

Constructor & Destructor Documentation

◆ init()

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

Parameters

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

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

Definition at line 40 of file SetupSimulationOverRegularGrid.py.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ construct_output()

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

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

Definition at line 59 of file SetupSimulationOverRegularGrid.py.