Canoe
Comprehensive Atmosphere N' Ocean Engine
IndexMap Class Reference

#include <index_map.hpp>

Public Member Functions

 ~IndexMap ()
 
bool HasVapor (std::string const &name) const
 
size_t GetVaporId (std::string const &name) const
 
std::string GetVaporName (size_t i) const
 
bool HasCloud (std::string const &name) const
 
size_t GetCloudId (std::string const &name) const
 
std::string GetCloudName (size_t i) const
 
bool HasChemistry (std::string const &name) const
 
size_t GetChemistryId (std::string const &name) const
 
bool HasTracer (std::string const &name) const
 
size_t GetTracerId (std::string const &name) const
 
std::string GetTracerName (size_t i) const
 
size_t GetSpeciesId (std::string category_name) const
 

Static Public Member Functions

static IndexMap const * GetInstance ()
 
static IndexMap const * InitFromAthenaInput (ParameterInput *pin)
 
static void Destroy ()
 

Protected Member Functions

 IndexMap ()
 Protected ctor access thru static member function Instance. More...
 

Private Attributes

std::map< std::string, size_t > vapor_index_map_
 
std::map< std::string, size_t > cloud_index_map_
 
std::map< std::string, size_t > chemistry_index_map_
 
std::map< std::string, size_t > tracer_index_map_
 
std::map< std::string, size_t > particle_index_map_
 

Static Private Attributes

static IndexMapmyindex_map_ = nullptr
 Pointer to the single IndexMap instance. More...
 

Detailed Description

Definition at line 10 of file index_map.hpp.

Constructor & Destructor Documentation

◆ IndexMap()

IndexMap::IndexMap ( )
inlineprotected

Protected ctor access thru static member function Instance.

Definition at line 13 of file index_map.hpp.

◆ ~IndexMap()

IndexMap::~IndexMap ( )

Definition at line 24 of file index_map.cpp.

Member Function Documentation

◆ GetInstance()

IndexMap const * IndexMap::GetInstance ( )
static

Definition at line 29 of file index_map.cpp.

◆ InitFromAthenaInput()

IndexMap const * IndexMap::InitFromAthenaInput ( ParameterInput *  pin)
static

Definition at line 40 of file index_map.cpp.

◆ Destroy()

void IndexMap::Destroy ( )
static

Definition at line 144 of file index_map.cpp.

◆ HasVapor()

bool IndexMap::HasVapor ( std::string const &  name) const
inline

Definition at line 24 of file index_map.hpp.

◆ GetVaporId()

size_t IndexMap::GetVaporId ( std::string const &  name) const
inline

Definition at line 28 of file index_map.hpp.

◆ GetVaporName()

std::string IndexMap::GetVaporName ( size_t  i) const

Definition at line 153 of file index_map.cpp.

◆ HasCloud()

bool IndexMap::HasCloud ( std::string const &  name) const
inline

Definition at line 34 of file index_map.hpp.

◆ GetCloudId()

size_t IndexMap::GetCloudId ( std::string const &  name) const
inline

Definition at line 38 of file index_map.hpp.

◆ GetCloudName()

std::string IndexMap::GetCloudName ( size_t  i) const

Definition at line 160 of file index_map.cpp.

◆ HasChemistry()

bool IndexMap::HasChemistry ( std::string const &  name) const
inline

Definition at line 44 of file index_map.hpp.

◆ GetChemistryId()

size_t IndexMap::GetChemistryId ( std::string const &  name) const
inline

Definition at line 48 of file index_map.hpp.

◆ HasTracer()

bool IndexMap::HasTracer ( std::string const &  name) const
inline

Definition at line 52 of file index_map.hpp.

◆ GetTracerId()

size_t IndexMap::GetTracerId ( std::string const &  name) const
inline

Definition at line 56 of file index_map.hpp.

◆ GetTracerName()

std::string IndexMap::GetTracerName ( size_t  i) const

Definition at line 167 of file index_map.cpp.

◆ GetSpeciesId()

size_t IndexMap::GetSpeciesId ( std::string  category_name) const

Definition at line 116 of file index_map.cpp.

Member Data Documentation

◆ vapor_index_map_

std::map<std::string, size_t> IndexMap::vapor_index_map_
private

Definition at line 65 of file index_map.hpp.

◆ cloud_index_map_

std::map<std::string, size_t> IndexMap::cloud_index_map_
private

Definition at line 66 of file index_map.hpp.

◆ chemistry_index_map_

std::map<std::string, size_t> IndexMap::chemistry_index_map_
private

Definition at line 67 of file index_map.hpp.

◆ tracer_index_map_

std::map<std::string, size_t> IndexMap::tracer_index_map_
private

Definition at line 68 of file index_map.hpp.

◆ particle_index_map_

std::map<std::string, size_t> IndexMap::particle_index_map_
private

Definition at line 69 of file index_map.hpp.

◆ myindex_map_

IndexMap * IndexMap::myindex_map_ = nullptr
staticprivate

Pointer to the single IndexMap instance.

Definition at line 72 of file index_map.hpp.


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