Tsunami Project Lab
Loading...
Searching...
No Matches
tsunami_lab::setups::CheckPoint Class Reference

#include <CheckPoint.h>

Inheritance diagram for tsunami_lab::setups::CheckPoint:
Collaboration diagram for tsunami_lab::setups::CheckPoint:

Public Member Functions

 CheckPoint (std::string i_path)
 
t_real getHeight (t_real i_x, t_real i_y) const
 
t_real getMomentumX (t_real i_x, t_real i_y) const
 
t_real getMomentumY (t_real i_x, t_real i_y) const
 
t_real getBathymetry (t_real i_x, t_real i_y) const
 
t_real simTime () const
 simulation time stored in the checkpoint (seconds)
 
t_idx timeStep () const
 time-step counter stored in the checkpoint
 
t_real dt () const
 constant time step of the interrupted run (seconds)
 
t_idx nx () const
 number of interior cells in x-direction
 
t_idx ny () const
 number of interior cells in y-direction
 
t_real dxy () const
 uniform cell size recovered from the checkpoint (m)
 
t_real domainLengthX () const
 domain length in x-direction (nx * dxy)
 
t_real domainLengthY () const
 domain length in y-direction (ny * dxy)
 
- Public Member Functions inherited from tsunami_lab::setups::Setup
virtual ~Setup ()
 

Constructor & Destructor Documentation

◆ CheckPoint()

tsunami_lab::setups::CheckPoint::CheckPoint ( std::string i_path)

Constructor — loads the checkpoint file.

Parameters
i_pathpath to the checkpoint netCDF file.
Author
Moritz Arnhold, Moritz Martin

DESCRIPTION

Restart setup driven by a netCDF checkpoint (assignment 7.1 task 2).

Member Function Documentation

◆ domainLengthX()

t_real tsunami_lab::setups::CheckPoint::domainLengthX ( ) const
inline

domain length in x-direction (nx * dxy)

◆ domainLengthY()

t_real tsunami_lab::setups::CheckPoint::domainLengthY ( ) const
inline

domain length in y-direction (ny * dxy)

◆ dt()

t_real tsunami_lab::setups::CheckPoint::dt ( ) const
inline

constant time step of the interrupted run (seconds)

◆ dxy()

t_real tsunami_lab::setups::CheckPoint::dxy ( ) const
inline

uniform cell size recovered from the checkpoint (m)

◆ getBathymetry()

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

Bathymetry at the recovered cell nearest to (i_x, i_y).

Implements tsunami_lab::setups::Setup.

◆ getHeight()

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

Water height at the recovered cell nearest to (i_x, i_y).

Implements tsunami_lab::setups::Setup.

◆ getMomentumX()

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

x-momentum at the recovered cell nearest to (i_x, i_y).

Implements tsunami_lab::setups::Setup.

◆ getMomentumY()

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

y-momentum at the recovered cell nearest to (i_x, i_y).

Implements tsunami_lab::setups::Setup.

◆ nx()

t_idx tsunami_lab::setups::CheckPoint::nx ( ) const
inline

number of interior cells in x-direction

◆ ny()

t_idx tsunami_lab::setups::CheckPoint::ny ( ) const
inline

number of interior cells in y-direction

◆ simTime()

t_real tsunami_lab::setups::CheckPoint::simTime ( ) const
inline

simulation time stored in the checkpoint (seconds)

◆ timeStep()

t_idx tsunami_lab::setups::CheckPoint::timeStep ( ) const
inline

time-step counter stored in the checkpoint


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