Global instance of the simulation. Hold the different parameters of run (simulation parameters). Use the CRTP (Curious Recursive Template Pattern) known as static polymorphism) More...

#include <Sfx_SimulationMgr.h>

Inheritance diagram for Sfx::SimulationMgr:

Public Types
enum class	eInitialWaveProfile { SINE , STEP }
	Initial wave profile. More...
enum class	eRiverBedType { FLATBED = 0 , ONESTEP = 1 , HYDJUMP = 2 , RANDOM = 3 }
	Bottom topography type. More...
enum class	eFrictionType { NoFriction , FrictionValue }
enum class	ePhysicalBCType { EMcNeilBC , EllignoBC }
	Physical boundary condition. More...

Public Member Functions
void	updateTime ()
	Use this method to set the time during any point during the simulation.
void	setStartTime (float64 aStartTime) noexcept
	Use this method to specify the time at the start of the simulation.
void	setStopTime (float64 aStopTime) noexcept
	simulation stop time
void	setNumTimeStep (uint32 aNumTimeStep) noexcept
	Set the number of time-step.
float64	getStartTime () const noexcept
	Getter.
float64	getStopTime () const noexcept
	Getter.
float64	getTime () noexcept
	Getter.
void	setTimeStep (const float64 aTimeStep) noexcept
	Setter.
float64	getTimeStep () noexcept
	Time stepping.
bool	useFixedTimeStep () noexcept
	Fix/variable time step.
bool	onStart ()
	Entry point.
void	registerSimulator (std::shared_ptr< Sfx::Simulator > aSim)
	Set instance of simulator.
void	setTolerance (float32 aTolerance)
	solution accuracy tolerance factor
float32	getTolerance ()
	Getter.
std::shared_ptr< Sfx::Simulator >	getSimulator () const
	Returns simulator instance.
void	setNujicAlphaCoeff (float64 aAlphaCoeff)
	Coefficient used in the numerical flux algorithm (Nujic)
float64	getNujicAlphaCoeff () const
	Nujic coefficent use in Numerical flux calculation.
float64	getCFL () const noexcept
	Courant-Friedrich-Levy number of the simulation.
void	setCFL (const float64 aCFL) noexcept
	Set CFL number.
bool	useFriction () const noexcept
	Friction flag ON?OFF.
void	setUseFriction (bool aUseFriction) noexcept
	Set friction flag ON/OFF.
bool	useFlatBed () const noexcept
	Flat bed flag ON/OFF.
void	setUseFlatBed (bool aUseFlatBed) noexcept
	Set flat bed flag ON/OFF.
bool	isUnitWidth () const noexcept
void	setManningCoeff (float64 aNcoeff) noexcept
	Manning coefficient.
float64	getManningCoeff () const noexcept
	Manning coefficient.
void	setUseSourceTerms (bool aUseSrcTerms) noexcept
bool	getUseSourceTerms () const noexcept
bool	usePressure () const noexcept
void	setUsePressure (bool aUsePressure) noexcept
void	setUseReconstruction (bool aUseReconstr) noexcept
bool	useReconstruction () const noexcept
bool	isRunning () const noexcept
	Simulation status.
void	setRunning (bool aIsRunning=true)
	Set simulation status.
void	startSimulation () noexcept
	Start simulation.
void	stopSimulation () noexcept
	Stop simulation.
void	setNbIterationsMax (uint32 aNumOfIterMax) noexcept
uint32	getNbIterationsMax () const noexcept
	Geter.
void	incrIteration () noexcept
	increment the number of iteration
uint32	getNbIterations () const noexcept
	Getter.
void	setNbIterations (uint32 aNumOfIterations) noexcept
	Set number iterations.
void	saveScenario ()
	parameters used to perform (reproduce) the simulation
void	loadSections (std::string_view aFileName="SectionIni.txt")
	load section from input file
void	setDBdataType (DamBreakData::eDataTypes aType) noexcept
	Setter.
float64	getPhi0 () const noexcept
	Dam Break problem initial water depth upstream.
float64	getPhi1 () const noexcept
	Dam Break problem initial water depth downstream.
void	setPhi1 (float64 aPhi1) noexcept
	Setter.
void	setPhi0 (float64 aPhi0) noexcept
	Setter.
DamBreakData::eDataTypes	getDBdataType () const noexcept
std::string	getDBdataTypeStr () const noexcept
std::string	getAlgorithmName () const
	Flux Numerical algorithm name for the current simulation.
void	setMethodName (const std::string &aMethodName)
std::string	getPtrFluxAlgorithmName () const noexcept
	Numerical algorithm for the current simulation (ptr-2-function)
void	setPtrFluxAlgorithmName (const std::string &aMethodName)
	Pointer-to-function name.
CalculFF	getPtr2FAlgorithm (const std::string &aMethodName)
	Ptr-2-function convective flux algorithm.
CalculFF	currentAlgorithm () const
	Numerical flux algorithm.
mapFluxSchemeName	getMapSchemeName () const
	Getter.
const std::vector< float64 > &	getBottom () const
	flat bed only supported for now (debug purpose)
void	setupEnvironment ()
	Manning coefficient.
void	printParamOfRun () const
	Print the parameters of run for this simulation.
void	setNbSections (uint32 aNbSections) noexcept
	Setter.
uint32	getNbSections () const noexcept
	Getter.
void	setSectionType (dbpp::SectionFlow::eSectionType aSectype) noexcept
	Setter.
dbpp::SectionFlow::eSectionType	getSectionType () const noexcept
	Getter.
void	setDomainExtent (std::pair< float64, float64 > aDomainExt) noexcept
	Set computational domain extent.
std::pair< float64, float64 >	getDomainExtent () const noexcept
	Getter.
void	setBottomType (const eRiverBedType aBottomType) noexcept
	River bed type.
eRiverBedType	getBottomType () const noexcept
	Getter.
void	setFrictionValue (float64 aFrictionType) noexcept
	Set section flow friction value.
float64	getFrictionValue () const noexcept
	Global friction value.
void	setBCType (const ePhysicalBCType aBCType) noexcept
	Physical boundary type.
ePhysicalBCType	getBCType () const noexcept
void	setInitialWaveForm (eInitialWaveProfile aType) noexcept
	Set/Get Initial profile.
eInitialWaveProfile	getInitialWaveForm () const noexcept
	initial wave profile
void	registerDamBreakSystem (const Testvs19::DamBreakSystem *aDbSys)
	DamBreak physical system.
std::vector< float64 >	getWaterDepth () const
	Getter.

Protected Member Functions
	SimulationMgr ()
	Default ctor (protected denied access)
	~SimulationMgr ()=default
	Destructor ctor (protected denied access)
	SimulationMgr (const SimulationMgr &aOther)=delete
	copy not allowed
SimulationMgr &	operator= (const SimulationMgr &aOther)=delete
	assignment not allowed

Private Attributes
std::shared_ptr< Sfx::Simulator >	m_DamSim
CalculFF	m_Algorithm
DamBreakData::eDataTypes	m_dbDataType
float32	m_Tol
float64	m_CFL
float64	m_phi0
float64	m_phi1
uint32	m_NumTimeStep
uint32	m_NbSections
float64	m_TimeStep
uint32	m_StateVarCount
bool	m_useFriction
bool	m_usePressure
bool	m_useSourceTerms
bool	m_useReconstruction
int32	m_NbIterations
int32	m_NbIterMax
bool	m_UseFixedTimeStep
float64	m_startTime
float64	m_stopTime
float64	m_MaxTimeStep
float64	m_LastTime
float64	m_frictionValue
float64	m_alphaCoeff
std::string	m_MethodName
std::string	m_StVenantOut
std::map< std::string, CalculFF >	m_ptr2FuncAlgo
const Testvs19::DamBreakSystem *	m_dbSystem { nullptr }
bool	m_useFlatBed
bool	m_isUnitWidth
bool	m_simRunning
std::string	m_methodName
eInitialWaveProfile	m_InitialWaveform
ePhysicalBCType	m_physBCType
eRiverBedType	m_bottomType
dbpp::SectionFlow::eSectionType	m_sectionType
std::pair< float64, float64 >	m_domainExtent
std::pair< float64, float64 >	m_dambreakExtent

Friends
template<typename>
class	SfxSingleton
	Access to private member.

Detailed Description

Global instance of the simulation. Hold the different parameters of run (simulation parameters). Use the CRTP (Curious Recursive Template Pattern) known as static polymorphism)

Member Enumeration Documentation

◆ eFrictionType

enum class Sfx::SimulationMgr::eFrictionType

strong

Enumerator
NoFriction
FrictionValue

◆ eInitialWaveProfile

enum class Sfx::SimulationMgr::eInitialWaveProfile

strong

Initial wave profile.

Enumerator
SINE	Siniosidal wave profile
STEP	Step profile

◆ ePhysicalBCType

enum class Sfx::SimulationMgr::ePhysicalBCType

strong

Physical boundary condition.

Enumerator
EMcNeilBC
EllignoBC

◆ eRiverBedType

enum class Sfx::SimulationMgr::eRiverBedType

strong

Bottom topography type.

Enumerator
FLATBED	flat bed
ONESTEP	step bottom
HYDJUMP	hydraulic jump
RANDOM	random bottom

Constructor & Destructor Documentation

◆ SimulationMgr() [1/2]

Sfx::SimulationMgr::SimulationMgr ( )

protected

Default ctor (protected denied access)

<

◆ ~SimulationMgr()

Sfx::SimulationMgr::~SimulationMgr ( )

protecteddefault

Destructor ctor (protected denied access)

◆ SimulationMgr() [2/2]

Sfx::SimulationMgr::SimulationMgr ( const SimulationMgr & aOther )

protecteddelete

copy not allowed

Parameters

aOther other object to copy from

Member Function Documentation

◆ currentAlgorithm()

CalculFF Sfx::SimulationMgr::currentAlgorithm ( ) const

inline

Numerical flux algorithm.

Returns: Return the current algorithm in use

◆ getAlgorithmName()

std::string Sfx::SimulationMgr::getAlgorithmName ( ) const

inline

Flux Numerical algorithm name for the current simulation.

Returns: name of the algorithm in use

◆ getBCType()

ePhysicalBCType Sfx::SimulationMgr::getBCType ( ) const

inlinenoexcept

◆ getBottom()

const std::vector< float64 > & Sfx::SimulationMgr::getBottom ( ) const

inline

flat bed only supported for now (debug purpose)

Returns: vector of values (all sections)

◆ getBottomType()

eRiverBedType Sfx::SimulationMgr::getBottomType ( ) const

inlinenoexcept

Getter.

Returns: bottom type

◆ getCFL()

float64 Sfx::SimulationMgr::getCFL ( ) const

inlinenoexcept

Courant-Friedrich-Levy number of the simulation.

Returns: Courant-Friedrich number

◆ getDBdataType()

DamBreakData::eDataTypes Sfx::SimulationMgr::getDBdataType ( ) const

inlinenoexcept

◆ getDBdataTypeStr()

std::string Sfx::SimulationMgr::getDBdataTypeStr ( ) const

inlinenoexcept

◆ getDomainExtent()

std::pair< float64, float64 > Sfx::SimulationMgr::getDomainExtent ( ) const

inlinenoexcept

Getter.

Returns: pair of values (min,max)

◆ getFrictionValue()

float64 Sfx::SimulationMgr::getFrictionValue ( ) const

inlinenoexcept

Global friction value.

Returns: friction coefficient

◆ getInitialWaveForm()

eInitialWaveProfile Sfx::SimulationMgr::getInitialWaveForm ( ) const

inlinenoexcept

initial wave profile

Returns: Wave profile

◆ getManningCoeff()

float64 Sfx::SimulationMgr::getManningCoeff ( ) const

inlinenoexcept

Manning coefficient.

Returns: values (all sections)

◆ getMapSchemeName()

mapFluxSchemeName Sfx::SimulationMgr::getMapSchemeName ( ) const

inline

Getter.

Returns: map of pointer-2-function

◆ getNbIterations()

uint32 Sfx::SimulationMgr::getNbIterations ( ) const

inlinenoexcept

Getter.

Returns: number of iterations

◆ getNbIterationsMax()

uint32 Sfx::SimulationMgr::getNbIterationsMax ( ) const

inlinenoexcept

Geter.

Returns: number of max iterations

◆ getNbSections()

uint32 Sfx::SimulationMgr::getNbSections ( ) const

inlinenoexcept

Getter.

Returns: number of sections

◆ getNujicAlphaCoeff()

float64 Sfx::SimulationMgr::getNujicAlphaCoeff ( ) const

inline

Nujic coefficent use in Numerical flux calculation.

Returns: alpha coefficient

◆ getPhi0()

float64 Sfx::SimulationMgr::getPhi0 ( ) const

inlinenoexcept

Dam Break problem initial water depth upstream.

Returns: value

◆ getPhi1()

float64 Sfx::SimulationMgr::getPhi1 ( ) const

inlinenoexcept

Dam Break problem initial water depth downstream.

Returns: value

◆ getPtr2FAlgorithm()

CalculFF Sfx::SimulationMgr::getPtr2FAlgorithm ( const std::string & aMethodName )

Ptr-2-function convective flux algorithm.

Parameters

aMethodName name of the algorithm

Returns: pointer to function

◆ getPtrFluxAlgorithmName()

std::string Sfx::SimulationMgr::getPtrFluxAlgorithmName ( ) const

inlinenoexcept

Numerical algorithm for the current simulation (ptr-2-function)

Returns: pointer-to-function name

◆ getSectionType()

dbpp::SectionFlow::eSectionType Sfx::SimulationMgr::getSectionType ( ) const

inlinenoexcept

Getter.

Returns: Section geeometry type

◆ getSimulator()

std::shared_ptr< Sfx::Simulator > Sfx::SimulationMgr::getSimulator ( ) const

inline

Returns simulator instance.

Returns: simulator instance

Deprecated: since 1.0 (keep for backward compatibility)

◆ getStartTime()

float64 Sfx::SimulationMgr::getStartTime ( ) const

inlinenoexcept

Getter.

Returns: simulationstart time

◆ getStopTime()

float64 Sfx::SimulationMgr::getStopTime ( ) const

inlinenoexcept

Getter.

Returns: simulation stop time

◆ getTime()

float64 Sfx::SimulationMgr::getTime ( )

inlinenoexcept

Getter.

Returns: Simulation time

◆ getTimeStep()

float64 Sfx::SimulationMgr::getTimeStep ( )

inlinenoexcept

Time stepping.

Returns: Return time step

◆ getTolerance()

float32 Sfx::SimulationMgr::getTolerance ( )

inline

Getter.

Returns: tolerance value

◆ getUseSourceTerms()

bool Sfx::SimulationMgr::getUseSourceTerms ( ) const

inlinenoexcept

◆ getWaterDepth()

std::vector< float64 > Sfx::SimulationMgr::getWaterDepth ( ) const

inline

Getter.

Returns: vector values (water depth)

◆ incrIteration()

void Sfx::SimulationMgr::incrIteration ( )

inlinenoexcept

increment the number of iteration

◆ isRunning()

bool Sfx::SimulationMgr::isRunning ( ) const

inlinenoexcept

Simulation status.

Returns: true/false

◆ isUnitWidth()

bool Sfx::SimulationMgr::isUnitWidth ( ) const

inlinenoexcept

Returns

◆ loadSections()

void Sfx::SimulationMgr::loadSections ( std::string_view aFileName = "SectionIni.txt" )

inline

load section from input file

Parameters

aFileName file name

◆ onStart()

bool Sfx::SimulationMgr::onStart ( )

Entry point.

Returns: true/false on success

Deprecated

◆ operator=()

SimulationMgr & Sfx::SimulationMgr::operator= ( const SimulationMgr & aOther )

protecteddelete

assignment not allowed

Parameters

aOther other object to copy from

◆ printParamOfRun()

void Sfx::SimulationMgr::printParamOfRun ( ) const

Print the parameters of run for this simulation.

◆ registerDamBreakSystem()

void Sfx::SimulationMgr::registerDamBreakSystem ( const Testvs19::DamBreakSystem * aDbSys )

inline

DamBreak physical system.

Parameters

aDbSys Physical system

Deprecated: to be removed in next re-factoring

◆ registerSimulator()

void Sfx::SimulationMgr::registerSimulator ( std::shared_ptr< Sfx::Simulator > aSim )

inline

Set instance of simulator.

Parameters

aSim	DamBreak simulator instance

Deprecated: since 1.0 (keep for backward compatibility)

inline

◆ setNbIterations()

void Sfx::SimulationMgr::setNbIterations ( uint32 aNumOfIterations )

inlinenoexcept

Set number iterations.

Parameters

aNumOfIterations number of iterations

void Sfx::SimulationMgr::setStartTime ( float64 aStartTime )

inlinenoexcept

Use this method to specify the time at the start of the simulation.

◆ setStopTime()

void Sfx::SimulationMgr::setStopTime ( float64 aStopTime )

inlinenoexcept

simulation stop time

Parameters

aStopTime a time to stop

◆ setTimeStep()

void Sfx::SimulationMgr::setTimeStep ( const float64 aTimeStep )

inlinenoexcept

Setter.

Parameters

aTimeStep Simulation time step

◆ setTolerance()

void Sfx::SimulationMgr::setTolerance ( float32 aTolerance )

inline

solution accuracy tolerance factor

Parameters

aTolerance accuracy tolerance

◆ setupEnvironment()

void Sfx::SimulationMgr::setupEnvironment ( )

Manning coefficient.

Returns: vector of values (all sections)

Setting some path and environment variable

◆ setUseFlatBed()

void Sfx::SimulationMgr::setUseFlatBed ( bool aUseFlatBed )

inlinenoexcept

Set flat bed flag ON/OFF.

Parameters

aUseFlatBed

◆ setUseFriction()

void Sfx::SimulationMgr::setUseFriction ( bool aUseFriction )

inlinenoexcept

Set friction flag ON/OFF.

Parameters

aUseFriction boolean value

◆ setUsePressure()

void Sfx::SimulationMgr::setUsePressure ( bool aUsePressure )

inlinenoexcept

◆ setUseReconstruction()

void Sfx::SimulationMgr::setUseReconstruction ( bool aUseReconstr )

inlinenoexcept

◆ setUseSourceTerms()

void Sfx::SimulationMgr::setUseSourceTerms ( bool aUseSrcTerms )

inlinenoexcept

◆ startSimulation()

void Sfx::SimulationMgr::startSimulation ( )

inlinenoexcept

Start simulation.

◆ stopSimulation()

void Sfx::SimulationMgr::stopSimulation ( )

inlinenoexcept

Stop simulation.

◆ updateTime()

void Sfx::SimulationMgr::updateTime ( )

inline

Use this method to set the time during any point during the simulation.

◆ useFixedTimeStep()

bool Sfx::SimulationMgr::useFixedTimeStep ( )

inlinenoexcept

Fix/variable time step.

Returns: Return true/false according

◆ useFlatBed()

bool Sfx::SimulationMgr::useFlatBed ( ) const

inlinenoexcept

Flat bed flag ON/OFF.

Returns: true/false

◆ useFriction()

bool Sfx::SimulationMgr::useFriction ( ) const

inlinenoexcept

Friction flag ON?OFF.

Returns: true/false

◆ usePressure()

bool Sfx::SimulationMgr::usePressure ( ) const

inlinenoexcept

◆ useReconstruction()

bool Sfx::SimulationMgr::useReconstruction ( ) const

inlinenoexcept

◆ SfxSingleton

template<typename>

friend class SfxSingleton

friend

Access to private member.

Template Parameters

simulation instance

Member Data Documentation

◆ m_Algorithm

CalculFF Sfx::SimulationMgr::m_Algorithm

DamBreakData::eDataTypes Sfx::SimulationMgr::m_dbDataType

private

Hudson as default, otherwise EMcNeil

◆ m_dbSystem

const Testvs19::DamBreakSystem* Sfx::SimulationMgr::m_dbSystem { nullptr }

private

◆ m_domainExtent

std::pair<float64,float64> Sfx::SimulationMgr::m_domainExtent

private

◆ m_frictionValue

float64 Sfx::SimulationMgr::m_frictionValue

private

...

◆ m_InitialWaveform

eInitialWaveProfile Sfx::SimulationMgr::m_InitialWaveform

private

std::string Sfx::SimulationMgr::m_methodName

private

◆ m_NbIterations

int32 Sfx::SimulationMgr::m_NbIterations

private

number of iterations

◆ m_NbIterMax

int32 Sfx::SimulationMgr::m_NbIterMax

private

maximum number of iterations

◆ m_NbSections

uint32 Sfx::SimulationMgr::m_NbSections

private

◆ m_NumTimeStep

uint32 Sfx::SimulationMgr::m_NumTimeStep

private

number of time step for the simulation

◆ m_phi0

float64 Sfx::SimulationMgr::m_phi0

private

◆ m_phi1

float64 Sfx::SimulationMgr::m_phi1

private

◆ m_physBCType

ePhysicalBCType Sfx::SimulationMgr::m_physBCType

private

◆ m_ptr2FuncAlgo

std::map<std::string, CalculFF> Sfx::SimulationMgr::m_ptr2FuncAlgo

private

Map the different algorithm with a string (name)

◆ m_sectionType

dbpp::SectionFlow::eSectionType Sfx::SimulationMgr::m_sectionType

private

bool Sfx::SimulationMgr::m_useFlatBed

private

◆ m_useFriction

bool Sfx::SimulationMgr::m_useFriction

private

flag (default w_value is false)

◆ m_usePressure

bool Sfx::SimulationMgr::m_usePressure

private

flag (default w_value is false)

◆ m_useReconstruction

bool Sfx::SimulationMgr::m_useReconstruction

private

flag (default w_value is true)

◆ m_useSourceTerms

bool Sfx::SimulationMgr::m_useSourceTerms

private

flag (default w_value is true)

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

DamBreakSimulator/include/Sfx_SimulationMgr.h
DamBreakSimulator/source/Sfx_SimulationMgr.cxx

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ eFrictionType

◆ eInitialWaveProfile

◆ ePhysicalBCType

◆ eRiverBedType

Constructor & Destructor Documentation

◆ SimulationMgr() [1/2]

◆ ~SimulationMgr()

◆ SimulationMgr() [2/2]

Member Function Documentation

◆ currentAlgorithm()

◆ getAlgorithmName()

◆ getBCType()

◆ getBottom()

◆ getBottomType()

◆ getCFL()

◆ getDBdataType()

◆ getDBdataTypeStr()

◆ getDomainExtent()

◆ getFrictionValue()

◆ getInitialWaveForm()

◆ getManningCoeff()

◆ getMapSchemeName()

◆ getNbIterations()

◆ getNbIterationsMax()

◆ getNbSections()

◆ getNujicAlphaCoeff()

◆ getPhi0()

◆ getPhi1()

◆ getPtr2FAlgorithm()

◆ getPtrFluxAlgorithmName()

◆ getSectionType()

◆ getSimulator()

◆ getStartTime()

◆ getStopTime()

◆ getTime()

◆ getTimeStep()

◆ getTolerance()

◆ getUseSourceTerms()

◆ getWaterDepth()

◆ incrIteration()

◆ isRunning()

◆ isUnitWidth()

◆ loadSections()

◆ onStart()

◆ operator=()

◆ printParamOfRun()

◆ registerDamBreakSystem()

◆ registerSimulator()

◆ saveScenario()

◆ setBCType()

◆ setBottomType()

◆ setCFL()

◆ setDBdataType()

◆ setDomainExtent()

◆ setFrictionValue()

◆ setInitialWaveForm()

◆ setManningCoeff()

◆ setMethodName()

◆ setNbIterations()

◆ setNbIterationsMax()

◆ setNbSections()

◆ setNujicAlphaCoeff()

◆ setNumTimeStep()

◆ setPhi0()

◆ setPhi1()

◆ setPtrFluxAlgorithmName()

◆ setRunning()

◆ setSectionType()

◆ setStartTime()

◆ setStopTime()

◆ setTimeStep()

◆ setTolerance()

◆ setupEnvironment()