mac_donald_shock_benchmark.MacDonaldShockBenchmark Class Reference

Mac Donald's shock benchmark. More...

Inheritance diagram for mac_donald_shock_benchmark.MacDonaldShockBenchmark:

Collaboration diagram for mac_donald_shock_benchmark.MacDonaldShockBenchmark:

Public Member Functions
def	__init__ (self, model, settings)
	Constructor of the benchmark. More...
def	Check (self)
	This method checks if the input values have physical sense. More...
def	ExecuteInitialize (self)
	This method sets the topography, the initial conditions and the upstream/downstream boundary conditions. More...

Public Attributes
	n
	q
	g
	x0
	x100
	h0
	h100
	list_of_bc_processes
	upstream_settings
	downstream_settings

Detailed Description

Mac Donald's shock benchmark.

This is a Mac Donald's type solution with a smooth transition and a shock in a
short domain, with Manning's friction coefficient.

The length of the channel is 100m and the discharge at steady state is q=2m^2/s. The flow
is fluvial both upstream and downstream, the boundary conditions are fixed as follows:
    - upstream: q=2m^2/s
    - downstream: h=h_ex(100)

This process sets the upstream and downstream boundary conditions.

O. Delestre, C. Lucas, P.-A. Ksinant, F. Darboux, C. Laguerre, T.N.T. Vo, F. James, S. Cordier
SWASHES: a compilation of Shallow Water Analytic Solutions for Hydraulic and Environmental Studies
International Journal for Numerical Methods in Fluids, Wiley, 2013, 72 (3), pp.269-300.

Constructor & Destructor Documentation

__init__()

def mac_donald_shock_benchmark.MacDonaldShockBenchmark.__init__	(		self,
			model,
			settings
	)

Constructor of the benchmark.

    The base class validates the settings and sets the model_part, the variables and the benchmark_settings

Member Function Documentation

Check()

def mac_donald_shock_benchmark.MacDonaldShockBenchmark.Check

(

self

)

This method checks if the input values have physical sense.

ExecuteInitialize()

def mac_donald_shock_benchmark.MacDonaldShockBenchmark.ExecuteInitialize

(

self

)

This method sets the topography, the initial conditions and the upstream/downstream boundary conditions.

Member Data Documentation

downstream_settings

mac_donald_shock_benchmark.MacDonaldShockBenchmark.downstream_settings

g

mac_donald_shock_benchmark.MacDonaldShockBenchmark.g

h0

mac_donald_shock_benchmark.MacDonaldShockBenchmark.h0

h100

mac_donald_shock_benchmark.MacDonaldShockBenchmark.h100

list_of_bc_processes

mac_donald_shock_benchmark.MacDonaldShockBenchmark.list_of_bc_processes

n

mac_donald_shock_benchmark.MacDonaldShockBenchmark.n

q

mac_donald_shock_benchmark.MacDonaldShockBenchmark.q

upstream_settings

mac_donald_shock_benchmark.MacDonaldShockBenchmark.upstream_settings

x0

mac_donald_shock_benchmark.MacDonaldShockBenchmark.x0

x100

mac_donald_shock_benchmark.MacDonaldShockBenchmark.x100

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShallowWaterApplication/python_scripts/benchmarks/mac_donald_shock_benchmark.py