PISM, A Parallel Ice Sheet Model  stable v2.0.4 committed by Constantine Khrulev on 2022-05-25 12:02:27 -0800
pism::MaxTimestep Class Reference

Combines the max. time step with the flag indicating if a restriction is active. Makes is possible to use the less-than operator (and std::min, etc) to choose the stricter of two restrictions. More...

#include <MaxTimestep.hh>

## Public Member Functions

MaxTimestep ()
Create an instance corresponding to an "inactive" time-step restriction (in other words, $$\Delta t = \infty$$). More...

MaxTimestep (double value)
Create an instance corresponding to a max time step of value. More...

MaxTimestep (const std::string &new_description)

MaxTimestep (double value, const std::string &new_description)
Create an instance and provide a description. More...

bool finite () const
Convert to bool to check if a time step restriction is "active". More...

bool infinite () const

double value () const
Get the value of the maximum time step. More...

std::string description () const

## Private Attributes

bool m_finite

double m_value

std::string m_description

## Detailed Description

Combines the max. time step with the flag indicating if a restriction is active. Makes is possible to use the less-than operator (and std::min, etc) to choose the stricter of two restrictions.

Definition at line 31 of file MaxTimestep.hh.

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