Swashes PDF

Documentation
of
SWASHES
v1.03.00 (2016-01-29)
Generated by Doxygen 1.8.10

on Fri Jan 29 2016 16:15:04
Chapter 1
Todo List
Member Choice_solution::Choice_solution (Parameters &)

Exceptions should be treated.
1
2 CHAPTER 1. TODO LIST
Chapter 2
Hierarchical Index
2.1 Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:
Choice_solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Bedload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Bump . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Dam_break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Dressler_dam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Inclined_plane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
MacDonald_like . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
MacDonald_like_diffus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
MacDonaldB1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
MacDonaldB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Sampson . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Selfsimilar_dam_break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Swash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Thacker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Thacker2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Swash_solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
3
4 CHAPTER 2. HIERARCHICAL INDEX
Chapter 3
Class Index
3.1 Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
Bedload
Computes solutions with bedload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Bump
Computes bump solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Choice_solution
Choice of the solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Dam_break
Computes dam break solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Dressler_dam
Computes Dressler dam break solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Inclined_plane
Computes the solutions over an inclined plane . . . . . . . . . . . . . . . . . . . . . . . . . 20
MacDonald_like
Computes Mac Donald solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
MacDonald_like_diffus
Computes Mac Donald solutions with diffusion . . . . . . . . . . . . . . . . . . . . . . . . . 25
MacDonaldB1
Computes Mac Donald pseudo 2d solutions . . . . . . . . . . . . . . . . . . . . . . . . . . 27
MacDonaldB2
Parameters
Gets parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Sampson
Computes Sampson solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Selfsimilar_dam_break
Computes self-similar dam break solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Solution
Analytic solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Swash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Swash_solution
Computes the solutions of the swash over an inclined plane . . . . . . . . . . . . . . . . . . 46
Thacker
Computes Thacker solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Thacker2D
Computes Thacker solutions in 2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
5
6 CHAPTER 3. CLASS INDEX
Chapter 4
File Index
4.1 File List
Here is a list of all files with brief descriptions:

Headers/bedload.hpp
Headers/bump.hpp
Computes bumps solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Headers/choice_solution.hpp
Headers/dam_break.hpp
Headers/dressler_dam.hpp
Headers/inclined_plane.hpp
Computes the solution over an inclined plane . . . . . . . . . . . . . . . . . . . . . . . . . 55
Headers/macdonald_like.hpp
Headers/macdonald_like_diffus.hpp
Headers/macdonaldb1.hpp
Headers/macdonaldb2.hpp
Headers/misc.hpp
Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Headers/parameters.hpp
Gets parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Headers/sampson.hpp
Headers/selfsimilar_dam_break.hpp
Headers/solution.hpp
Common file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Headers/swash.hpp
Headers/thacker.hpp
Headers/thacker2d.hpp
Computes Thacker solutions in 2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
7
8 CHAPTER 4. FILE INDEX
Sources/bedload.cpp
Sources/bump.cpp
Computes bumps solutions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Sources/choice_solution.cpp
Sources/dam_break.cpp
Sources/dressler_dam.cpp
Sources/inclined_plane.cpp
Computes the solution over an inclined plane . . . . . . . . . . . . . . . . . . . . . . . . . 67
Sources/macdonald_like.cpp
Sources/macdonald_like_diffus.cpp
Sources/macdonaldb1.cpp
Sources/macdonaldb2.cpp
Sources/parameters.cpp
Gets parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Sources/sampson.cpp
Sources/selfsimilar_dam_break.cpp
Sources/solution.cpp
Common file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Sources/swash.cpp
Sources/swashes.cpp
Main file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Sources/thacker.cpp
Sources/thacker2d.cpp
Computes Thacker solution in 2D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Chapter 5
Class Documentation
5.1 Bedload Class Reference

Computes solutions with bedload.
#include <bedload.hpp>
Inheritance diagram for Bedload:
Solution
Bedload
Public Member Functions

• Bedload (Parameters &)
Constructor.
• virtual ∼Bedload ()
Destructor.
• void compute ()
Computes the solution.
• void param (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR,
SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const
Writes the parameters of the solution.
• void paramwarning () const
Writes a warning about the the solution.
Additional Inherited Members
5.1.1 Detailed Description

Class that computes the solutions where the bed is moving with bedload, see Berthon et al. [2012].
Definition at line 70 of file bedload.hpp.
5.1.2 Constructor & Destructor Documentation

Bedload::Bedload ( Parameters & par )
Constructor.
Defines the physical parameters, the final time and prints the header with the configuration.
9
10 CHAPTER 5. CLASS DOCUMENTATION
Parameters
in par contains all the values from the parameters
Warning
Problem: allocation of z0 failed
Modifies
Solution::dx_ex, Solution::L, Solution::T, Solution::xex.
Note
If the vector z0 cannot be allocated, the code will exit with failure termination code.
Definition at line 59 of file bedload.cpp.
Bedload::∼Bedload ( ) [virtual]
Destructor.
5.1.3 Member Function Documentation

void Bedload::compute ( ) [virtual]

Computes the chosen bedload solution, see Berthon et al. [2012].
Modifies
Solution::hex, Solution::uex, Solution::zex.
Implements Solution.
void Bedload::param ( SCALAR L, SCALAR dx_ex, SCALAR T, SCALAR uexl, SCALAR hexl,
SCALAR z0l, SCALAR zexl, SCALAR uexr, SCALAR hexr, SCALAR z0r, SCALAR zexr, SCALAR
alpha, SCALAR beta, SCALAR A, SCALAR q, SCALAR C, SCALAR p ) const

Parameters
in L length of the domain
in dx_ex space step
in T final time
in uexl value of the velocity on the left boundary
in hexl value of the water height on the left boundary
in z0l value of the inital topography on the left boundary
in zexl value of the final topography on the left boundary
in uexr value of the velocity on the right boundary
5.2. BUMP CLASS REFERENCE 11
in hexr value of the water height on the right boundary

in z0r value of the inital topography on the right boundary
in zexr value of the final topography on the right boundary
in alpha parameter for Exner equation
in beta parameter for Exner equation
in A parameter for Exner equation
in q parameter for Exner equation
in C parameter for Exner equation
in p parameter for Exner equation
void Bedload::paramwarning ( ) const
Writes a warning about the the solution.
Warning
WARNING: to compare your numerical result to this solution, you must be able to remove friction from the
Shallow-Water part (see doc).

The documentation for this class was generated from the following files:
• Headers/bedload.hpp
• Sources/bedload.cpp
5.2 Bump Class Reference

Computes bump solutions.
#include <bump.hpp>
Inheritance diagram for Bump:
Solution
Bump

• Bump (Parameters &)
Constructor.
• virtual ∼Bump ()
Destructor.
• void compute ()
• SCALAR p (SCALAR, SCALAR, SCALAR) const
Coefficient p for Cardano method.
• SCALAR q (SCALAR, SCALAR, SCALAR, SCALAR) const
Coefficient q for Cardano method.
• SCALAR determinant (SCALAR, SCALAR) const
Determinant for Cardano method.
• SCALAR height (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Computation of the 3rd order polynomia roots.
• void abcd (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR &, SCALAR &, SCALAR &, SCALAR &)
Defines a, b, c, d in order to solve ah3 + bh2 + ch + d .
• SCALAR RHJump (SCALAR, SCALAR, SCALAR) const
Steady state RH relation.
• void param (SCALAR, SCALAR) const

Class that computes the solutions with a bump for the topography, see Delestre et al. [2013] and Goutal and
Maurel [1997].
Definition at line 71 of file bump.hpp.

Bump::Bump ( Parameters & par )
Constructor.
Defines the physical parameters and prints the header with the configuration.
The solution is saved at the steady state.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::zex to have the bump configuration.
Definition at line 60 of file bump.cpp.
Bump::∼Bump ( ) [virtual]
Destructor.

void Bump::abcd ( SCALAR q_in, SCALAR h_out, SCALAR zbx, SCALAR zbfin, SCALAR & a,
SCALAR & b, SCALAR & c, SCALAR & d )

Enters the coefficients of the 3rd order polynomia we want to solve: ah3 + bh2 + ch + d .
Parameters
in q_in inflow discharge
in h_out water height at the outflow
5.2. BUMP CLASS REFERENCE 13
in zbx bottom topography of the current cell

in zbfin bottom topography at the outflow
out a coefficient of the 3rd order polynomia
out b coefficient of the 3rd order polynomia
out c coefficient of the 3rd order polynomia
out d coefficient of the 3rd order polynomia
void Bump::compute ( ) [virtual]

Computes the chosen bump solution, see Delestre et al. [2013] and Goutal and Maurel [1997].
Modifies
Solution::hex.
SCALAR Bump::determinant ( SCALAR p, SCALAR q ) const

Determinant in the Cardano method/related to number of roots.
Parameters
in p computed by Bump::p
in q computed by Bump::q
Returns
4 3
Value of q2 + 27 p .
SCALAR Bump::height ( SCALAR p, SCALAR q, SCALAR a, SCALAR b, SCALAR hnear ) const

Parameters
in p computed by Bump::p
in q computed by Bump::q
in a coefficient of the 3rd order polynomia
in b coefficient of the 3rd order polynomia
in hnear height of the previous or following cell (depending on the height computation
direction)
Warning
Error: no positive height.

Error: Probably irregular solution.
Returns
h, the water height.

SCALAR Bump::p ( SCALAR a, SCALAR b, SCALAR c ) const

Parameters
in c coefficient of the 3rd order polynomia
Returns
b2 c
Value of − 2
+ .
3a a
void Bump::param ( SCALAR L, SCALAR dx_ex ) const

Parameters
in dx_ex space step
SCALAR Bump::q ( SCALAR a, SCALAR b, SCALAR c, SCALAR d ) const

Parameters
in d coefficient of the 3rd order polynomia
Returns
2b2

b c
Value of −9 .
27a a2 a
SCALAR Bump::RHJump ( SCALAR hplus, SCALAR hminus, SCALAR q ) const
Steady state RH relation.

Parameters
in hplus water height on the right side
in hminus water height on the left side
in q discharge
Returns

1 1 g
Value of q2 hplus − hminus + 2 hplus2 − hminus2 .


• Headers/bump.hpp
• Sources/bump.cpp
5.3. CHOICE_SOLUTION CLASS REFERENCE 15
5.3 Choice_solution Class Reference

Choice of the solution.
#include <choice_solution.hpp>

• Choice_solution (Parameters &)
Constructor.
• void compute ()
• virtual ∼Choice_solution ()
Destructor.

Class that calls the chosen solution.
Definition at line 130 of file choice_solution.hpp.

Choice_solution::Choice_solution ( Parameters & par )
Constructor.
Parameters
in par contains all the values from the parameter
Warning
Error: the dimension is ∗∗∗

This ∗∗∗ solution for L=∗∗∗ does not exist!
∗∗∗ solutions for the domain ∗∗∗ do not exist!
Note
If the solution does not exists, the code will exit with failure termination code.
Todo Exceptions should be treated.
Definition at line 60 of file choice_solution.cpp.
Choice_solution::∼Choice_solution ( ) [virtual]
Destructor.

void Choice_solution::compute ( )

• Headers/choice_solution.hpp
• Sources/choice_solution.cpp
5.4 Dam_break Class Reference
Computes dam break solutions.

#include <dam_break.hpp>
Inheritance diagram for Dam_break:
Solution
Dam_break
• Dam_break (Parameters &)

Constructor.
• virtual ∼Dam_break ()
Destructor.
• void compute ()
• SCALAR function (SCALAR, SCALAR, SCALAR) const
Function x6 − 9v2right x4 + 16vle f t v2right x3 − v2right (v2right + 8v2le f t )x2 + v6right to get the roots by dichotomy.
• void param (SCALAR, SCALAR, SCALAR, SCALAR) const

Class that computes the solutions for a dam break without friction, see Ritter [1892] Stoker [1957].
Definition at line 69 of file dam_break.hpp.
Dam_break::Dam_break ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::T, Solution::xex, Solution::zex to have the dam break configuration.
Definition at line 58 of file dam_break.cpp.
Dam_break::∼Dam_break ( ) [virtual]
Destructor.
5.5. DRESSLER_DAM CLASS REFERENCE 17
void Dam_break::compute ( ) [virtual]

Computes the chosen dam break solution, see Ritter [1892] Stoker [1957].
Modifies
Solution::hex.
SCALAR Dam_break::function ( SCALAR x, SCALAR v_left, SCALAR v_right ) const
Function x6 − 9v2right x4 + 16vle f t v2right x3 − v2right (v2right + 8v2le f t )x2 + v6right to get the roots by dichotomy.
Function to solve by dichotomy the equation cm6 −9v2right cm4 +16vle f t v2right cm3 −v2right (v2right +8v2le f t )cm2 +
v6right = 0.
Returns
Value of x6 − 9v2right x4 + 16vle f t v2right x3 − v2right (v2right + 8v2le f t )x2 + v6right .
void Dam_break::param ( SCALAR L, SCALAR xdam, SCALAR dx_ex, SCALAR T ) const

Parameters
in xdam position of the dam
in dx_ex space step
in T final time

• Headers/dam_break.hpp
• Sources/dam_break.cpp
5.5 Dressler_dam Class Reference
Computes Dressler dam break solution.

#include <dressler_dam.hpp>
Inheritance diagram for Dressler_dam:
Solution
Dressler_dam

• Dressler_dam (Parameters &)
Constructor.
• virtual ∼Dressler_dam ()
Destructor.
• void compute ()
• void param (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Class that computes the solutions for a dam break with friction, see Dressler [1952].
Definition at line 70 of file dressler_dam.hpp.

Dressler_dam::Dressler_dam ( Parameters & par )
Constructor.
Parameters
Warning
Problem: allocation of hexd failed.

Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::zex to have Dressler dam break configuration.
Note
If the vector hexd cannot be allocated, the code will exit with failure termination code.
Definition at line 60 of file dressler_dam.cpp.
Dressler_dam::∼Dressler_dam ( ) [virtual]
Destructor.

void Dressler_dam::compute ( ) [virtual]

Computes Dressler solution, see Dressler [1952].
Modifies
Solution::hex, Solution::uex.
5.5. DRESSLER_DAM CLASS REFERENCE 19
void Dressler_dam::param ( SCALAR L, SCALAR xdam, SCALAR C, SCALAR dx_ex, SCALAR T )

const

Parameters
in xdam position of the dam
in C Chezy friction coefficient
in dx_ex space step
in T final time
• Headers/dressler_dam.hpp
• Sources/dressler_dam.cpp
5.6 Inclined_plane Class Reference

Computes the solutions over an inclined plane.
#include <inclined_plane.hpp>
Inheritance diagram for Inclined_plane:
Solution
Inclined_plane

• Inclined_plane (Parameters &)
Constructor.
• virtual ∼Inclined_plane ()
Destructor.
• void compute ()
• SCALAR p (SCALAR, SCALAR, SCALAR) const
• SCALAR q (SCALAR, SCALAR, SCALAR, SCALAR) const
• SCALAR determinant (SCALAR, SCALAR) const
• SCALAR height (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const
• void abcd (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR &, SCALAR &, SCALAR &, SCALAR &)
• void param (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Class that computes the solutions over an inclined plane, see Delestre et al. [2012].
Definition at line 71 of file inclined_plane.hpp.
5.6. INCLINED_PLANE CLASS REFERENCE 21

Inclined_plane::Inclined_plane ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::zex to have the inclined plane configuration.
Definition at line 60 of file inclined_plane.cpp.
Inclined_plane::∼Inclined_plane ( ) [virtual]
Destructor.

void Inclined_plane::abcd ( SCALAR q_in, SCALAR h_in, SCALAR alpha, SCALAR x, SCALAR & a,
SCALAR & b, SCALAR & c, SCALAR & d )

Enters the coefficients of the 3rd order polynomia we want to solve: ah3 + bh2 + ch + d .
Parameters
in q_in inflow discharge
in h_in water height at the inflow
in alpha the slope
in x the position
out a coefficient of the 3rd order polynomia
out b coefficient of the 3rd order polynomia
out c coefficient of the 3rd order polynomia
out d coefficient of the 3rd order polynomia
void Inclined_plane::compute ( ) [virtual]

Computes the solution on an inclined plane, see Delestre et al. [2012].
Modifies
Solution::hex.
SCALAR Inclined_plane::determinant ( SCALAR p, SCALAR q ) const

Determinant in the Cardano method/related to number of roots.
Parameters
in p computed by Inclined_plane::p
in q computed by Inclined_plane::q
Returns
4 3
Value of q2 + 27 p .
SCALAR Inclined_plane::height ( SCALAR p, SCALAR q, SCALAR a, SCALAR b, SCALAR hnear )

const

Parameters
in p computed by Inclined_plane::p
in q computed by Inclined_plane::q
in hnear height of the previous or following cell (depending on the height computation
direction)
Warning
Error: no positive height.

Error: Probably irregular solution.
Returns
h, the water height.
SCALAR Inclined_plane::p ( SCALAR a, SCALAR b, SCALAR c ) const

Parameters
Returns
b2 c
Value of − 2
+ .
3a a
void Inclined_plane::param ( SCALAR L, SCALAR dx_ex, SCALAR alpha, SCALAR beta, SCALAR h0,
SCALAR q0 ) const

5.7. MACDONALD_LIKE CLASS REFERENCE 23
Parameters
in dx_ex space step
in alpha the slope of the plane
in beta the value of the topography for x=0
in h0 the left (imposed) water height
in q0 the left (imposed) water discharge
SCALAR Inclined_plane::q ( SCALAR a, SCALAR b, SCALAR c, SCALAR d ) const

Parameters
in d coefficient of the 3rd order polynomia
Returns
2b2

b c
Value of −9 .
27a a2 a

• Headers/inclined_plane.hpp
• Sources/inclined_plane.cpp
5.7 MacDonald_like Class Reference

Computes Mac Donald solutions.
#include <macdonald_like.hpp>
Inheritance diagram for MacDonald_like:
Solution
MacDonald_like

• MacDonald_like (Parameters &)
Constructor.
• virtual ∼MacDonald_like ()
Destructor.
• void compute ()
• SCALAR Delta_topo_Manning (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const
Evaluation of the slope variation for Manning friction law.
• SCALAR Delta_topo_Darcy_Weisbach (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const
Evaluation of the slope variation for Darcy-Weisbach friction law.


Class that computes Mac Donald solutions in 1d, see MacDonald [1996], MacDonald et al. [1997], Delestre
et al. [2013] and Vo T. N. [2008].
Definition at line 73 of file macdonald_like.hpp.

MacDonald_like::MacDonald_like ( Parameters & par )
Constructor.
Parameters
Warning
Problem: allocation of dhex failed.

Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::hex, Solution::qex to have Mac Donald configuration.
Note
If the vector dhex cannot be allocated, the code will exit with failure termination code.
Definition at line 59 of file macdonald_like.cpp.
MacDonald_like::∼MacDonald_like ( ) [virtual]
Destructor.

void MacDonald_like::compute ( ) [virtual]

Computes Mac Donald solutions, see MacDonald [1996], MacDonald et al. [1997], Delestre et al. [2013] and
Vo T. N. [2008].
Modifies
Solution::zex.
SCALAR MacDonald_like::Delta_topo_Darcy_Weisbach ( SCALAR q, SCALAR h, SCALAR dh,

SCALAR Rain, SCALAR c ) const
Evaluation of the slope variation for Darcy-Weisbach friction law.

5.8. MACDONALD_LIKE_DIFFUS CLASS REFERENCE 25
Parameters
in q discharge
in h water height
in dh variation of the water height
in Rain rain quantity
in c friction coefficient
Returns
q2 q2

q
Value of 1 − 3 dh + 2Rain 2 + c .
gh gh 8gh3
SCALAR MacDonald_like::Delta_topo_Manning ( SCALAR q, SCALAR h, SCALAR dh, SCALAR Rain,

SCALAR c ) const
Evaluation of the slope variation for Manning friction law.

Parameters
in q discharge
in h water height
in Rain rain quantity
in c friction coefficient
Returns
q2 c2 q2

q
Value of 1 − 3 dh + 2Rain 2 + 10/3 .
gh gh h
void MacDonald_like::param ( SCALAR L, SCALAR dx_ex ) const

Parameters
in dx_ex space step
• Headers/macdonald_like.hpp
• Sources/macdonald_like.cpp
5.8 MacDonald_like_diffus Class Reference

Computes Mac Donald solutions with diffusion.
#include <macdonald_like_diffus.hpp>
Inheritance diagram for MacDonald_like_diffus:
Solution
• MacDonald_like_diffus (Parameters &)

Constructor.
• virtual ∼MacDonald_like_diffus ()
Destructor.
• void compute ()
• SCALAR Delta_topo_diffus (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, S←-
CALAR) const
Evaluation of the slope variation.

Class that computes Mac Donald solutions in 1d with diffusion, see Delestre and Marche [2010].
Definition at line 70 of file macdonald_like_diffus.hpp.
MacDonald_like_diffus::MacDonald_like_diffus ( Parameters & par )
Constructor.
Parameters
Warning
Problem: allocation of dhex failed.

Problem: allocation of ddhex failed.
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::hex, Solution::qex to have Mac Donald configuration.
Note
If the vector dhex (or ddhex) cannot be allocated, the code will exit with failure termination code.
Definition at line 58 of file macdonald_like_diffus.cpp.
MacDonald_like_diffus::∼MacDonald_like_diffus ( ) [virtual]
Destructor.
5.9. MACDONALDB1 CLASS REFERENCE 27

void MacDonald_like_diffus::compute ( ) [virtual]

Computes Mac Donald solutions with diffusion, see Delestre and Marche [2010].
Modifies
Solution::zex.
SCALAR MacDonald_like_diffus::Delta_topo_diffus ( SCALAR q, SCALAR h, SCALAR dh, SCALAR

ddh, SCALAR kt, SCALAR kl, SCALAR muv, SCALAR muh ) const

Parameters
in q discharge
in h water height
in ddh second order derivative of h
in kt turbulent coefficient
in kl laminar coefficient
in muv vertical viscosity
in muh horizontal viscosity
Returns 2
q2 kt q2 q ddh − q dh

kl q h
Value of 1 − 3 dh + + + 4muh .
gh kl h
gh2 (1 + 3muv kl h 2
) gh2 (1 + 3muv ) gh2
void MacDonald_like_diffus::param ( SCALAR L, SCALAR dx_ex ) const

Parameters
in dx_ex space step
• Headers/macdonald_like_diffus.hpp
• Sources/macdonald_like_diffus.cpp
5.9 MacDonaldB1 Class Reference

Computes Mac Donald pseudo 2d solutions.
#include <macdonaldb1.hpp>
Inheritance diagram for MacDonaldB1:
Solution
MacDonaldB1

• MacDonaldB1 (Parameters &)
Constructor.
• virtual ∼MacDonaldB1 ()
Destructor.
• void compute ()
• void param (SCALAR, SCALAR, SCALAR) const
• SCALAR Delta_topo (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR,
SCALAR) const

Class that computes Mac Donald pseudo 2d solutions with bottom B1, see MacDonald [1996].
Definition at line 69 of file macdonaldb1.hpp.

MacDonaldB1::MacDonaldB1 ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::hex to have Mac Donald configuration.
Definition at line 58 of file macdonaldb1.cpp.
MacDonaldB1::∼MacDonaldB1 ( ) [virtual]
Destructor.

void MacDonaldB1::compute ( ) [virtual]

Computes Mac Donald solutions with bottom B1, see MacDonald [1996].
Modifies
Solution::zex.
SCALAR MacDonaldB1::Delta_topo ( SCALAR h, SCALAR hp, SCALAR b, SCALAR bp, SCALAR Q,

SCALAR n, SCALAR Z, SCALAR exp1, SCALAR exp2 ) const

Parameters
in h water height
in hp derivative of the water height
in b boundary function
in bp derivative of the boundary function
in Q discharge
in n friction coefficient
in Z slope
in exp1 exponent, equal to 4/3
Returns √
Q2 (b + 2Zh) 1 + Z 2 )exp1 Q2 bp

2 2 (b + 2h
Value of hp − 1 − Q n + .
g(h(b + Zh))3 (h(b + Zh))exp2 gh2 (b + Zh)3
void MacDonaldB1::param ( SCALAR L, SCALAR dx_ex, SCALAR n ) const

Parameters
in dx_ex space step
• Headers/macdonaldb1.hpp
• Sources/macdonaldb1.cpp
5.10 MacDonaldB2 Class Reference

#include <macdonaldb2.hpp>
Inheritance diagram for MacDonaldB2:
Solution
MacDonaldB2

• MacDonaldB2 (Parameters &)
Constructor.
• virtual ∼MacDonaldB2 ()
Destructor.
• void compute ()
• void param (SCALAR, SCALAR, SCALAR) const

• SCALAR Delta_topo (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR,
SCALAR) const

Class that computes Mac Donald pseudo 2d solutions with bottom B2, see MacDonald [1996].
Definition at line 70 of file macdonaldb2.hpp.

MacDonaldB2::MacDonaldB2 ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::hex to have Mac Donald configuration.
MacDonaldB2::∼MacDonaldB2 ( ) [virtual]
Destructor.

void MacDonaldB2::compute ( ) [virtual]

Computes Mac Donald solutions with bottom B2, see MacDonald [1996].
Modifies
Solution::zex.
SCALAR MacDonaldB2::Delta_topo ( SCALAR h, SCALAR hp, SCALAR b, SCALAR bp, SCALAR Q,

SCALAR n, SCALAR Z, SCALAR exp1, SCALAR exp2 ) const

Parameters
in h water height
in hp derivative of the water height
in b boundary function
in bp derivative of the boundary function
in Q discharge
in Z slope
Returns √
Q2 (b + 2Zh) 2 exp1 Q2 bp

2 2 (b + 2h 1 + Z )
Value of hp − 1 − Q n + .
g(h(b + Zh))3 (h(b + Zh))exp2 gh2 (b + Zh)3
void MacDonaldB2::param ( SCALAR L, SCALAR dx_ex, SCALAR n ) const

Parameters
in dx_ex space step
• Headers/macdonaldb2.hpp
• Sources/macdonaldb2.cpp
5.11 Parameters Class Reference

Gets parameters.
#include <parameters.hpp>

• Parameters (int, char ∗∗)
Constructor.
• virtual ∼Parameters ()
Destructor.
• void help () const
Prints help.
• int get_nxex () const
Gives the number of cells in x.
• int get_nyex () const
Gives the number of cells in y.
• SCALAR get_choicedim () const
Gives the dimension.
• int get_choicetype () const
Gives the type.
• int get_choice () const
5.11. PARAMETERS CLASS REFERENCE 33
Gives the chosen solution.

• int get_choicedomain () const
Gives the domain.
Protected Attributes
• int nx_ex
• int ny_ex
• SCALAR choicedim
• int choicetype
• int choice
• int choicedomain
Gets parameters.
Class that reads the parameters, checks their values and contains all the common declarations to get the
values of the parameters.
Definition at line 69 of file parameters.hpp.
Parameters::Parameters ( int argc, char ∗∗ argv )
Constructor.
Checks the arguments
Parameters
in argc number of arguments
in argv value of the arguments
Warning
The number of cells in x must be positive!

The number of cells in y must be positive!
Modifies
Parameters::choicedim, Parameters::choicetype, Parameters::choicedomain, Parameters::choice with the

values given in argument.
Note
If the arguments are incompatible, the code will exit with failure termination code.
Definition at line 58 of file parameters.cpp.
Parameters::∼Parameters ( ) [virtual]
Destructor.
int Parameters::get_choice ( ) const
Gives the chosen solution.
Returns
The chosen solution.
SCALAR Parameters::get_choicedim ( ) const
Gives the dimension.
Returns
The dimension of the solution.
int Parameters::get_choicedomain ( ) const
Gives the domain.
Returns
The domain of the solution.
int Parameters::get_choicetype ( ) const
Gives the type.
Returns
The type of the solution.
int Parameters::get_nxex ( ) const
Gives the number of cells in x.
Returns
The number of cells in x.
int Parameters::get_nyex ( ) const
Gives the number of cells in y.
Returns
The number of cells in y.

5.12. SAMPSON CLASS REFERENCE 35
void Parameters::help ( ) const
Prints help.
Prints how to use the code.
5.11.4 Member Data Documentation
int Parameters::choice [protected]
Value corresponding to the chosen solution.

SCALAR Parameters::choicedim [protected]
Value corresponding to the dimension of the solution.

int Parameters::choicedomain [protected]
Value corresponding to the domain of the solution.

int Parameters::choicetype [protected]
Value corresponding to the type of the solution.

int Parameters::nx_ex [protected]
Number of cells in x.
int Parameters::ny_ex [protected]
Number of cells in y.
• Headers/parameters.hpp
• Sources/parameters.cpp
5.12 Sampson Class Reference
Computes Sampson solution.

#include <sampson.hpp>
Inheritance diagram for Sampson:
Solution
Sampson

• Sampson (Parameters &)
Constructor.
• virtual ∼Sampson ()
Destructor.
• void compute ()
• void param (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Class that computes the solution for Sampson parabola with friction, see Sampson et al. [2006] Sampson
et al. [2008].
Definition at line 70 of file sampson.hpp.

Sampson::Sampson ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::T, Solution::xex, Solution::zex to have Sampson configuration.
Definition at line 58 of file sampson.cpp.
Sampson::∼Sampson ( ) [virtual]
Destructor.

void Sampson::compute ( ) [virtual]

Computes Sampson solution, see Sampson et al. [2006] Sampson et al. [2008].
Modifies
void Sampson::param ( SCALAR L, SCALAR h0, SCALAR a, SCALAR B, SCALAR tau, SCALAR
dx_ex, SCALAR T ) const

5.13. SELFSIMILAR_DAM_BREAK CLASS REFERENCE 37
Parameters
in h0 value of the topography in the center of the domain
in a parameter of the topography
in B constant for the initial condition
in tau friction coefficient
in dx_ex space step
in T final time
• Headers/sampson.hpp
• Sources/sampson.cpp
5.13 Selfsimilar_dam_break Class Reference

Computes self-similar dam break solutions.
#include <selfsimilar_dam_break.hpp>
Inheritance diagram for Selfsimilar_dam_break:
Solution

• Selfsimilar_dam_break (Parameters &)
Constructor.
• virtual ∼Selfsimilar_dam_break ()
Destructor.
• void compute ()

Class that computes the self-similar solutions for dam break with friction, see Self-similar_solutions.pdf in
the doc folder or in the bibliography of sourcesup.
Definition at line 71 of file selfsimilar_dam_break.hpp.

Selfsimilar_dam_break::Selfsimilar_dam_break ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::T, Solution::xex, Solution::zex to have the self-similar dam break con-
figuration.
Definition at line 59 of file selfsimilar_dam_break.cpp.
Selfsimilar_dam_break::∼Selfsimilar_dam_break ( ) [virtual]
Destructor.
void Selfsimilar_dam_break::compute ( ) [virtual]

Computes the chosen self-similar dam break solution, see Self-similar_solutions.pdf in the doc folder or in
the bibliography of sourcesup.
Modifies
Solution::hex.
void Selfsimilar_dam_break::param ( SCALAR L, SCALAR xL, SCALAR xR, SCALAR hinit, SCALAR
k1, SCALAR dx_ex, SCALAR T ) const

Parameters
in xL left bound for the water
in xR right bound for the water
in hinit initial height of the fluid
in k1 inverse of the friction coefficient in SW equations
in dx_ex space step
in T final time
• Headers/selfsimilar_dam_break.hpp
• Sources/selfsimilar_dam_break.cpp
5.14 Solution Class Reference
Analytic solution.
#include <solution.hpp>
Inheritance diagram for Solution:
5.14. SOLUTION CLASS REFERENCE 39
Solution
Bedload
Bump
Dam_break
Dressler_dam
Inclined_plane
MacDonald_like
MacDonaldB1
MacDonaldB2
Sampson
Swash
Thacker
Thacker2D
• Solution (Parameters &)

Constructor.
• void allocation ()
Allocations of the tables.
• void deallocation ()
deallocation of the tables
• virtual void compute ()=0
Function to be specified in case.
• void savefinalcritical (SCALAR ∗, SCALAR ∗, SCALAR ∗, SCALAR ∗) const
Saves the analytic solution at the final time with the critical height.
• void savefinalcriticalinit (SCALAR ∗, SCALAR ∗, SCALAR ∗, SCALAR ∗, SCALAR ∗) const
Saves the analytic solution at the final time with the critical height and the initial topography.
• void savefinalmu (SCALAR ∗, SCALAR ∗, SCALAR ∗) const
Saves the analytic solution at the final time without u.
• void savefinal2D (SCALAR ∗, SCALAR ∗, TAB, TAB, TAB, TAB) const
Saves the analytic solution at the final time in 2D.
• void head (Parameters &, string, string) const
Writes the version of the software and the choice of the solution.
• virtual ∼Solution ()
Destructor.
Protected Attributes
• const int NX_EX
• const int NY_EX
• SCALAR T
• SCALAR L
• SCALAR l
• SCALAR dx_ex
• SCALAR dy_ex
• SCALAR ∗ xex
• SCALAR ∗ yex
• SCALAR ∗ hex
• SCALAR ∗ uex
• SCALAR ∗ qex
• SCALAR ∗ zex

Analytic solution.
Class that contains all the common declarations for the solutions.
Definition at line 68 of file solution.hpp.

Solution::Solution ( Parameters & par )
Constructor.
Parameters
in par contains all the values from the parameters file
Definition at line 58 of file solution.cpp.
Solution::∼Solution ( ) [virtual]
Destructor.

void Solution::allocation ( )
Allocations of the tables.

Allocation of Solution::xex, Solution::yex, Solution::hex, Solution::uex, Solution::qex, Solution::zex.
Warning
Problem: allocation of xex failed.

Problem: allocation of yex failed.
Problem: allocation of hex failed.
Problem: allocation of uex failed.
Problem: allocation of qex failed.
Problem: allocation of zex failed.
Note
If a vector cannot be allocated, the code will exit with failure termination code.

5.14. SOLUTION CLASS REFERENCE 41
virtual void Solution::compute ( ) [pure virtual]
Function to be specified in case.

Implemented in MacDonald_like, Bump, Inclined_plane, Selfsimilar_dam_break, Bedload, Dressler_dam,
MacDonald_like_diffus, MacDonaldB2, Sampson, Dam_break, MacDonaldB1, Swash, Thacker, and Thacker2←-
D.
void Solution::deallocation ( )
deallocation of the tables

deallocation of Solution::xex, Solution::yex, Solution::hex, Solution::uex, Solution::qex, Solution::zex.
void Solution::head ( Parameters & par, string solutiontype, string solutionchoice ) const
Writes the version of the software and the choice of the solution.
Parameters
in par parameter, contains all the values from the parameters file
in solutiontype name of the type of the solution
in solutionchoice name of the solution
void Solution::savefinal2D ( SCALAR ∗ xex, SCALAR ∗ yex, TAB hex2D, TAB uex2D, TAB vex2D,
TAB zex2D ) const
Saves the analytic solution at the final time in 2D.

Saves x and y (the position), h (the water height), u and v (the flow velocities in x and y), z+h (the free
surface), z (the topography), U (the norm of the velocity), Fr (the Froude number), qx, qy and q (the flow discharge
in x, y and its norm).
Parameters
in xex abscissae
in yex ordinates
in hex2D water height
in uex2D flow velocity in x
in vex2D flow velocity in y
in zex2D topography
void Solution::savefinalcritical ( SCALAR ∗ xex, SCALAR ∗ hex, SCALAR ∗ uex, SCALAR ∗ zex )
const
Saves the analytic solution at the final time with the critical height.
Saves x (the position), h (the water height), u (the flow velocity), z (the topography), q (the flow discharge),
z+h (the free surface), Fr (the Froude number) and z+hc (the critical surface).
Parameters
in xex abscissae
in hex water height
in uex flow velocity
in zex topography
void Solution::savefinalcriticalinit ( SCALAR ∗ xex, SCALAR ∗ hex, SCALAR ∗ uex, SCALAR ∗ zex,
SCALAR ∗ z0 ) const
Saves the analytic solution at the final time with the critical height and the initial topography.
Saves x (the position), h (the water height), u (the flow velocity), z (the topography), q (the flow discharge),
z+h (the free surface), Fr (the Froude number), z+hc (the critical surface), z0 (the initial topography) and z0+h
(the initial surface).
Parameters
in xex abscissae
in hex water height
in uex flow velocity
in zex topography
in z0 initial topography
void Solution::savefinalmu ( SCALAR ∗ xex, SCALAR ∗ hex, SCALAR ∗ zex ) const
Saves the analytic solution at the final time without u.

Saves x (the position), h (the water height), z (the topography) and z+h (the free surface).
Parameters
in xex abscissae
in hex water height
in zex topography
5.14.4 Member Data Documentation

SCALAR Solution::dx_ex [protected]
Space step in x.
SCALAR Solution::dy_ex [protected]
Space step in y.
SCALAR∗ Solution::hex [protected]
Array for the water height.

SCALAR Solution::L [protected]
Dimensions of the domain in x.

SCALAR Solution::l [protected]
Dimensions of the domain in y.

5.15. SWASH CLASS REFERENCE 43
const int Solution::NX_EX [protected]
Number of cells in x.
const int Solution::NY_EX [protected]
Number of cells in y.
SCALAR∗ Solution::qex [protected]
Array for the flow discharge.

SCALAR Solution::T [protected]
Final time.
SCALAR∗ Solution::uex [protected]
Array for the flow velocity.

SCALAR∗ Solution::xex [protected]
Array for the first coordinate.

SCALAR∗ Solution::yex [protected]
Array for the second coordinate.

SCALAR∗ Solution::zex [protected]
Array for the topography.

• Headers/solution.hpp
• Sources/solution.cpp
5.15 Swash Class Reference

#include <swash.hpp>
Inheritance diagram for Swash:
Solution
Swash
• Swash (Parameters &)

Constructor.
• virtual ∼Swash ()
Destructor.
• void compute ()
• void ua_eta (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR, SCALAR ∗, int)
Computes the non-dimensional speed ua and the non-dimensional free surface eta.
• void param (SCALAR, SCALAR, SCALAR, SCALAR) const
• void leftcondition (int, SCALAR, SCALAR) const
Writes the left boundary condition (at each dt = 0.01s)
• SCALAR J (int, SCALAR)
Computes the kth Bessel function for k=0,1 or 2.
Definition at line 69 of file swash.hpp.
Swash::Swash ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::xex, Solution::zex to have the inclined plane configuration.
Definition at line 58 of file swash.cpp.
Swash::∼Swash ( ) [virtual]
Destructor.
void Swash::compute ( ) [virtual]

Computes the swash solutions of a wave on an inclined plane, see Marche [2005], Carrier and Greenspan
[1958].
5.15. SWASH CLASS REFERENCE 45
SCALAR Swash::J ( int k, SCALAR x )
Computes the kth Bessel function for k=0,1 or 2.

Computes the value of the kth Bessel function (k=0,1 or 2) at x.
Parameters
in k the number of the Bessel function (k=0,1 or 2)
in x the point to evaluate the Bessel function
void Swash::leftcondition ( int n, SCALAR hexl, SCALAR uexl ) const
Writes the left boundary condition (at each dt = 0.01s)

Saves the left boundary condition (h and q=hu) in the file transient_leftbc.txt or periodic_leftbc.txt.
Parameters
in n current time iteration
in hexl left value of the water height
in uexl left value of the velocity
void Swash::param ( SCALAR L, SCALAR dx_ex, SCALAR alpha, SCALAR e ) const

Parameters
in dx_ex space step
in alpha the slope of the plane
in e the initial curvature of the wave
void Swash::ua_eta ( SCALAR x0, SCALAR e, SCALAR a, SCALAR ta, SCALAR xa, SCALAR ∗
result, int sol )
Computes the non-dimensional speed ua and the non-dimensional free surface eta.
Computes the velocity and free surface (using Newton algorithm) at one point and one time.
Parameters
in x0 abscissa changement
in e the initial curvature of the wave
in a the parameter a in the references
in ta non dimentional time
in xa non dimentional abscissa
in result non-dimensional velocity and free surface at (xa,ta)
in sol to choose the transient (sol=1) or periodic (sol=2) solution to compute

• Headers/swash.hpp
• Sources/swash.cpp
5.16 Swash_solution Class Reference
Computes the solutions of the swash over an inclined plane.

#include <swash.hpp>
5.17. THACKER CLASS REFERENCE 47

Class that computes the solutions of the swash over an inclined plane, see Marche [2005], Carrier and
Greenspan [1958].
The documentation for this class was generated from the following file:
• Headers/swash.hpp
5.17 Thacker Class Reference

Computes Thacker solution.
#include <thacker.hpp>
Inheritance diagram for Thacker:
Solution
Thacker

• Thacker (Parameters &)
Constructor.
• virtual ∼Thacker ()
Destructor.
• void compute ()
• void param (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Class that computes the solution for Thacker parabola, see Thacker [1981].
Definition at line 69 of file thacker.hpp.

Thacker::Thacker ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::T, Solution::xex, Solution::zex to have Thacker configuration.
Definition at line 58 of file thacker.cpp.

Thacker::∼Thacker ( ) [virtual]
Destructor.

void Thacker::compute ( ) [virtual]

Computes Thacker solution, see Thacker [1981].
Modifies
void Thacker::param ( SCALAR L, SCALAR h0, SCALAR a, SCALAR dx_ex, SCALAR T ) const

Parameters
in dx_ex space step
in T final time
• Headers/thacker.hpp
• Sources/thacker.cpp
5.18 Thacker2D Class Reference

Computes Thacker solutions in 2D.
#include <thacker2d.hpp>
Inheritance diagram for Thacker2D:
Solution
Thacker2D

• Thacker2D (Parameters &)
Constructor.
• virtual ∼Thacker2D ()
Destructor.
• void compute ()
5.18. THACKER2D CLASS REFERENCE 49

Class that computes the solutions for Thacker paraboloid, see Thacker [1981].
Definition at line 69 of file thacker2d.hpp.

Thacker2D::Thacker2D ( Parameters & par )
Constructor.
Parameters
Modifies
Solution::dx_ex, Solution::L, Solution::l, Solution::T, Solution::xex, Solution::yex, Thacker2D::zex2D to have

Thacker 2D configuration.
Definition at line 58 of file thacker2d.cpp.
Thacker2D::∼Thacker2D ( ) [virtual]
Destructor.

void Thacker2D::compute ( ) [virtual]

Computes the chosen Thacker 2D solution, see Thacker [1981].
Modifies
Thacker2D::hex2D, Thacker2D::uex2D, Thacker2D::vex2D.
void Thacker2D::param ( SCALAR L, SCALAR l, SCALAR h0, SCALAR a, SCALAR dx_ex, SCALAR
dy_ex, SCALAR T ) const

Parameters
in L length of the domain in x
in l length of the domain in y
in dx_ex space step in x

in dy_ex space step in y
in T final time
• Headers/thacker2d.hpp
• Sources/thacker2d.cpp
Chapter 6
File Documentation
6.1 Headers/bedload.hpp File Reference

#include "solution.hpp"
Classes
• class Bedload
Macros
• #define BEDLOAD_HPP
Author
Minh Hoang Le [email protected] (2012)

Carine Lucas [email protected] (2012-2015)
Version
1.03.00
Date
2015-10-28
Analytic solution: the bed is moving with bedload, see Berthon et al. [2012].
Copyright
License Cecill-V2
http://www.cecill.info/licences/Licence_CeCILL_V2-en.html
(c) CNRS - Universite d'Orleans - INRA (France)
51
52 CHAPTER 6. FILE DOCUMENTATION
6.1.2 Macro Definition Documentation
#define BEDLOAD_HPP
Definition at line 61 of file bedload.hpp.
6.2 Headers/bump.hpp File Reference
Computes bumps solutions.

Classes
• class Bump
Author
Olivier Delestre [email protected] (2010)

Anne-Celine Boulanger [email protected] (2010)
Version
1.03.00
Date
2015-10-28
Analytic solution: with a bump, see Delestre et al. [2013] and Goutal and Maurel [1997].
Copyright
License Cecill-V2
(c) CNRS - Universite d'Orleans - INRA - Universite Pierre et Marie Curie (France)
6.3 Headers/choice_solution.hpp File Reference

6.3. HEADERS/CHOICE_SOLUTION.HPP FILE REFERENCE 53
#include "dam_break.hpp"
#include "selfsimilar_dam_break.hpp"
#include "dressler_dam.hpp"
#include "inclined_plane.hpp"
#include "bump.hpp"
#include "macdonald_like.hpp"
#include "macdonald_like_diffus.hpp"
#include "thacker.hpp"
#include "bedload.hpp"
#include "thacker2d.hpp"
#include "macdonaldb1.hpp"
#include "sampson.hpp"
#include "swash.hpp"
Classes
• class Choice_solution
Macros
• #define CHOICE_SOLUTION_HPP

Author

Noemie Gaveau [email protected] (2015)
Version
1.03.00
Date
2016-01-25
From the value of the corresponding parameter, calls the chosen solution.
Copyright
License Cecill-V2

#define CHOICE_SOLUTION_HPP
Definition at line 121 of file choice_solution.hpp.

6.4 Headers/dam_break.hpp File Reference

Classes
• class Dam_break

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: dam break without friction, see Ritter [1892] Stoker [1957].
Copyright
License Cecill-V2
6.5 Headers/dressler_dam.hpp File Reference

Classes
• class Dressler_dam

Author

6.6. HEADERS/INCLINED_PLANE.HPP FILE REFERENCE 55
Version
1.03.00
Date
2015-10-28
Analytic solution: dam break with friction, see Dressler [1952].
Copyright
License Cecill-V2
6.6 Headers/inclined_plane.hpp File Reference
Computes the solution over an inclined plane.

Classes
• class Inclined_plane
Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Delestre et al. [2012].
Copyright
License Cecill-V2
6.7 Headers/macdonald_like.hpp File Reference

Classes
• class MacDonald_like

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Mac Donald solutions in 1d, see MacDonald [1996] MacDonald et al. [1997], Delestre et al.
[2013] and Vo T. N. [2008].
Copyright
License Cecill-V2
6.8 Headers/macdonald_like_diffus.hpp File Reference

Classes
• class MacDonald_like_diffus

Author

6.9. HEADERS/MACDONALDB1.HPP FILE REFERENCE 57
Version
1.03.00
Date
2015-10-28
Analytic solution: Mac Donald solutions in 1d with diffusion, see Delestre and Marche [2010].
Copyright
License Cecill-V2
6.9 Headers/macdonaldb1.hpp File Reference

Classes
• class MacDonaldB1

Author
Pierre-Antoine Ksinant [email protected] (2011)

Version
1.03.00
Date
2015-10-28
Analytic solution: Mac Donald pseudo 2d solutions with bottom B1, see MacDonald [1996].
Copyright
License Cecill-V2
6.10 Headers/macdonaldb2.hpp File Reference

Classes
• class MacDonaldB2

Author

Version
1.03.00
Date
2015-10-28
Copyright
License Cecill-V2
6.11 Headers/misc.hpp File Reference

Definitions.
#include <vector>
#include <iomanip>
#include <iostream>
#include <cmath>
#include <stdlib.h>
#include <fstream>
#include <complex>
#include <cstdlib>
Macros
• #define MAX(a, b) (a>=b?a:b)
• #define GRAV 9.81
• #define GRAV_DEM 4.905
• #define PI 3.14159265
• #define EPSILON_H 1.e-12
• #define VERSION "SWASHES version 1.03.00, 2016-01-29"
Typedefs
• typedef double SCALAR
• typedef vector< vector< SCALAR > > TAB
6.11. HEADERS/MISC.HPP FILE REFERENCE 59
Definitions.
Author

Version
1.03.00
Date
2016-01-29
Defines the constants, the types used in the code and contains the ‘include'.
Copyright
License Cecill-V2
#define EPSILON_H 1.e-12
Definition at line 70 of file misc.hpp.
#define GRAV 9.81
#define GRAV_DEM 4.905
#define MAX( a, b ) (a>=b?a:b)
#define PI 3.14159265
#define VERSION "SWASHES version 1.03.00, 2016-01-29"
6.11.3 Typedef Documentation
typedef double SCALAR

typedef vector< vector< SCALAR > > TAB
6.12 Headers/parameters.hpp File Reference
Gets parameters.
#include "misc.hpp"
Classes
• class Parameters
Gets parameters.
Gets parameters.
Author

Version
1.03.00
Date
2015-10-28
Reads the parameters, checks their values, returns the use if needed.
Copyright
License Cecill-V2
6.13 Headers/sampson.hpp File Reference

Classes
• class Sampson
6.14. HEADERS/SELFSIMILAR_DAM_BREAK.HPP FILE REFERENCE 61

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Sampson parabola with friction, see Sampson et al. [2006] Sampson et al. [2008].
Copyright
License Cecill-V2
6.14 Headers/selfsimilar_dam_break.hpp File Reference

Classes
• class Selfsimilar_dam_break

Author
Serge Bodjona (2013)

Version
1.03.00
Date
2015-10-28
Analytic solution: self-similar solution for dam break with friction,

see Self-similar_solutions.pdf in the doc folder or in the bibliography of sourcesup.
Copyright
License Cecill-V2
6.15 Headers/solution.hpp File Reference

Common file.
#include "parameters.hpp"
Classes
• class Solution
Analytic solution.

Common file.
Author

Version
1.03.00
Date
2015-10-28
Common part for all the solutions.
Copyright
License Cecill-V2
6.16 Headers/swash.hpp File Reference

Classes
• class Swash

Author

6.17. HEADERS/THACKER.HPP FILE REFERENCE 63
Version
1.03.00
Date
2016-01-25
Analytic solution: swash solutions, see Marche [2005], Carrier and Greenspan [1958]
Copyright
License Cecill-V2
6.17 Headers/thacker.hpp File Reference

Classes
• class Thacker

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Thacker parabola, see Thacker [1981].
Copyright
License Cecill-V2
6.18 Headers/thacker2d.hpp File Reference

Classes
• class Thacker2D

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Thacker paraboloid, see Thacker [1981].

Copyright
License Cecill-V2
6.19 Sources/bedload.cpp File Reference

#include "bedload.hpp"

Author
Minh Hoang Le [email protected] (2012)

Version
1.03.00
Date
2015-10-28
Analytic solution: the bed is moving with bedload, see Berthon et al. [2012].
Copyright
License Cecill-V2

6.20. SOURCES/BUMP.CPP FILE REFERENCE 65
6.20 Sources/bump.cpp File Reference

#include "bump.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: with a bump, see Delestre et al. [2013], Goutal and Maurel [1997].
Copyright
License Cecill-V2
6.21 Sources/choice_solution.cpp File Reference

#include "choice_solution.hpp"

Author

Version
1.03.00
Date
2016-01-25
From the value of the corresponding parameter, calls the chosen solution.
Copyright
License Cecill-V2
6.22 Sources/dam_break.cpp File Reference

#include "dam_break.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: dam break without friction, see Ritter [1892] Stoker [1957].
Copyright
License Cecill-V2
6.23 Sources/dressler_dam.cpp File Reference

#include "dressler_dam.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: dam break with friction, see Dressler [1952].

Copyright
License Cecill-V2
6.24. SOURCES/INCLINED_PLANE.CPP FILE REFERENCE 67
6.24 Sources/inclined_plane.cpp File Reference

#include "inclined_plane.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Delestre et al. [2012].
Copyright
License Cecill-V2
6.25 Sources/macdonald_like.cpp File Reference

#include "macdonald_like.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Mac Donald solutions in 1d, see MacDonald [1996], MacDonald et al. [1997], Delestre et al.
[2013] and Vo T. N. [2008].
Copyright
License Cecill-V2
6.26 Sources/macdonald_like_diffus.cpp File Reference

#include "macdonald_like_diffus.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Mac Donald solutions in 1d with diffusion, see Delestre and Marche [2010].
Copyright
License Cecill-V2
6.27 Sources/macdonaldb1.cpp File Reference


Author

Version
1.03.00
Date
2015-10-28
Copyright
License Cecill-V2
6.28. SOURCES/MACDONALDB2.CPP FILE REFERENCE 69
6.28 Sources/macdonaldb2.cpp File Reference


Author

Version
1.03.00
Date
2015-10-28
Copyright
License Cecill-V2
6.29 Sources/parameters.cpp File Reference

Gets parameters.
#include "parameters.hpp"

Gets parameters.
Author

Version
1.03.00
Date
2016-01-21
Reads the parameters, checks their values, returns the use if needed.
Copyright
License Cecill-V2
6.30 Sources/sampson.cpp File Reference

#include "sampson.hpp"

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Sampson parabola with friction, see Sampson et al. [2006] Sampson et al. [2008].
Copyright
License Cecill-V2
6.31 Sources/selfsimilar_dam_break.cpp File Reference

#include "selfsimilar_dam_break.hpp"

Author
Serge Bodjona (2013)

Version
1.03.00
Date
2015-10-28
Analytic solution: self-similar solution for dam break with friction,

see Self-similar_solutions.pdf in the doc folder or in the bibliography of sourcesup.
Copyright
License Cecill-V2
6.32. SOURCES/SOLUTION.CPP FILE REFERENCE 71
6.32 Sources/solution.cpp File Reference

Common file.

Common file.
Author

Version
1.03.00
Date
2015-10-28
Common part for all the solutions.

Copyright
License Cecill-V2
6.33 Sources/swash.cpp File Reference

#include "swash.hpp"

Author

Version
1.03.00
Date
2016-01-27
Analytic solution: swash solutions, see Marche [2005], Carrier and Greenspan [1958].
Copyright
License Cecill-V2
6.34 Sources/swashes.cpp File Reference
Main file.
#include "choice_solution.hpp"
Functions
• int main (int argc, char ∗∗argv)
Main file.
Author

Version
1.03.00
Date
2015-10-28
For more details, we refer to Delestre et al. [2013].
Copyright
License Cecill-V2
6.34.2 Function Documentation
int main ( int argc, char ∗∗ argv )
Main function of SWASHES, see Delestre et al. [2013].

Parameters
in argc number of the arguments.
in argv value of the arguments.
Definition at line 58 of file swashes.cpp.
6.35 Sources/thacker.cpp File Reference

#include "thacker.hpp"
6.36. SOURCES/THACKER2D.CPP FILE REFERENCE 73

Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Thacker parabola, see Thacker [1981].
Copyright
License Cecill-V2
6.36 Sources/thacker2d.cpp File Reference

Computes Thacker solution in 2D.
#include "thacker2d.hpp"

Computes Thacker solution in 2D.
Author

Version
1.03.00
Date
2015-10-28
Analytic solution: Thacker paraboloid, see Thacker [1981].
Copyright
License Cecill-V2

Bibliography
C. Berthon, S. Cordier, O. Delestre, and M.-H. Le. An analytical solution of the Shallow Water system coupled to
the Exner equation. C. R. Acad. Sci. Paris, Ser. I, 350(3–4):183–186, 2012. doi:10.1016/j.crma.2012.01.007.
URL http://hal.archives-ouvertes.fr/hal-00648343. 9, 10, 51, 64
G. F. Carrier and H. P. Greenspan. Water waves of finite amplitude on a sloping beach. Journal of Fluid
Mechanics, 4:97–109, 1958. doi:10.1017/S0022112058000331. URL http://journals.cambridge.
org/article_S0022112058000331. 44, 47, 63, 71
O. Delestre and F. Marche. A numerical scheme for a viscous shallow water model with friction. Journal of
Scientific Computing, pages 1–11, 2010. ISSN 0885-7474. doi:10.1007/s10915-010-9393-y. 26, 27, 57, 68
O. Delestre, S. Cordier, F. Darboux, and F. James. A limitation of the hydrostatic reconstruction

technique for Shallow Water equations. Comptes Rendus Mathématique, 350(13-14):677–681, 2012.
doi:10.1016/J.crma.2012.08.004. URL http://hal.archives-ouvertes.fr/hal-00710654.
20, 21, 55, 67
O. Delestre, C. Lucas, P.-A. Ksinant, F. Darboux, C. Laguerre, T. N. T. Vo, F. James, and S. Cordier. SWASHES: a
compilation of shallow water analytic solutions for hydraulic and environmental studies. International Journal
of Numerical Methods in Fluids, 72(3):269–300, May 2013. doi:10.1002/fld.3741. URL http://hal.
archives-ouvertes.fr/hal-00628246. See Annex on the HAL page for complementary results
(with illustrations of each case). 12, 13, 24, 52, 56, 65, 67, 72
R. F. Dressler. Hydraulic resistance effect upon the dam-break functions. Journal of Research of the National
Bureau of Standards, 49(3):217–225, Sept. 1952. 18, 55, 66
N. Goutal and F. Maurel. Proceedings of the 2nd workshop on dam-break wave simulation. Technical Report
HE-43/97/016/B, Electricité de France, Direction des études et recherches, 1997. 12, 13, 52, 65
I. MacDonald. Analysis and computation of steady open channel flow. PhD thesis, University of Reading —
Department of Mathematics, Sept. 1996. 24, 28, 31, 56, 57, 58, 67, 68, 69
I. MacDonald, M. J. Baines, N. K. Nichols, and P. G. Samuels. Analytic benchmark solutions for open-channel
flows. Journal of Hydraulic Engineering, 123(11):1041–1045, Nov. 1997. 24, 56, 67
F. Marche. Theoretical and numerical study of shallow water models ; applications to nearshore hydrodynamics.
Phd, Université Bordeaux 1, 2005. 44, 47, 63, 71
A. Ritter. Die Fortpflanzung der Wasserwellen. Zeitschrift des Vereines Deuscher Ingenieure, 36(33):947–954,
1892. 16, 17, 54, 66
J. Sampson, A. Easton, and M. Singh. Moving boundary shallow water flow above parabolic bottom topography.
In A. Stacey, B. Blyth, J. Shepherd, and A. J. Roberts, editors, Proceedings of the 7th Biennial Engineering
Mathematics and Applications Conference, EMAC-2005, volume 47 of ANZIAM Journal, pages C373–C387.
Australian Mathematical Society, oct 2006. URL http://journal.austms.org.au/ojs/index.
php/ANZIAMJ/article/view/1050. 36, 61, 70
75
76 BIBLIOGRAPHY
J. Sampson, A. Easton, and M. Singh. Moving boundary shallow water flow in a region with quadratic bathymetry.
In G. N. Mercer and A. J. Roberts, editors, Proceedings of the 8th Biennial Engineering Mathematics and Ap-
plications Conference, EMAC-2007, volume 49 of ANZIAM Journal, pages C666–C680. Australian Math-
ematical Society, 2008. URL http://journal.austms.org.au/ojs/index.php/ANZIAMJ/
article/view/306. 36, 61, 70
J. J. Stoker. Water Waves: The Mathematical Theory with Applications. Pure and Applied Mathematics. Inter-
science Publishers, New York, USA, 1957. 16, 17, 54, 66
W. C. Thacker. Some exact solutions to the nonlinear shallow-water wave equations. Jour-
nal of Fluid Mechanics, 107:499–508, 1981. doi:10.1017/S0022112081001882. URL http:
//journals.cambridge.org/action/displayAbstract?fromPage=online&aid=
389055&fulltextType=RA&fileId=S0022112081001882. 47, 48, 49, 63, 64, 73
T. Vo T. N. One dimensional Saint-Venant system. Master’s thesis, Université d’Orléans, France, June 2008.
URL http://dumas.ccsd.cnrs.fr/dumas-00597434. 24, 56, 67
Index
∼Bedload compute, 10
Bedload, 10 param, 10
∼Bump paramwarning, 11
Bump, 12 bedload.hpp
∼Choice_solution BEDLOAD_HPP, 52
Choice_solution, 15 Bump, 11
∼Dam_break ∼Bump, 12
Dam_break, 16 abcd, 12
∼Dressler_dam Bump, 12
Dressler_dam, 18 compute, 13
∼Inclined_plane determinant, 13
Inclined_plane, 21 height, 13
∼MacDonaldB1 p, 13
MacDonaldB1, 28 param, 14
∼MacDonaldB2 q, 14
MacDonaldB2, 31 RHJump, 14
∼MacDonald_like
MacDonald_like, 24 CHOICE_SOLUTION_HPP
∼MacDonald_like_diffus choice_solution.hpp, 53
MacDonald_like_diffus, 26 choice
∼Parameters Parameters, 35
Parameters, 33 Choice_solution, 15
∼Sampson ∼Choice_solution, 15
Sampson, 36 Choice_solution, 15
∼Selfsimilar_dam_break compute, 15
Selfsimilar_dam_break, 38 choice_solution.hpp
∼Solution CHOICE_SOLUTION_HPP, 53
Solution, 40 choicedim
∼Swash Parameters, 35
Swash, 44 choicedomain
∼Thacker Parameters, 35
Thacker, 47 choicetype
∼Thacker2D Parameters, 35
Thacker2D, 49 compute
Bedload, 10
abcd Bump, 13
Bump, 12 Choice_solution, 15
Inclined_plane, 21 Dam_break, 17
allocation Dressler_dam, 18
Solution, 40 Inclined_plane, 21
MacDonald_like, 24
BEDLOAD_HPP MacDonald_like_diffus, 27
bedload.hpp, 52 MacDonaldB1, 28
Bedload, 9 MacDonaldB2, 31
∼Bedload, 10 Sampson, 36
Bedload, 9 Selfsimilar_dam_break, 38
77
78 INDEX
Solution, 40 get_nyex
Swash, 44 Parameters, 34
Thacker, 48
Thacker2D, 49 head
Solution, 41
Dam_break, 16 Headers/bedload.hpp, 51
∼Dam_break, 16 Headers/bump.hpp, 52
compute, 17 Headers/choice_solution.hpp, 52
Dam_break, 16 Headers/dam_break.hpp, 54
function, 17 Headers/dressler_dam.hpp, 54
param, 17 Headers/inclined_plane.hpp, 55
deallocation Headers/macdonald_like.hpp, 56
Solution, 41 Headers/macdonald_like_diffus.hpp, 56
Delta_topo Headers/macdonaldb1.hpp, 57
MacDonaldB1, 28 Headers/macdonaldb2.hpp, 57
MacDonaldB2, 31 Headers/misc.hpp, 58
Delta_topo_Darcy_Weisbach Headers/parameters.hpp, 60
MacDonald_like, 24 Headers/sampson.hpp, 60
Delta_topo_Manning Headers/selfsimilar_dam_break.hpp, 61
MacDonald_like, 25 Headers/solution.hpp, 62
Delta_topo_diffus Headers/swash.hpp, 62
MacDonald_like_diffus, 27 Headers/thacker.hpp, 63
determinant Headers/thacker2d.hpp, 63
Bump, 13 height
Inclined_plane, 21 Bump, 13
Dressler_dam, 17 Inclined_plane, 22
∼Dressler_dam, 18 help
compute, 18 Parameters, 34
Dressler_dam, 18 hex
param, 18 Solution, 42
dx_ex
Solution, 42 Inclined_plane, 20
dy_ex ∼Inclined_plane, 21
Solution, 42 abcd, 21
compute, 21
EPSILON_H determinant, 21
misc.hpp, 59 height, 22
Inclined_plane, 21
function
p, 22
Dam_break, 17
param, 22
GRAV q, 23
misc.hpp, 59
J
GRAV_DEM
Swash, 44
misc.hpp, 59
get_choice L
Parameters, 34 Solution, 42
get_choicedim l
Parameters, 34 Solution, 42
get_choicedomain leftcondition
Parameters, 34 Swash, 46
get_choicetype
Parameters, 34 MAX
get_nxex misc.hpp, 59
Parameters, 34 MacDonald_like, 23
INDEX 79
∼MacDonald_like, 24 Dressler_dam, 18
compute, 24 Inclined_plane, 22
Delta_topo_Darcy_Weisbach, 24 MacDonald_like, 25
Delta_topo_Manning, 25 MacDonald_like_diffus, 27
MacDonald_like, 24 MacDonaldB1, 30
param, 25 MacDonaldB2, 32
MacDonald_like_diffus, 25 Sampson, 36
∼MacDonald_like_diffus, 26 Selfsimilar_dam_break, 38
compute, 27 Swash, 46
Delta_topo_diffus, 27 Thacker, 48
MacDonald_like_diffus, 26 Thacker2D, 49
param, 27 Parameters, 32
MacDonaldB1, 27 ∼Parameters, 33
∼MacDonaldB1, 28 choice, 35
compute, 28 choicedim, 35
Delta_topo, 28 choicedomain, 35
MacDonaldB1, 28 choicetype, 35
param, 30 get_choice, 34
MacDonaldB2, 30 get_choicedim, 34
∼MacDonaldB2, 31 get_choicedomain, 34
compute, 31 get_choicetype, 34
Delta_topo, 31 get_nxex, 34
MacDonaldB2, 31 get_nyex, 34
param, 32 help, 34
main nx_ex, 35
swashes.cpp, 72 ny_ex, 35
misc.hpp Parameters, 33
EPSILON_H, 59 paramwarning
GRAV, 59 Bedload, 11
GRAV_DEM, 59
MAX, 59 q
PI, 59 Bump, 14
SCALAR, 59 Inclined_plane, 23
TAB, 59 qex
VERSION, 59 Solution, 43
NX_EX RHJump
Solution, 42 Bump, 14
NY_EX
Solution, 43 SCALAR
nx_ex misc.hpp, 59
Parameters, 35 Sampson, 35
ny_ex ∼Sampson, 36
Parameters, 35 compute, 36
param, 36
p Sampson, 36
Bump, 13 savefinal2D
Inclined_plane, 22 Solution, 41
PI savefinalcritical
misc.hpp, 59 Solution, 41
param savefinalcriticalinit
Bedload, 10 Solution, 42
Bump, 14 savefinalmu
Dam_break, 17 Solution, 42
80 INDEX
Selfsimilar_dam_break, 37 Swash, 44
∼Selfsimilar_dam_break, 38 ua_eta, 46
compute, 38 Swash_solution, 46
param, 38 swashes.cpp
Selfsimilar_dam_break, 37 main, 72
Solution, 38
T
∼Solution, 40
Solution, 43
allocation, 40
TAB
compute, 40
misc.hpp, 59
deallocation, 41
Thacker, 47
dx_ex, 42
∼Thacker, 47
dy_ex, 42
compute, 48
head, 41
param, 48
hex, 42
Thacker, 47
L, 42
Thacker2D, 48
l, 42
∼Thacker2D, 49
NX_EX, 42
compute, 49
NY_EX, 43
param, 49
qex, 43
Thacker2D, 49
savefinal2D, 41
savefinalcritical, 41 ua_eta
savefinalcriticalinit, 42 Swash, 46
savefinalmu, 42 uex
Solution, 40 Solution, 43
T, 43
uex, 43 VERSION
xex, 43 misc.hpp, 59
yex, 43
xex
zex, 43
Solution, 43
Sources/bedload.cpp, 64
Sources/bump.cpp, 65 yex
Sources/choice_solution.cpp, 65 Solution, 43
Sources/dam_break.cpp, 66
Sources/dressler_dam.cpp, 66 zex
Sources/inclined_plane.cpp, 67 Solution, 43
Sources/macdonald_like.cpp, 67
Sources/macdonald_like_diffus.cpp, 68
Sources/macdonaldb1.cpp, 68
Sources/macdonaldb2.cpp, 69
Sources/parameters.cpp, 69
Sources/sampson.cpp, 70
Sources/selfsimilar_dam_break.cpp, 70
Sources/solution.cpp, 71
Sources/swash.cpp, 71
Sources/swashes.cpp, 72
Sources/thacker.cpp, 72
Sources/thacker2d.cpp, 73
Swash, 43
∼Swash, 44
compute, 44
J, 44
leftcondition, 46
param, 46

Swashes PDF

Uploaded by

Copyright:

Available Formats

Swashes PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Swashes PDF

Uploaded by

Copyright:

Available Formats

Documentation

Generated by Doxygen 1.8.10

Member Choice_solution::Choice_solution (Parameters &)

2.1 Class Hierarchy

3.1 Class List

4.1 File List

Here is a list of all files with brief descriptions:

5.1 Bedload Class Reference

Public Member Functions

Additional Inherited Members

5.1.1 Detailed Description

5.1.2 Constructor & Destructor Documentation

Problem: allocation of z0 failed

Solution::dx_ex, Solution::L, Solution::T, Solution::xex.

Definition at line 59 of file bedload.cpp.

5.1.3 Member Function Documentation

Computes the solution.

Solution::hex, Solution::uex, Solution::zex.

Writes the parameters of the solution.

in hexr value of the water height on the right boundary

void Bedload::paramwarning ( ) const

Writes a warning about the the solution.

Definition at line 212 of file bedload.cpp.

5.2 Bump Class Reference

Public Member Functions

• SCALAR height (SCALAR, SCALAR, SCALAR, SCALAR, SCALAR) const

Additional Inherited Members

5.2.1 Detailed Description

5.2.2 Constructor & Destructor Documentation

Solution::dx_ex, Solution::L, Solution::xex, Solution::zex to have the bump configuration.

Definition at line 60 of file bump.cpp.

5.2.3 Member Function Documentation

Defines a, b, c, d in order to solve ah3 + bh2 + ch + d .

in zbx bottom topography of the current cell

void Bump::compute ( ) [virtual]

Computes the solution.

SCALAR Bump::determinant ( SCALAR p, SCALAR q ) const

Determinant for Cardano method.

SCALAR Bump::height ( SCALAR p, SCALAR q, SCALAR a, SCALAR b, SCALAR hnear ) const

Computation of the 3rd order polynomia roots.

Error: no positive height.

h, the water height.

SCALAR Bump::p ( SCALAR a, SCALAR b, SCALAR c ) const

Coefficient p for Cardano method.

Definition at line 260 of file bump.cpp.

void Bump::param ( SCALAR L, SCALAR dx_ex ) const

Writes the parameters of the solution.

SCALAR Bump::q ( SCALAR a, SCALAR b, SCALAR c, SCALAR d ) const

Coefficient q for Cardano method.

Definition at line 273 of file bump.cpp.

SCALAR Bump::RHJump ( SCALAR hplus, SCALAR hminus, SCALAR q ) const

Steady state RH relation.

Definition at line 385 of file bump.cpp.

5.3 Choice_solution Class Reference

Public Member Functions

5.3.1 Detailed Description

5.3.2 Constructor & Destructor Documentation

Error: the dimension is ∗∗∗

Todo Exceptions should be treated.