casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
NumberDensity Class Reference

Number Density value with units. More...

#include <ATMNumberDensity.h>

Public Member Functions

 NumberDensity ()
 Default constructor. More...
 
 NumberDensity (double numberdensity)
 A full constructor: Number Density value assumed by default to be in m**-3 (International System) More...
 
 NumberDensity (double numberdensity, const string &units)
 A full constructor: Number Density value + unit. More...
 
virtual ~NumberDensity ()
 Destructor. More...
 
double get () const
 Accessor to the numberdensity value in International System units (K) More...
 
double get (const string &units) const
 Accessor to the numberdensity value in specified units. More...
 
NumberDensityoperator= (const NumberDensity &rhs)
 
NumberDensityoperator= (const double &rhs)
 
NumberDensity operator+ (const NumberDensity &rhs)
 
NumberDensity operator- (const NumberDensity &rhs)
 
NumberDensity operator* (double scf)
 
NumberDensity operator* (float scf)
 
NumberDensity operator* (int scf)
 
NumberDensity operator* (unsigned int scf)
 
NumberDensity operator/ (double scf)
 
NumberDensity operator/ (float scf)
 
NumberDensity operator/ (int scf)
 
NumberDensity operator/ (unsigned int scf)
 
bool operator< (const NumberDensity &rhs) const
 
bool operator> (const NumberDensity &rhs) const
 
bool operator<= (const NumberDensity &rhs) const
 
bool operator>= (const NumberDensity &rhs) const
 
bool operator== (const NumberDensity &rhs) const
 
bool operator!= (const NumberDensity &rhs) const
 

Private Attributes

double valueIS_
 

Detailed Description

Number Density value with units.

This class defines physical parameters having units of Number Density. For example, the profiles of minor gases, such as O3, are in number density. Default is m**-3 (International System).

Definition at line 45 of file ATMNumberDensity.h.

Constructor & Destructor Documentation

NumberDensity::NumberDensity ( )

Default constructor.

Referenced by operator*(), operator+(), operator-(), and operator/().

NumberDensity::NumberDensity ( double  numberdensity)

A full constructor: Number Density value assumed by default to be in m**-3 (International System)

NumberDensity::NumberDensity ( double  numberdensity,
const string &  units 
)

A full constructor: Number Density value + unit.

Valid units are m**-3 [M**-3], cm**-3 [CM**-3]. If none of these implented units is given, the SI value will be returned.

virtual NumberDensity::~NumberDensity ( )
virtual

Destructor.

Member Function Documentation

double NumberDensity::get ( ) const
inline
double NumberDensity::get ( const string &  units) const

Accessor to the numberdensity value in specified units.

Valid units are K [k], mK [mk], and C [c]

bool NumberDensity::operator!= ( const NumberDensity rhs) const
inline

Definition at line 81 of file ATMNumberDensity.h.

References get(), and valueIS_.

NumberDensity NumberDensity::operator* ( double  scf)
inline

Definition at line 68 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator* ( float  scf)
inline

Definition at line 69 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator* ( int  scf)
inline

Definition at line 70 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator* ( unsigned int  scf)
inline

Definition at line 71 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator+ ( const NumberDensity rhs)
inline

Definition at line 66 of file ATMNumberDensity.h.

References get(), NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator- ( const NumberDensity rhs)
inline

Definition at line 67 of file ATMNumberDensity.h.

References get(), NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator/ ( double  scf)
inline

Definition at line 72 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator/ ( float  scf)
inline

Definition at line 73 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator/ ( int  scf)
inline

Definition at line 74 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

NumberDensity NumberDensity::operator/ ( unsigned int  scf)
inline

Definition at line 75 of file ATMNumberDensity.h.

References NumberDensity(), and valueIS_.

bool NumberDensity::operator< ( const NumberDensity rhs) const
inline

Definition at line 76 of file ATMNumberDensity.h.

References get(), and valueIS_.

bool NumberDensity::operator<= ( const NumberDensity rhs) const
inline

Definition at line 78 of file ATMNumberDensity.h.

References get(), and valueIS_.

NumberDensity& NumberDensity::operator= ( const NumberDensity rhs)
inline

Definition at line 64 of file ATMNumberDensity.h.

References valueIS_.

NumberDensity& NumberDensity::operator= ( const double &  rhs)
inline

Definition at line 65 of file ATMNumberDensity.h.

References valueIS_.

bool NumberDensity::operator== ( const NumberDensity rhs) const
inline

Definition at line 80 of file ATMNumberDensity.h.

References get(), and valueIS_.

bool NumberDensity::operator> ( const NumberDensity rhs) const
inline

Definition at line 77 of file ATMNumberDensity.h.

References get(), and valueIS_.

bool NumberDensity::operator>= ( const NumberDensity rhs) const
inline

Definition at line 79 of file ATMNumberDensity.h.

References get(), and valueIS_.

Member Data Documentation

double NumberDensity::valueIS_
private

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