PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
pism::TSRateDiagnostic Class Reference

Scalar diagnostic reporting the rate of change of a quantity modeled by PISM. More...

#include <Diagnostic.hh>

+ Inheritance diagram for pism::TSRateDiagnostic:

Public Member Functions

 TSRateDiagnostic (std::shared_ptr< const Grid > g, const std::string &name)
 
- Public Member Functions inherited from pism::TSDiagnostic
 TSDiagnostic (std::shared_ptr< const Grid > g, const std::string &name)
 
virtual ~TSDiagnostic ()
 
void update (double t0, double t1)
 
void flush ()
 
void init (const File &output_file, std::shared_ptr< std::vector< double > > requested_times)
 
const VariableMetadatametadata () const
 

Protected Member Functions

void evaluate (double t0, double t1, double change)
 
- Protected Member Functions inherited from pism::TSDiagnostic
virtual double compute ()=0
 
void set_units (const std::string &units, const std::string &output_units)
 

Protected Attributes

double m_accumulator
 accumulator of changes (used to compute rates of change) More...
 
- Protected Attributes inherited from pism::TSDiagnostic
std::shared_ptr< const Gridm_grid
 the grid More...
 
const Config::ConstPtr m_config
 Configuration flags and parameters. More...
 
const units::System::Ptr m_sys
 the unit system More...
 
std::string m_time_name
 time series object used to store computed values and metadata More...
 
VariableMetadata m_variable
 
VariableMetadata m_dimension
 
VariableMetadata m_time_bounds
 
std::vector< double > m_time
 
std::vector< double > m_bounds
 
std::vector< double > m_values
 
std::shared_ptr< std::vector< double > > m_requested_times
 requested times More...
 
unsigned int m_current_time
 index into m_times More...
 
std::string m_output_filename
 
unsigned int m_start
 starting index used when flushing the buffer More...
 
size_t m_buffer_size
 size of the buffer used to store data More...
 

Private Member Functions

void update_impl (double t0, double t1)
 

Private Attributes

double m_v_previous
 last two values, used to compute the change during a time step More...
 
bool m_v_previous_set
 

Additional Inherited Members

- Public Types inherited from pism::TSDiagnostic
typedef std::shared_ptr< TSDiagnosticPtr
 

Detailed Description

Scalar diagnostic reporting the rate of change of a quantity modeled by PISM.

The rate of change is averaged in time over reporting intervals.

The method compute() should return the instantaneous "snapshot" value of a quantity.

Definition at line 364 of file Diagnostic.hh.


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