scenarios.swe_resting_lake.SWERestingLake Class Reference

Resting lake scenario for the shallow water equations. More...

Inheritance diagram for scenarios.swe_resting_lake.SWERestingLake:

Collaboration diagram for scenarios.swe_resting_lake.SWERestingLake:

Public Member Functions
	__init__ (self, initial_conditions="sinusoidal")
	initial_conditions (self)
	analytical_solution (self)
Public Member Functions inherited from scenarios.scenario.Scenario
	boundary_conditions (self)
	refinement_criterion (self)
	set_global_simulation_parameters (self, project)

Protected Attributes
	_init

Static Protected Attributes
float	_plot_dt = 0.0
float	_offset = -0.5
float	_domain_size = 1.0
bool	_periodic_bc = True
int	_dimensions = 2
	_equation = SWE_W_Bathymetry()
float	_end_time = 1.0
Static Protected Attributes inherited from scenarios.scenario.Scenario
	_equation = None
int	_dimensions = 2
float	_end_time = 1.0
float	_plot_dt = 0.1
float	_offset = 0.0
float	_domain_size = 1.0
bool	_periodic_bc = False

Detailed Description

Resting lake scenario for the shallow water equations.

The real water height H as defined by the sum of the water column h and the bathymetry b is constant over the entire domain, meaning that there should be no changes on the entire domain, but because we use the sum of the derivatives of h and b (h' + b') instead of the derivative of the sum (h + b)' some rounding errors will creep in, which causes unphysical waves to appear. As such this scenario is nice for testing how large these unphysical waves are for a given algorithm, and how stable the algorithm is, i.e. does it dampen out these waves or do they oscillate out of control.

Definition at line 33 of file swe_resting_lake.py.

Constructor & Destructor Documentation

__init__()

scenarios.swe_resting_lake.SWERestingLake.__init__	(		self,
			initial_conditions = "sinusoidal"
	)

Definition at line 55 of file swe_resting_lake.py.

Member Function Documentation

analytical_solution()

scenarios.swe_resting_lake.SWERestingLake.analytical_solution

(

self

)

Reimplemented from scenarios.scenario.Scenario.

Definition at line 64 of file swe_resting_lake.py.

initial_conditions()

scenarios.swe_resting_lake.SWERestingLake.initial_conditions

(

self

)

Reimplemented from scenarios.scenario.Scenario.

Definition at line 61 of file swe_resting_lake.py.

References scenarios.swe_resting_lake.SWERestingLake._init.

Referenced by plot_celldepth_benchmarks.BenchmarkData._read_logfile().

Here is the caller graph for this function:

Field Documentation

_dimensions

int scenarios.swe_resting_lake.SWERestingLake._dimensions = 2

staticprotected

Definition at line 51 of file swe_resting_lake.py.

Referenced by exaparty.api.Project.Project.__configure_makefile(), api.Project.Project.__configure_makefile(), exaparty.api.Project.Project.__export_constants(), api.Project.Project.__export_constants(), exahype2.api.Project.Project.__export_constants(), api.Project.Project.__init__(), solvers.api.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi.ContinuousGalerkinDiscretisationGaussLobattoWithBlockJacobi._construct_narrow_to_interior_matrix(), scenarios.elastic_planar_waves.ElasticPlanarWaves.analytical_solution(), tarch.plotter.api.output.Visualiser.PatchFileData.apply_renderer_to_data(), exahype2.api.dslhype.SyntaxTree.Matrix.index(), scenarios.elastic_planar_waves.ElasticPlanarWaves.initial_conditions(), exahype2.api.dslhype.SyntaxTree.TSimpleMemref.print_mlir(), exahype2.api.dslhype.SyntaxTree.TDataBlock.print_mlir(), exaparty.api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), exahype2.api.Project.Project.set_global_simulation_parameters(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_domain_size

float scenarios.swe_resting_lake.SWERestingLake._domain_size = 1.0

staticprotected

Definition at line 49 of file swe_resting_lake.py.

Referenced by exaparty.api.Project.Project.__export_constants(), api.Project.Project.__export_constants(), exahype2.api.Project.Project.__export_constants(), api.Project.Project.__init__(), api.Tree.Tree.__str__(), api.Project.Project.generate_Peano4_project(), exaparty.api.Project.Project.real_mesh_size(), exaparty.api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), api.Project.Project.set_global_simulation_parameters(), exahype2.api.Project.Project.set_global_simulation_parameters(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_end_time

float scenarios.swe_resting_lake.SWERestingLake._end_time = 1.0

staticprotected

Definition at line 53 of file swe_resting_lake.py.

Referenced by scenarios.scenario.Scenario.set_global_simulation_parameters().

_equation

scenarios.swe_resting_lake.SWERestingLake._equation = SWE_W_Bathymetry()

staticprotected

Definition at line 52 of file swe_resting_lake.py.

_init

scenarios.swe_resting_lake.SWERestingLake._init

protected

Definition at line 59 of file swe_resting_lake.py.

Referenced by scenarios.swe_resting_lake.SWERestingLake.initial_conditions().

_offset

float scenarios.swe_resting_lake.SWERestingLake._offset = -0.5

staticprotected

Definition at line 48 of file swe_resting_lake.py.

Referenced by exahype2.api.dslhype.SyntaxTree.DataBlock.linearise_index(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_periodic_bc

bool scenarios.swe_resting_lake.SWERestingLake._periodic_bc = True

staticprotected

Definition at line 50 of file swe_resting_lake.py.

Referenced by scenarios.scenario.Scenario.boundary_conditions(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_plot_dt

float scenarios.swe_resting_lake.SWERestingLake._plot_dt = 0.0

staticprotected

Definition at line 47 of file swe_resting_lake.py.

Referenced by scenarios.scenario.Scenario.set_global_simulation_parameters().

---

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

• tests/exahype2/aderdg/scenarios/swe_resting_lake.py