amr_wind::DerivedQtyMgr Class Reference

#include <DerivedQuantity.H>

Collaboration diagram for amr_wind::DerivedQtyMgr:

Public Types
using	TypePtr = std::unique_ptr<DerivedQty>
using	TypeVector = amrex::Vector<TypePtr>

Public Member Functions
	DerivedQtyMgr (const FieldRepo &repo)
	~DerivedQtyMgr ()=default
void	operator() (ScratchField &fld, const int scomp=0) const
void	create (const amrex::Vector< std::string > &keys)
DerivedQty &	create (const std::string &key)
	Add a derived quantity.
int	num_comp () const noexcept
	Return the total number of components across all derived quantities.
bool	contains (const std::string &key) const noexcept
void	var_names (amrex::Vector< std::string > &) const noexcept
	Populate a vector of variable names (for output)
void	filter (const std::set< std::string > &)
void	filter (const amrex::Vector< std::string > &)

Private Attributes
const FieldRepo &	m_repo
TypeVector	m_derived_vec
std::unordered_map< std::string, int >	m_obj_map

Member Typedef Documentation

TypePtr

using amr_wind::DerivedQtyMgr::TypePtr = std::unique_ptr<DerivedQty>

TypeVector

using amr_wind::DerivedQtyMgr::TypeVector = amrex::Vector<TypePtr>

Constructor & Destructor Documentation

DerivedQtyMgr()

amr_wind::DerivedQtyMgr::DerivedQtyMgr ( const FieldRepo & repo )

explicit

~DerivedQtyMgr()

amr_wind::DerivedQtyMgr::~DerivedQtyMgr ( )

default

Member Function Documentation

contains()

bool amr_wind::DerivedQtyMgr::contains ( const std::string & key ) const

noexcept

create() [1/2]

void amr_wind::DerivedQtyMgr::create

(

const amrex::Vector< std::string > &

keys

)

create() [2/2]

DerivedQty & amr_wind::DerivedQtyMgr::create

(

const std::string &

key

)

Add a derived quantity.

filter() [1/2]

void amr_wind::DerivedQtyMgr::filter

(

const amrex::Vector< std::string > &

erase

)

filter() [2/2]

void amr_wind::DerivedQtyMgr::filter

(

const std::set< std::string > &

erase

)

num_comp()

int amr_wind::DerivedQtyMgr::num_comp ( ) const

noexcept

Return the total number of components across all derived quantities.

operator()()

void amr_wind::DerivedQtyMgr::operator()	(	ScratchField &	fld,
		const int	scomp = 0 ) const

var_names()

void amr_wind::DerivedQtyMgr::var_names ( amrex::Vector< std::string > & plt_var_names ) const

noexcept

Populate a vector of variable names (for output)

Member Data Documentation

m_derived_vec

TypeVector amr_wind::DerivedQtyMgr::m_derived_vec

private

m_obj_map

std::unordered_map<std::string, int> amr_wind::DerivedQtyMgr::m_obj_map

private

m_repo

const FieldRepo& amr_wind::DerivedQtyMgr::m_repo

private

---

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

• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/DerivedQuantity.H
• /home/runner/work/amr-wind/amr-wind/amr-wind/utilities/DerivedQuantity.cpp