Loading [MathJax]/extensions/tex2jax.js
PISM, A Parallel Ice Sheet Model 2.2.2-d6b3a29ca committed by Constantine Khrulev on 2025-03-28
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Attributes | Private Attributes | List of all members
pism::VariableMetadata Class Reference

#include <VariableMetadata.hh>

+ Inheritance diagram for pism::VariableMetadata:

Public Member Functions

 VariableMetadata (const std::string &name, units::System::Ptr system, unsigned int ndims=0)
 
virtual ~VariableMetadata ()=default
 
Attribute operator[] (const std::string &name)
 
ConstAttribute operator[] (const std::string &name) const
 
VariableMetadatalong_name (const std::string &input)
 
VariableMetadatastandard_name (const std::string &input)
 
VariableMetadataunits (const std::string &input)
 
VariableMetadataoutput_units (const std::string &input)
 
double get_number (const std::string &name) const
 Get a single-valued scalar attribute.
 
VariableMetadataset_number (const std::string &name, double value)
 Set a scalar attribute to a single (scalar) value.
 
std::vector< doubleget_numbers (const std::string &name) const
 Get an array-of-doubles attribute.
 
VariableMetadataset_numbers (const std::string &name, const std::vector< double > &values)
 Set a scalar attribute to a single (scalar) value.
 
std::string get_name () const
 
VariableMetadataset_name (const std::string &name)
 
std::string get_string (const std::string &name) const
 Get a string attribute.
 
VariableMetadataset_string (const std::string &name, const std::string &value)
 Set a string attribute.
 
VariableMetadataset_units_without_validation (const std::string &value)
 
bool get_time_independent () const
 
VariableMetadataset_time_independent (bool flag)
 
io::Type get_output_type () const
 
VariableMetadataset_output_type (io::Type type)
 
VariableMetadataclear ()
 Clear all attributes.
 
units::System::Ptr unit_system () const
 
unsigned int n_spatial_dimensions () const
 
bool has_attribute (const std::string &name) const
 
bool has_attributes () const
 
const std::map< std::string, std::string > & all_strings () const
 
const std::map< std::string, std::vector< double > > & all_doubles () const
 
void report_to_stdout (const Logger &log, int verbosity_threshold) const
 
void check_range (const std::string &filename, double min, double max) const
 Check if the range [min, max] is a subset of [valid_min, valid_max].
 
void report_range (const Logger &log, double min, double max) const
 Report the range of a global Vec v.
 

Protected Attributes

unsigned int m_n_spatial_dims
 

Private Attributes

units::System::Ptr m_unit_system
 The unit system to use.
 
std::map< std::string, std::string > m_strings
 string and boolean attributes
 
std::map< std::string, std::vector< double > > m_doubles
 scalar and array attributes
 
std::string m_short_name
 
bool m_time_independent
 
io::Type m_output_type
 

Detailed Description

Definition at line 99 of file VariableMetadata.hh.


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