PISM, A Parallel Ice Sheet Model  stable v2.0.6 committed by Constantine Khrulev on 2023-01-23 15:14:38 -0900
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
pism::Vars Class Reference

A class for passing PISM variables from the core to other parts of the code (such as climate couplers). More...

#include <Vars.hh>

Public Types

typedef std::shared_ptr< IceModelVecVecPtr
typedef std::shared_ptr< IceModelVec2SVec2SPtr
typedef std::shared_ptr< IceModelVec2VVec2VPtr
typedef std::shared_ptr< IceModelVec2IntVec2IntPtr
typedef std::shared_ptr< IceModelVec2CellTypeVec2CellTypePtr
typedef std::shared_ptr< IceModelVec3Vec3Ptr

Public Member Functions

 Vars ()
void add (const IceModelVec &)
 Add an IceModelVec to the dictionary. More...
void add (const IceModelVec &, const std::string &name)
 Add an IceModelVec v using the name name. More...
void remove (const std::string &name)
 Removes a variable with the key name from the dictionary. More...
bool is_available (const std::string &name) const
const IceModelVecget (const std::string &name) const
 Returns a pointer to an IceModelVec containing variable name or NULL if that variable was not found. More...
const IceModelVec2Sget_2d_scalar (const std::string &name) const
const IceModelVec2Vget_2d_vector (const std::string &name) const
const IceModelVec2Intget_2d_mask (const std::string &name) const
const IceModelVec2CellTypeget_2d_cell_type (const std::string &name) const
const IceModelVec3get_3d_scalar (const std::string &name) const
std::set< std::string > keys () const
 Returns the set of keys (variable names) in the dictionary. More...
void add_shared (VecPtr)
void add_shared (VecPtr, const std::string &name)
bool is_available_shared (const std::string &name) const
VecPtr get_shared (const std::string &name) const
Vec2SPtr get_2d_scalar_shared (const std::string &name) const
Vec2VPtr get_2d_vector_shared (const std::string &name) const
Vec2IntPtr get_2d_mask_shared (const std::string &name) const
Vec2CellTypePtr get_2d_cell_type_shared (const std::string &name) const
Vec3Ptr get_3d_scalar_shared (const std::string &name) const
std::set< std::string > keys_shared () const

Private Member Functions

const IceModelVecget_internal (const std::string &name) const
VecPtr get_internal_shared (const std::string &name) const
 Vars (Vars const &)
Varsoperator= (Vars const &)

Private Attributes

std::map< std::string, const IceModelVec * > m_variables
std::map< std::string, std::string > m_standard_names
std::map< std::string, VecPtrm_variables_shared
 variables in shared ownership More...

Detailed Description

A class for passing PISM variables from the core to other parts of the code (such as climate couplers).

Definition at line 38 of file Vars.hh.

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