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 Member Functions
	_initial_conditions (self, Q)

Protected Attributes
	_scenario

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 11 of file swe_resting_lake.py.

Constructor & Destructor Documentation

__init__()

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

Definition at line 33 of file swe_resting_lake.py.

Member Function Documentation

_initial_conditions()

scenarios.swe_resting_lake.SWERestingLake._initial_conditions ( self, Q )

protected

Definition at line 39 of file swe_resting_lake.py.

Referenced by scenarios.swe_resting_lake.SWERestingLake.analytical_solution(), and scenarios.swe_resting_lake.SWERestingLake.initial_conditions().

Here is the caller graph for this function:

analytical_solution()

scenarios.swe_resting_lake.SWERestingLake.analytical_solution

(

self

)

Reimplemented from scenarios.scenario.Scenario.

Definition at line 65 of file swe_resting_lake.py.

References scenarios.swe_resting_lake.SWERestingLake._initial_conditions(), and scenarios.swe_resting_lake.SWERestingLake._scenario.

Referenced by scenarios.navier_stokes_abc_flow.NavierStokesABCFlow.initial_conditions(), and scenarios.navier_stokes_taylor_green_vortex.NavierStokesTaylorGreenVortex.initial_conditions().

Here is the call graph for this function:

Here is the caller graph for this function:

initial_conditions()

scenarios.swe_resting_lake.SWERestingLake.initial_conditions

(

self

)

Reimplemented from scenarios.scenario.Scenario.

Definition at line 62 of file swe_resting_lake.py.

References scenarios.swe_resting_lake.SWERestingLake._initial_conditions(), and scenarios.swe_resting_lake.SWERestingLake._scenario.

Here is the call graph for this function:

Field Documentation

_dimensions

int scenarios.swe_resting_lake.SWERestingLake._dimensions = 2

staticprotected

Definition at line 29 of file swe_resting_lake.py.

Referenced by scenarios.elastic_planar_waves.ElasticPlanarWaves.analytical_solution(), scenarios.elastic_planar_waves.ElasticPlanarWaves.initial_conditions(), and scenarios.scenario.Scenario.set_global_simulation_parameters().

_domain_size

float scenarios.swe_resting_lake.SWERestingLake._domain_size = 1.0

staticprotected

Definition at line 27 of file swe_resting_lake.py.

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

_end_time

float scenarios.swe_resting_lake.SWERestingLake._end_time = 1.0

staticprotected

Definition at line 31 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 30 of file swe_resting_lake.py.

Referenced by scenarios.navier_stokes_bubbles.NavierStokesBubbles.boundary_conditions(), and scenarios.navier_stokes_bubbles.NavierStokesBubbles.mapQuantities().

_offset

float scenarios.swe_resting_lake.SWERestingLake._offset = -0.5

staticprotected

Definition at line 26 of file swe_resting_lake.py.

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

_periodic_bc

bool scenarios.swe_resting_lake.SWERestingLake._periodic_bc = True

staticprotected

Definition at line 28 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 25 of file swe_resting_lake.py.

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

_scenario

scenarios.swe_resting_lake.SWERestingLake._scenario

protected

Definition at line 37 of file swe_resting_lake.py.

Referenced by scenarios.swe_resting_lake.SWERestingLake.analytical_solution(), and scenarios.swe_resting_lake.SWERestingLake.initial_conditions().

---

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

• tests/aderdg/scenarios/swe_resting_lake.py