ERF
Energy Research and Forecasting: An Atmospheric Modeling Code
erf_auxiliary::AuxiliaryStateLayout Class Reference

#include <ERF_AuxiliaryStateLayout.H>

Collaboration diagram for erf_auxiliary::AuxiliaryStateLayout:

Public Member Functions

 AuxiliaryStateLayout ()=default
 
 AuxiliaryStateLayout (std::string schema_id, std::vector< ComponentDescriptor > components)
 
const std::string & schema_id () const noexcept
 
int ncomp () const noexcept
 
const std::vector< ComponentDescriptor > & components () const noexcept
 

Private Attributes

std::string m_schema_id
 
std::vector< ComponentDescriptor > m_components
 

Detailed Description

Generic metadata for an auxiliary state. The generic layer deliberately knows nothing about microphysics, bins, or water species.

Constructor & Destructor Documentation

◆ AuxiliaryStateLayout() [1/2]

erf_auxiliary::AuxiliaryStateLayout::AuxiliaryStateLayout ( )
default

◆ AuxiliaryStateLayout() [2/2]

erf_auxiliary::AuxiliaryStateLayout::AuxiliaryStateLayout ( std::string  schema_id,
std::vector< ComponentDescriptor >  components 
)
inline
26  : m_schema_id(std::move(schema_id)), m_components(std::move(components)) {}
std::vector< ComponentDescriptor > m_components
Definition: ERF_AuxiliaryStateLayout.H:36
std::string m_schema_id
Definition: ERF_AuxiliaryStateLayout.H:35
const std::vector< ComponentDescriptor > & components() const noexcept
Definition: ERF_AuxiliaryStateLayout.H:30
const std::string & schema_id() const noexcept
Definition: ERF_AuxiliaryStateLayout.H:28

Member Function Documentation

◆ components()

const std::vector<ComponentDescriptor>& erf_auxiliary::AuxiliaryStateLayout::components ( ) const
inlinenoexcept
30  {
31  return m_components;
32  }

◆ ncomp()

int erf_auxiliary::AuxiliaryStateLayout::ncomp ( ) const
inlinenoexcept
29 { return static_cast<int>(m_components.size()); }

Referenced by erf_auxiliary::AuxiliaryInertTracer::initialize().

Here is the caller graph for this function:

◆ schema_id()

const std::string& erf_auxiliary::AuxiliaryStateLayout::schema_id ( ) const
inlinenoexcept
28 { return m_schema_id; }

Referenced by erf_auxiliary::AuxiliaryInertTracer::initialize().

Here is the caller graph for this function:

Member Data Documentation

◆ m_components

std::vector<ComponentDescriptor> erf_auxiliary::AuxiliaryStateLayout::m_components
private

Referenced by components(), and ncomp().

◆ m_schema_id

std::string erf_auxiliary::AuxiliaryStateLayout::m_schema_id
private

Referenced by schema_id().


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