Hold data for validation. Two type: EMcneil, Hudson (DamBreak config) More...

#include <Sfx_DamBreakData.h>

Public Types
enum class	eDataTypes { emcneil = 0 , hudson = 1 }
using	pairofloat64 = std::pair<float64, float64>

Public Member Functions
	DamBreakData (eDataTypes aDiscrType=eDataTypes::emcneil)
	DamBreakData (std::string aDataType)
float64	x_min () const noexcept
	domain extent
float64	x_max () const noexcept
	domain extent
float64	getS0am () const noexcept
float64	getS0av () const noexcept
float64	getCFL () const noexcept
	Courant-Friedrich-Levy number.
float64	dX () const noexcept
	spatial step
int32	nbSections () const noexcept
float64	getPhi0 () const noexcept
	water level right side of the dam
float64	getPhi1 () const noexcept
	water level left side of the dam
float64	getWidth () const noexcept
	section width
float64	getShockLocation () const noexcept
	location of the shock
pairofloat64	domainExtent () const noexcept
	spatial domain ectent
pairofloat64	dambreakExtent () const noexcept
	DamBreak init config (water level)
eDataTypes	getDiscrType () const noexcept
	Type of DamBeak data.
bool	isUnitSectionWidth () const noexcept
	type of section geometry
bool	isFrictionLess () const noexcept
	use friction
bool	isFlatBed () const noexcept
	type of bathymetry
std::string	toString (eDataTypes aDisc) noexcept
	string representation of spatial discretization
std::string	toString (eDataTypes aDisc) const noexcept
	string representation of spatial discretization

Private Member Functions
void	setEMcNeilParams () noexcept
	E. McNeil data.
void	setHudsonParams () noexcept
	Hudson data.
void	setDiscrType ()
	Discretization type.

Private Attributes
eDataTypes	m_discrType
pairofloat64	m_domainExtent
pairofloat64	m_dambreakExtent
float64	m_S0am
float64	m_S0av
float64	m_dX
float64	m_Phi0
float64	m_Phi1
float64	m_cfl
int32	m_NbSects
float64	m_Xmin
float64	m_Xmax
float64	m_sectWidth
float64	m_shockLocation
bool	m_unitSectWidth
bool	m_frictionLess
bool	m_flatBed

Detailed Description

Hold data for validation. Two type: EMcneil, Hudson (DamBreak config)

Member Typedef Documentation

◆ pairofloat64

using Sfx::DamBreakData::pairofloat64 = std::pair<float64, float64>

alias

Member Enumeration Documentation

◆ eDataTypes

enum class Sfx::DamBreakData::eDataTypes

strong

An enum type. DamBreak data type

Enumerator
emcneil	E. McNeil parameters
hudson	Hudson technical report parameters

Constructor & Destructor Documentation

◆ DamBreakData() [1/2]

Sfx::DamBreakData::DamBreakData ( eDataTypes aDiscrType = eDataTypes::emcneil )

inlineexplicit

Parameters

aDiscrType

◆ DamBreakData() [2/2]

Sfx::DamBreakData::DamBreakData ( std::string aDataType )

inline

Parameters

aDataType

Member Function Documentation

◆ dambreakExtent()

pairofloat64 Sfx::DamBreakData::dambreakExtent ( ) const

inlinenoexcept

DamBreak init config (water level)

Returns

◆ domainExtent()

pairofloat64 Sfx::DamBreakData::domainExtent ( ) const

inlinenoexcept

spatial domain ectent

Returns: pair of x-coord

◆ dX()

float64 Sfx::DamBreakData::dX ( ) const

inlinenoexcept

spatial step

Returns: value of spatial step

◆ getCFL()

float64 Sfx::DamBreakData::getCFL ( ) const

inlinenoexcept

Courant-Friedrich-Levy number.

Returns: value

◆ getDiscrType()

eDataTypes Sfx::DamBreakData::getDiscrType ( ) const

inlinenoexcept

Type of DamBeak data.

Returns: type

◆ getPhi0()

float64 Sfx::DamBreakData::getPhi0 ( ) const

inlinenoexcept

water level right side of the dam

Returns: value

◆ getPhi1()

float64 Sfx::DamBreakData::getPhi1 ( ) const

inlinenoexcept

water level left side of the dam

Returns: value

◆ getS0am()

float64 Sfx::DamBreakData::getS0am ( ) const

inlinenoexcept

◆ getS0av()

float64 Sfx::DamBreakData::getS0av ( ) const

inlinenoexcept

◆ getShockLocation()

float64 Sfx::DamBreakData::getShockLocation ( ) const

inlinenoexcept

location of the shock

Returns: value

◆ getWidth()

float64 Sfx::DamBreakData::getWidth ( ) const

inlinenoexcept

section width

Returns: value

◆ isFlatBed()

bool Sfx::DamBreakData::isFlatBed ( ) const

inlinenoexcept

type of bathymetry

Returns: true/false

◆ isFrictionLess()

bool Sfx::DamBreakData::isFrictionLess ( ) const

inlinenoexcept

use friction

Returns: true/false

◆ isUnitSectionWidth()

bool Sfx::DamBreakData::isUnitSectionWidth ( ) const

inlinenoexcept

type of section geometry

Returns: true/false

◆ nbSections()

int32 Sfx::DamBreakData::nbSections ( ) const

inlinenoexcept

◆ setDiscrType()

void Sfx::DamBreakData::setDiscrType ( )

inlineprivate

Discretization type.

◆ setEMcNeilParams()

void Sfx::DamBreakData::setEMcNeilParams ( )

inlineprivatenoexcept

E. McNeil data.

◆ setHudsonParams()

void Sfx::DamBreakData::setHudsonParams ( )

inlineprivatenoexcept

Hudson data.

◆ toString() [1/2]

std::string Sfx::DamBreakData::toString ( eDataTypes aDisc ) const

inlinenoexcept

string representation of spatial discretization

Parameters

aDisc type enum

Returns: string

◆ toString() [2/2]

std::string Sfx::DamBreakData::toString ( eDataTypes aDisc )

inlinenoexcept

string representation of spatial discretization

Parameters

aDisc type of enum

Returns: string

◆ x_max()

float64 Sfx::DamBreakData::x_max ( ) const

inlinenoexcept

domain extent

Returns: x-coord maximum

◆ x_min()

float64 Sfx::DamBreakData::x_min ( ) const

inlinenoexcept

domain extent

Returns: x-coord minimum

Member Data Documentation

◆ m_cfl

float64 Sfx::DamBreakData::m_cfl

private

Courant-Friedrich-Levy number

◆ m_dambreakExtent

pairofloat64 Sfx::DamBreakData::m_dambreakExtent

private

not sure

◆ m_discrType

eDataTypes Sfx::DamBreakData::m_discrType

private

discretization type

◆ m_domainExtent

pairofloat64 Sfx::DamBreakData::m_domainExtent

private

grid [min,max]

◆ m_dX

float64 Sfx::DamBreakData::m_dX

private

spatial step

◆ m_flatBed

bool Sfx::DamBreakData::m_flatBed

private

section bathy

◆ m_frictionLess

bool Sfx::DamBreakData::m_frictionLess

private

no-friction (Manning coefficient is zero)

◆ m_NbSects

int32 Sfx::DamBreakData::m_NbSects

private

number of computational nodes

◆ m_Phi0

float64 Sfx::DamBreakData::m_Phi0

private

water level at upstream

◆ m_Phi1

float64 Sfx::DamBreakData::m_Phi1

private

water level at downstream

◆ m_S0am

float64 Sfx::DamBreakData::m_S0am

private

Slope upstream

◆ m_S0av

float64 Sfx::DamBreakData::m_S0av

private

Slope downstream

◆ m_sectWidth

float64 Sfx::DamBreakData::m_sectWidth

private

section flow width

◆ m_shockLocation

float64 Sfx::DamBreakData::m_shockLocation

private

shock location (step)

◆ m_unitSectWidth

bool Sfx::DamBreakData::m_unitSectWidth

private

Section width

◆ m_Xmax

float64 Sfx::DamBreakData::m_Xmax

private

x-coordinate of the right bound. node

◆ m_Xmin

float64 Sfx::DamBreakData::m_Xmin

private

x-coordinate of the left bound. node

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

DamBreakSimulator/SfxBase/Sfx_DamBreakData.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ pairofloat64

Member Enumeration Documentation

◆ eDataTypes

Constructor & Destructor Documentation

◆ DamBreakData() [1/2]

◆ DamBreakData() [2/2]

Member Function Documentation

◆ dambreakExtent()

◆ domainExtent()

◆ dX()

◆ getCFL()

◆ getDiscrType()

◆ getPhi0()

◆ getPhi1()

◆ getS0am()

◆ getS0av()

◆ getShockLocation()

◆ getWidth()

◆ isFlatBed()

◆ isFrictionLess()

◆ isUnitSectionWidth()

◆ nbSections()

◆ setDiscrType()

◆ setEMcNeilParams()

◆ setHudsonParams()

◆ toString() [1/2]

◆ toString() [2/2]

◆ x_max()

◆ x_min()

Member Data Documentation

◆ m_cfl

◆ m_dambreakExtent

◆ m_discrType

◆ m_domainExtent

◆ m_dX

◆ m_flatBed

◆ m_frictionLess

◆ m_NbSects

◆ m_Phi0

◆ m_Phi1

◆ m_S0am

◆ m_S0av

◆ m_sectWidth

◆ m_shockLocation

◆ m_unitSectWidth

◆ m_Xmax

◆ m_Xmin