erf_auxiliary::MappedFaceField< Tag > Class Template Reference

#include <ERF_AuxiliaryMappedTransport.H>

Inheritance diagram for erf_auxiliary::MappedFaceField< Tag >:

Collaboration diagram for erf_auxiliary::MappedFaceField< Tag >:

Public Member Functions
	MappedFaceField ()=default
	MappedFaceField (const MappedFaceField &)=delete
MappedFaceField &	operator= (const MappedFaceField &)=delete
	MappedFaceField (MappedFaceField &&) noexcept=default
MappedFaceField &	operator= (MappedFaceField &&) noexcept=default
void	define (const amrex::BoxArray &cell_ba, const amrex::DistributionMapping &dm, const int ncomp, const int ngrow=0)
bool	is_defined () const noexcept
int	nComp () const noexcept
amrex::MultiFab &	dir (const int direction)
const amrex::MultiFab &	dir (const int direction) const
void	setVal (const amrex::Real value)

Private Attributes
std::array< std::unique_ptr< amrex::MultiFab >, AMREX_SPACEDIM >	m_faces {}
int	m_ncomp {0}

Detailed Description

template<typename Tag>
class erf_auxiliary::MappedFaceField< Tag >

A directionally face-centered mapped-coordinate field with a semantic tag.

Constructor & Destructor Documentation

MappedFaceField() [1/3]

template<typename Tag >

erf_auxiliary::MappedFaceField< Tag >::MappedFaceField ( )

default

MappedFaceField() [2/3]

template<typename Tag >

erf_auxiliary::MappedFaceField< Tag >::MappedFaceField ( const MappedFaceField< Tag > &  )

delete

MappedFaceField() [3/3]

template<typename Tag >

erf_auxiliary::MappedFaceField< Tag >::MappedFaceField ( MappedFaceField< Tag > &&  )

defaultnoexcept

Member Function Documentation

define()

template<typename Tag >

void erf_auxiliary::MappedFaceField< Tag >::define ( const amrex::BoxArray &  cell_ba, const amrex::DistributionMapping &  dm, const int  ncomp, const int  ngrow = 0  )

inline

    {
        AMREX_ALWAYS_ASSERT(ncomp > 0);
        AMREX_ALWAYS_ASSERT(ngrow >= 0);
        m_ncomp = ncomp;
        for (int dir = 0; dir < AMREX_SPACEDIM; ++dir) {
            m_faces[static_cast<std::size_t>(dir)] = std::make_unique<amrex::MultiFab>(
                amrex::convert(cell_ba, amrex::IntVect::TheDimensionVector(dir)),
                dm, ncomp, ngrow);
        }
    }

Referenced by erf_auxiliary::CompletedStepFluxLedger::define(), and ERF::estTimeStep().

Here is the call graph for this function:

Here is the caller graph for this function:

dir() [1/2]

template<typename Tag >

amrex::MultiFab& erf_auxiliary::MappedFaceField< Tag >::dir ( const int  direction )

inline

    {
        AMREX_ALWAYS_ASSERT(direction >= 0 && direction < AMREX_SPACEDIM);
        AMREX_ALWAYS_ASSERT(m_faces[static_cast<std::size_t>(direction)] != nullptr);
        return *m_faces[static_cast<std::size_t>(direction)];
    }

Referenced by erf_auxiliary::CompletedStepFluxLedger::accumulate_stage_component(), erf_auxiliary::AccumulateIntegratedFaceFlux(), erf_auxiliary::ApplyAuxiliaryMappedStage(), erf_auxiliary::ApplyMappedFluxTendency(), erf_auxiliary::BuildMappedDryAirCarrierFluxRate(), erf_auxiliary::ComputeMaxMappedOutgoingRate(), erf_auxiliary::CopyNativeMappedDryAirCarrierFluxRate(), erf_auxiliary::MappedFaceField< Tag >::define(), erf_auxiliary::CompletedStepFluxLedger::finish_stage(), erf_auxiliary::MappedFaceLayoutMatchesCellLayout(), erf_auxiliary::MaxFaceFieldDifference(), and erf_auxiliary::SameMappedFaceLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

dir() [2/2]

template<typename Tag >

const amrex::MultiFab& erf_auxiliary::MappedFaceField< Tag >::dir ( const int  direction ) const

inline

    {
        AMREX_ALWAYS_ASSERT(direction >= 0 && direction < AMREX_SPACEDIM);
        AMREX_ALWAYS_ASSERT(m_faces[static_cast<std::size_t>(direction)] != nullptr);
        return *m_faces[static_cast<std::size_t>(direction)];
    }

Here is the call graph for this function:

is_defined()

template<typename Tag >

bool erf_auxiliary::MappedFaceField< Tag >::is_defined ( ) const

inlinenoexcept

{ return m_ncomp > 0; }

Referenced by erf_auxiliary::CompletedStepFluxLedger::accept_stage(), erf_auxiliary::CompletedStepFluxLedger::accumulate_stage_component(), erf_auxiliary::AccumulateIntegratedFaceFlux(), erf_auxiliary::ApplyAuxiliaryMappedStage(), erf_auxiliary::ApplyMappedFluxTendency(), erf_auxiliary::BuildMappedDryAirCarrierFluxRate(), erf_auxiliary::ComputeMaxMappedOutgoingRate(), erf_auxiliary::CopyNativeMappedDryAirCarrierFluxRate(), erf_auxiliary::CompletedStepFluxLedger::discard_step(), erf_auxiliary::CompletedStepFluxLedger::is_defined(), erf_auxiliary::MappedFaceLayoutMatchesCellLayout(), erf_auxiliary::MaxFaceFieldDifference(), erf_auxiliary::SameMappedFaceLayout(), and erf_auxiliary::MappedFaceField< Tag >::setVal().

Here is the caller graph for this function:

nComp()

template<typename Tag >

int erf_auxiliary::MappedFaceField< Tag >::nComp ( ) const

inlinenoexcept

{ return m_ncomp; }

Referenced by erf_auxiliary::CompletedStepFluxLedger::accept_stage(), erf_auxiliary::CompletedStepFluxLedger::accumulate_stage_component(), erf_auxiliary::AccumulateIntegratedFaceFlux(), erf_auxiliary::ApplyAuxiliaryMappedStage(), erf_auxiliary::ApplyMappedFluxTendency(), erf_auxiliary::BuildMappedDryAirCarrierFluxRate(), erf_auxiliary::ComputeMaxMappedOutgoingRate(), erf_auxiliary::CopyNativeMappedDryAirCarrierFluxRate(), erf_auxiliary::CompletedStepFluxLedger::finish_stage(), and erf_auxiliary::MaxFaceFieldDifference().

Here is the caller graph for this function:

operator=() [1/2]

template<typename Tag >

MappedFaceField& erf_auxiliary::MappedFaceField< Tag >::operator= ( const MappedFaceField< Tag > &  )

delete

operator=() [2/2]

template<typename Tag >

MappedFaceField& erf_auxiliary::MappedFaceField< Tag >::operator= ( MappedFaceField< Tag > &&  )

defaultnoexcept

setVal()

template<typename Tag >

void erf_auxiliary::MappedFaceField< Tag >::setVal ( const amrex::Real  value )

inline

    {
        AMREX_ALWAYS_ASSERT(is_defined());
        for (auto& face : m_faces) { face->setVal(value); }
    }

Referenced by erf_auxiliary::CompletedStepFluxLedger::begin_stage(), erf_auxiliary::CompletedStepFluxLedger::define(), and erf_auxiliary::CompletedStepFluxLedger::discard_step().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_faces

template<typename Tag >

std::array<std::unique_ptr<amrex::MultiFab>, AMREX_SPACEDIM> erf_auxiliary::MappedFaceField< Tag >::m_faces {}

private

Referenced by erf_auxiliary::MappedFaceField< Tag >::define(), erf_auxiliary::MappedFaceField< Tag >::dir(), and erf_auxiliary::MappedFaceField< Tag >::setVal().

m_ncomp

template<typename Tag >

int erf_auxiliary::MappedFaceField< Tag >::m_ncomp {0}

private

Referenced by erf_auxiliary::MappedFaceField< Tag >::define(), erf_auxiliary::MappedFaceField< Tag >::is_defined(), and erf_auxiliary::MappedFaceField< Tag >::nComp().

---

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

• Source/AuxiliaryState/ERF_AuxiliaryMappedTransport.H