Canoe
Comprehensive Atmosphere N' Ocean Engine
Public Member Functions | Private Attributes | List of all members
SpeciesIndexGroup Class Reference

#include <virtual_groups.hpp>

Inheritance diagram for SpeciesIndexGroup:
[legend]

Public Member Functions

virtual ~SpeciesIndexGroup ()
 
void SetSpeciesIndex (std::vector< std::string > const &species_names)
 Set species index based on species names. More...
 
std::vector< int > const & GetSpeciesIndexArray () const
 
int GetSpeciesIndex (int n) const
 
std::vector< int > const & GetCloudIndexArray () const
 
int GetCloudIndex (int n) const
 
std::vector< int > const & GetChemistryIndexArray () const
 
int GetChemistryIndex (int n) const
 

Private Attributes

std::vector< int > species_index_
 indices of species More...
 
std::vector< int > cloud_index_
 indices of clouds More...
 
std::vector< int > chemistry_index_
 indices of chemical species More...
 

Detailed Description

Definition at line 110 of file virtual_groups.hpp.

Constructor & Destructor Documentation

◆ ~SpeciesIndexGroup()

virtual SpeciesIndexGroup::~SpeciesIndexGroup ( )
inlinevirtual

Definition at line 112 of file virtual_groups.hpp.

Member Function Documentation

◆ SetSpeciesIndex()

void SpeciesIndexGroup::SetSpeciesIndex ( std::vector< std::string > const &  species_names)
inline

Set species index based on species names.

Definition at line 115 of file virtual_groups.hpp.

◆ GetSpeciesIndexArray()

std::vector<int> const& SpeciesIndexGroup::GetSpeciesIndexArray ( ) const
inline
Returns
Array of species indices

Definition at line 126 of file virtual_groups.hpp.

◆ GetSpeciesIndex()

int SpeciesIndexGroup::GetSpeciesIndex ( int  n) const
inline
Returns
The species index of the n-th species

Definition at line 131 of file virtual_groups.hpp.

◆ GetCloudIndexArray()

std::vector<int> const& SpeciesIndexGroup::GetCloudIndexArray ( ) const
inline
Returns
Array of cloud indices

Definition at line 134 of file virtual_groups.hpp.

◆ GetCloudIndex()

int SpeciesIndexGroup::GetCloudIndex ( int  n) const
inline
Returns
The cloud index of the n-th cloud species

Definition at line 137 of file virtual_groups.hpp.

◆ GetChemistryIndexArray()

std::vector<int> const& SpeciesIndexGroup::GetChemistryIndexArray ( ) const
inline
Returns
Array of chemistry indices

Definition at line 140 of file virtual_groups.hpp.

◆ GetChemistryIndex()

int SpeciesIndexGroup::GetChemistryIndex ( int  n) const
inline
Returns
The chemistry index of the n-th chemistry species

Definition at line 145 of file virtual_groups.hpp.

Member Data Documentation

◆ species_index_

std::vector<int> SpeciesIndexGroup::species_index_
private

indices of species

Definition at line 149 of file virtual_groups.hpp.

◆ cloud_index_

std::vector<int> SpeciesIndexGroup::cloud_index_
private

indices of clouds

Definition at line 152 of file virtual_groups.hpp.

◆ chemistry_index_

std::vector<int> SpeciesIndexGroup::chemistry_index_
private

indices of chemical species

Definition at line 155 of file virtual_groups.hpp.

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