![]() |
DamBreak++ Wave Simulator 0.3
DamBreak++ Simulation Framework
|
Abstract class that serve as base class intending to implement dam break wave simulator. More...
#include <dbpp_DamBreakWaveSimulator.h>
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 |
Abstract class that serve as base class intending to implement dam break wave simulator.
|
strong |
|
strong |
|
protecteddefault |
implicit conversion disabled
| another | object to copy from |
|
protecteddefault |
implicit conversion disabled
| another | object to move from |
|
pure virtualnoexcept |
water level of each section
|
override |
initialize simulator
|
inlineoverride |
main loop of the simulator
|
inlineoverride |
clean-up
|
protected |
initial surface function
|
protected |
Surface wave form
|
protected |
river topography profile
|
protected |
water depth level
|
protected |
depth function (is it Z?)