ICAROUS
•All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
larcfm::RecoveryInformation Class Reference

Public Member Functions

 RecoveryInformation (double t, int nfactor, double hs, double vs)
 
int nFactor () const
 
double timeToRecovery () const
 
double timeToToRecovery (const std::string &u) const
 
double recoveryHorizontalDistance () const
 
double recoveryHorizontalDistance (const std::string &u) const
 
double recoveryVerticalDistance () const
 
double recoveryVerticalDistance (const std::string &u) const
 
bool recoveryBandsComputed () const
 
bool recoveryBandsSaturated () const
 
std::string toString () const
 
std::string toStringUnits (const std::string &hunits, const std::string &vunits) const
 
std::string toPVS () const
 

Private Attributes

double time_
 
int nfactor_
 
double horizontal_distance_
 
double vertical_distance_
 

Member Function Documentation

◆ nFactor()

int larcfm::RecoveryInformation::nFactor ( ) const
Returns
Number of time the recovery volume was reduced

◆ recoveryBandsComputed()

bool larcfm::RecoveryInformation::recoveryBandsComputed ( ) const
Returns
True if recovery bands are computed.

◆ recoveryBandsSaturated()

bool larcfm::RecoveryInformation::recoveryBandsSaturated ( ) const
Returns
True if recovery are computed, but they are saturated.

◆ recoveryHorizontalDistance() [1/2]

double larcfm::RecoveryInformation::recoveryHorizontalDistance ( ) const
Returns
Recovery horizontal distance in internal units, i.e., [m]

◆ recoveryHorizontalDistance() [2/2]

double larcfm::RecoveryInformation::recoveryHorizontalDistance ( const std::string &  u) const
Returns
Recovery horizontal distance in given units

◆ recoveryVerticalDistance() [1/2]

double larcfm::RecoveryInformation::recoveryVerticalDistance ( ) const
Returns
Recovery vertical distance in internal units, i.e., [m]

◆ recoveryVerticalDistance() [2/2]

double larcfm::RecoveryInformation::recoveryVerticalDistance ( const std::string &  u) const
Returns
Recovery vertical distance in given units

◆ timeToRecovery()

double larcfm::RecoveryInformation::timeToRecovery ( ) const
Returns
Time to recovery in seconds

◆ timeToToRecovery()

double larcfm::RecoveryInformation::timeToToRecovery ( const std::string &  u) const
Returns
Time to recovery in given units
The documentation for this class was generated from the following files:
Generated by doxygen 1.9.2