tsunami_lab::setups::Setup Class Reference

#include <Setup.h>

Inheritance diagram for tsunami_lab::setups::Setup:

Public Member Functions
virtual	~Setup ()
virtual t_real	getHeight (t_real i_x, t_real i_y) const =0
virtual t_real	getMomentumX (t_real i_x, t_real i_y) const =0
virtual t_real	getMomentumY (t_real i_x, t_real i_y) const =0
virtual t_real	getBathymetry (t_real i_x, t_real i_y) const =0

Detailed Description

Base setup.

Constructor & Destructor Documentation

~Setup()

virtual tsunami_lab::setups::Setup::~Setup ( )

inlinevirtual

Virtual destructor for base class.

Member Function Documentation

getBathymetry()

virtual t_real tsunami_lab::setups::Setup::getBathymetry ( t_real i_x, t_real i_y ) const

pure virtual

Gets the bathymetry.

Parameters

i_x	x-coordinate of the queried point.
i_y	y-coordinate of the queried point.

Returns

bathymetry.

Implemented in tsunami_lab::setups::ArtificialTsunami2d, tsunami_lab::setups::CheckPoint, tsunami_lab::setups::CircularDamBreak2d, tsunami_lab::setups::CircularDamBreakObstacle2d, tsunami_lab::setups::DamBreak1d, tsunami_lab::setups::RareRare1d, tsunami_lab::setups::Reservoir, tsunami_lab::setups::ShockShock1d, tsunami_lab::setups::Subcritical, tsunami_lab::setups::Supercritical, tsunami_lab::setups::TsunamiEvent1d, and tsunami_lab::setups::TsunamiEvent2d.

getHeight()

virtual t_real tsunami_lab::setups::Setup::getHeight ( t_real i_x, t_real i_y ) const

pure virtual

Gets the water height at a given point.

Parameters

i_x	x-coordinate of the queried point.
i_y	y-coordinate of the queried point.

Returns

water height at the given point.

Implemented in tsunami_lab::setups::ArtificialTsunami2d, tsunami_lab::setups::CheckPoint, tsunami_lab::setups::CircularDamBreak2d, tsunami_lab::setups::CircularDamBreakObstacle2d, tsunami_lab::setups::DamBreak1d, tsunami_lab::setups::RareRare1d, tsunami_lab::setups::Reservoir, tsunami_lab::setups::ShockShock1d, tsunami_lab::setups::Subcritical, tsunami_lab::setups::Supercritical, tsunami_lab::setups::TsunamiEvent1d, and tsunami_lab::setups::TsunamiEvent2d.

getMomentumX()

virtual t_real tsunami_lab::setups::Setup::getMomentumX ( t_real i_x, t_real i_y ) const

pure virtual

Gets the momentum in x-direction.

Parameters

i_x	x-coordinate of the queried point.
i_y	y-coordinate of the queried point.

Returns

momentum in x-direction.

Implemented in tsunami_lab::setups::ArtificialTsunami2d, tsunami_lab::setups::CheckPoint, tsunami_lab::setups::CircularDamBreak2d, tsunami_lab::setups::CircularDamBreakObstacle2d, tsunami_lab::setups::DamBreak1d, tsunami_lab::setups::RareRare1d, tsunami_lab::setups::Reservoir, tsunami_lab::setups::ShockShock1d, tsunami_lab::setups::Subcritical, tsunami_lab::setups::Supercritical, tsunami_lab::setups::TsunamiEvent1d, and tsunami_lab::setups::TsunamiEvent2d.

getMomentumY()

virtual t_real tsunami_lab::setups::Setup::getMomentumY ( t_real i_x, t_real i_y ) const

pure virtual

Gets the momentum in y-direction.

Parameters

i_x	x-coordinate of the queried point.
i_y	y-coordinate of the queried point.

Returns

momentum in y-direction.

Implemented in tsunami_lab::setups::ArtificialTsunami2d, tsunami_lab::setups::CheckPoint, tsunami_lab::setups::CircularDamBreak2d, tsunami_lab::setups::CircularDamBreakObstacle2d, tsunami_lab::setups::DamBreak1d, tsunami_lab::setups::RareRare1d, tsunami_lab::setups::Reservoir, tsunami_lab::setups::ShockShock1d, tsunami_lab::setups::Subcritical, tsunami_lab::setups::Supercritical, tsunami_lab::setups::TsunamiEvent1d, and tsunami_lab::setups::TsunamiEvent2d.

---

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

• /builds/na48gom/tsunami/src/setups/Setup.h