Canoe
Comprehensive Atmosphere N' Ocean Engine
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Friends | List of all members
AirParcel Class Reference

#include <air_parcel.hpp>

Public Types

enum  { Size = NHYDRO + NCLOUD + NCHEMISTRY + NTRACER + NTURBULENCE }
 
enum class  Type { MassFrac = 0 , MassConc = 1 , MoleFrac = 2 , MoleConc = 3 }
 

Public Member Functions

 AirParcel (Type type=Type::MoleFrac)
 
 AirParcel (AirParcel const &other)
 
AirParcel & operator= (const AirParcel &other)
 
void SetType (Type type)
 
Type GetType () const
 
void SetZero ()
 
AirParcel & ConvertTo (AirParcel::Type type)
 
AirParcel & ToMassFraction ()
 
AirParcel & ToMassConcentration ()
 
AirParcel & ToMoleFraction ()
 
AirParcel & ToMoleConcentration ()
 

Public Attributes

Real *const w
 
Real *const c
 cloud data More...
 
Real *const q
 chemistry data More...
 
Real *const x
 tracer data More...
 
Real *const t
 turbulence data More...
 
Real const * d
 particle data More...
 

Protected Member Functions

void massFractionToMassConcentration ()
 
void massConcentrationToMassFraction ()
 
void massFractionToMoleFraction ()
 
void moleFractionToMassFraction ()
 
void massConcentrationToMoleFraction ()
 
void moleFractionToMassConcentration ()
 
void moleFractionToMoleConcentration ()
 
void moleConcentrationToMoleFraction ()
 
void massConcentrationToMoleConcentration ()
 
void moleConcentrationToMassConcentration ()
 
void massFractionToMoleConcentration ()
 
void moleConcentrationToMassFraction ()
 

Protected Attributes

std::array< Real, Size > data_
 
Type mytype_
 

Friends

std::ostream & operator<< (std::ostream &os, Type const &type)
 
std::ostream & operator<< (std::ostream &os, AirParcel const &var)
 

Detailed Description

Definition at line 17 of file air_parcel.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
Size 

Definition at line 19 of file air_parcel.hpp.

◆ Type

enum AirParcel::Type
strong
Enumerator
MassFrac 
MassConc 
MoleFrac 
MoleConc 

Definition at line 21 of file air_parcel.hpp.

Constructor & Destructor Documentation

◆ AirParcel() [1/2]

AirParcel::AirParcel ( Type  type = Type::MoleFrac)
inlineexplicit

Definition at line 54 of file air_parcel.hpp.

◆ AirParcel() [2/2]

AirParcel::AirParcel ( AirParcel const &  other)
inline

Definition at line 66 of file air_parcel.hpp.

Member Function Documentation

◆ operator=()

AirParcel& AirParcel::operator= ( const AirParcel &  other)
inline

Definition at line 77 of file air_parcel.hpp.

◆ SetType()

void AirParcel::SetType ( Type  type)
inline

Definition at line 88 of file air_parcel.hpp.

◆ GetType()

Type AirParcel::GetType ( ) const
inline

Definition at line 90 of file air_parcel.hpp.

◆ SetZero()

void AirParcel::SetZero ( )
inline

Definition at line 92 of file air_parcel.hpp.

◆ ConvertTo()

AirParcel & AirParcel::ConvertTo ( AirParcel::Type  type)

Definition at line 48 of file air_parcel.cpp.

◆ ToMassFraction()

AirParcel & AirParcel::ToMassFraction ( )

Definition at line 68 of file air_parcel.cpp.

◆ ToMassConcentration()

AirParcel & AirParcel::ToMassConcentration ( )

Definition at line 86 of file air_parcel.cpp.

◆ ToMoleFraction()

AirParcel & AirParcel::ToMoleFraction ( )

Definition at line 104 of file air_parcel.cpp.

◆ ToMoleConcentration()

AirParcel & AirParcel::ToMoleConcentration ( )

Definition at line 122 of file air_parcel.cpp.

◆ massFractionToMassConcentration()

void AirParcel::massFractionToMassConcentration ( )
protected

Definition at line 298 of file air_parcel.cpp.

◆ massConcentrationToMassFraction()

void AirParcel::massConcentrationToMassFraction ( )
protected

Definition at line 343 of file air_parcel.cpp.

◆ massFractionToMoleFraction()

void AirParcel::massFractionToMoleFraction ( )
protected

Definition at line 140 of file air_parcel.cpp.

◆ moleFractionToMassFraction()

void AirParcel::moleFractionToMassFraction ( )
protected

Definition at line 173 of file air_parcel.cpp.

◆ massConcentrationToMoleFraction()

void AirParcel::massConcentrationToMoleFraction ( )
protected

Definition at line 206 of file air_parcel.cpp.

◆ moleFractionToMassConcentration()

void AirParcel::moleFractionToMassConcentration ( )
protected

Definition at line 252 of file air_parcel.cpp.

◆ moleFractionToMoleConcentration()

void AirParcel::moleFractionToMoleConcentration ( )
protected

Definition at line 392 of file air_parcel.cpp.

◆ moleConcentrationToMoleFraction()

void AirParcel::moleConcentrationToMoleFraction ( )
protected

Definition at line 441 of file air_parcel.cpp.

◆ massConcentrationToMoleConcentration()

void AirParcel::massConcentrationToMoleConcentration ( )
protected

Definition at line 497 of file air_parcel.cpp.

◆ moleConcentrationToMassConcentration()

void AirParcel::moleConcentrationToMassConcentration ( )
protected

Definition at line 501 of file air_parcel.cpp.

◆ massFractionToMoleConcentration()

void AirParcel::massFractionToMoleConcentration ( )
protected

Definition at line 489 of file air_parcel.cpp.

◆ moleConcentrationToMassFraction()

void AirParcel::moleConcentrationToMassFraction ( )
protected

Definition at line 493 of file air_parcel.cpp.

Friends And Related Function Documentation

◆ operator<< [1/2]

std::ostream& operator<< ( std::ostream &  os,
AirParcel::Type const &  type 
)
friend

Definition at line 26 of file air_parcel.cpp.

◆ operator<< [2/2]

std::ostream& operator<< ( std::ostream &  os,
AirParcel const &  var 
)
friend

Definition at line 42 of file air_parcel.cpp.

Member Data Documentation

◆ data_

std::array<Real, Size> AirParcel::data_
protected

Definition at line 28 of file air_parcel.hpp.

◆ mytype_

Type AirParcel::mytype_
protected

Definition at line 31 of file air_parcel.hpp.

◆ w

Real* const AirParcel::w

data pointers hydro data

Definition at line 36 of file air_parcel.hpp.

◆ c

Real* const AirParcel::c

cloud data

Definition at line 39 of file air_parcel.hpp.

◆ q

Real* const AirParcel::q

chemistry data

Definition at line 42 of file air_parcel.hpp.

◆ x

Real* const AirParcel::x

tracer data

Definition at line 45 of file air_parcel.hpp.

◆ t

Real* const AirParcel::t

turbulence data

Definition at line 48 of file air_parcel.hpp.

◆ d

Real const* AirParcel::d

particle data

Definition at line 51 of file air_parcel.hpp.

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