dbpp::DamBreakWaveSimulator Class Reference

Abstract class that serve as base class intending to implement dam break wave simulator. More...

#include <dbpp_DamBreakWaveSimulator.h>

Inheritance diagram for dbpp::DamBreakWaveSimulator:

Public Types
enum class	eSurfaceWaveForm { SINE = 0 , DAMSTEP = 1 }
enum class	eRiverBedForm { FLAT = 0 , STEP = 1 , JUMP = 2 }

Public Member Functions
bool	init () override
	initialize simulator
void	run () override
	main loop of the simulator
void	unInitialize () override
	clean-up
virtual std::valarray< float64 >	getH () const noexcept=0
	water level of each section

Protected Member Functions
	DamBreakWaveSimulator (const DamBreakWaveSimulator &)=default
	implicit conversion disabled
	DamBreakWaveSimulator (DamBreakWaveSimulator &&)=default
	implicit conversion disabled

Protected Attributes
std::shared_ptr< Sfx::WaveFunc >	m_Z
std::shared_ptr< Sfx::WaveFunc >	m_H
eSurfaceWaveForm	m_InitWaveForm
eRiverBedForm	m_RiverBed
std::vector< float64 >	m_waveProfile

Detailed Description

Abstract class that serve as base class intending to implement dam break wave simulator.

Member Enumeration Documentation

eRiverBedForm

enum class dbpp::DamBreakWaveSimulator::eRiverBedForm

strong

An enum type. Initial bed (topography) profile

Enumerator
FLAT	not variable topography
STEP	variable topography (step)
JUMP	hydraulic jump

eSurfaceWaveForm

enum class dbpp::DamBreakWaveSimulator::eSurfaceWaveForm

strong

alias An enum type. Initial solution profile

Enumerator
SINE	sine function wave form
DAMSTEP	step function

Constructor & Destructor Documentation

DamBreakWaveSimulator() [1/2]

dbpp::DamBreakWaveSimulator::DamBreakWaveSimulator ( const DamBreakWaveSimulator & )

protecteddefault

implicit conversion disabled

Parameters

another

object to copy from

DamBreakWaveSimulator() [2/2]

dbpp::DamBreakWaveSimulator::DamBreakWaveSimulator ( DamBreakWaveSimulator && )

protecteddefault

implicit conversion disabled

Parameters

another

object to move from

Member Function Documentation

getH()

virtual std::valarray< float64 > dbpp::DamBreakWaveSimulator::getH ( ) const

pure virtualnoexcept

water level of each section

Returns

array of values

init()

bool dbpp::DamBreakWaveSimulator::init ( )

override

initialize simulator

Returns

true/false on success

run()

void dbpp::DamBreakWaveSimulator::run ( )

inlineoverride

main loop of the simulator

unInitialize()

void dbpp::DamBreakWaveSimulator::unInitialize ( )

inlineoverride

clean-up

Member Data Documentation

m_H

std::shared_ptr<Sfx::WaveFunc> dbpp::DamBreakWaveSimulator::m_H

protected

initial surface function

m_InitWaveForm

eSurfaceWaveForm dbpp::DamBreakWaveSimulator::m_InitWaveForm

protected

Surface wave form

m_RiverBed

eRiverBedForm dbpp::DamBreakWaveSimulator::m_RiverBed

protected

river topography profile

m_waveProfile

std::vector<float64> dbpp::DamBreakWaveSimulator::m_waveProfile

protected

water depth level

m_Z

std::shared_ptr<Sfx::WaveFunc> dbpp::DamBreakWaveSimulator::m_Z

protected

depth function (is it Z?)

---

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

• DamBreakSimulator/Nov_VS2019/dbpp_DamBreakWaveSimulator.h
• DamBreakSimulator/Nov_VS2019/dbpp_DamBreakWaveSimulator.cpp