SWE
Public Member Functions
SWE_AsagiScenario Class Reference
Inheritance diagram for SWE_AsagiScenario:
SWE_Scenario

List of all members.

Public Member Functions

 SWE_AsagiScenario (const std::string i_bathymetryFile, const std::string i_displacementFile, const float i_duration, const float i_simulationArea[4], const bool i_dynamicDisplacement=false)
void deleteGrids ()
float getWaterHeight (float i_positionX, float i_positionY)
float getBathymetry (const float i_positionX, const float i_positionY)
float getBathymetryAndDynamicDisplacement (const float i_positionX, const float i_positionY, const float i_time)
bool dynamicDisplacementAvailable (const float i_time)
float endSimulation ()
BoundaryType getBoundaryType (BoundaryEdge i_edge)
float getBoundaryPos (BoundaryEdge i_edge)

Constructor & Destructor Documentation

SWE_AsagiScenario::SWE_AsagiScenario ( const std::string  i_bathymetryFile,
const std::string  i_displacementFile,
const float  i_duration,
const float  i_simulationArea[4],
const bool  i_dynamicDisplacement = false 
) [inline]

Constructor of an Asagi Scenario, which initializes the corresponding Asagi grids.

Parameters:
i_originXorigin of the simulation area (x-direction)
i_originYorigin of the simulation area (y-direction)
i_bathymetryFilepath to the netCDF-bathymetry file
i_displacementFilepath to the netCDF-displacement file
i_durationtime the simulation runs (in seconds)

Member Function Documentation

bool SWE_AsagiScenario::dynamicDisplacementAvailable ( const float  i_time) [inline]

Check if there is an dynamic displacement is available for the corresponding time.

Parameters:
i_timecurrent simulation time
Returns:
true if there is data available, false else
float SWE_AsagiScenario::endSimulation ( ) [inline, virtual]

Get the number of seconds, the simulation should run.

Returns:
number of seconds, the simulation should run

Reimplemented from SWE_Scenario.

float SWE_AsagiScenario::getBathymetry ( const float  i_positionX,
const float  i_positionY 
) [inline, virtual]

Get the bathymetry including static displacement at a specific location

Parameters:
i_positionXposition relative to the origin of the displacement grid in x-direction
i_positionYposition relative to the origin of the displacement grid in y-direction
Returns:
bathymetry (after the initial displacement (static displacement)

Reimplemented from SWE_Scenario.

float SWE_AsagiScenario::getBathymetryAndDynamicDisplacement ( const float  i_positionX,
const float  i_positionY,
const float  i_time 
) [inline]

Get the bathymetry including dynamic displacement at a specific location

Parameters:
i_positionXposition relative to the origin of the displacement grid in x-direction
i_positionYposition relative to the origin of the displacement grid in y-direction
i_timetime relative to the origin of the dynamic displacement
Returns:
bathymetry (after the initial displacement (static displacement), after the specified amount of time (dynamic displacement))
float SWE_AsagiScenario::getBoundaryPos ( BoundaryEdge  i_edge) [inline, virtual]

Get the boundary positions

Parameters:
i_edgewhich edge
Returns:
value in the corresponding dimension

Reimplemented from SWE_Scenario.

Get the boundary types of the simulation

Parameters:
edgespecific edge
Returns:
type of the edge

Reimplemented from SWE_Scenario.

float SWE_AsagiScenario::getWaterHeight ( float  i_positionX,
float  i_positionY 
) [inline, virtual]

Get the water height at a specific location (before the initial displacement).

Parameters:
i_positionXposition relative to the origin of the bathymetry grid in x-direction
i_positionYposition relative to the origin of the bathymetry grid in y-direction
Returns:
water height (before the initial displacement)

Reimplemented from SWE_Scenario.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends