Block-Structured AMR Software Framework
amrex::FabArrayBase::BDKey Struct Reference

#include <AMReX_FabArrayBase.H>

Public Member Functions

 BDKey () noexcept=default
 
 BDKey (const BoxArray::RefID &baid, const DistributionMapping::RefID &dmid) noexcept
 
bool operator< (const BDKey &rhs) const noexcept
 
bool operator== (const BDKey &rhs) const noexcept
 
bool operator!= (const BDKey &rhs) const noexcept
 

Private Attributes

BoxArray::RefID m_ba_id
 
DistributionMapping::RefID m_dm_id
 

Friends

std::ostream & operator<< (std::ostream &os, const BDKey &id)
 

Detailed Description

Key for unique combination of BoxArray and DistributionMapping Note both BoxArray and DistributionMapping are reference counted. Objects with the same references have the same key.

Constructor & Destructor Documentation

◆ BDKey() [1/2]

amrex::FabArrayBase::BDKey::BDKey ( )
defaultnoexcept

◆ BDKey() [2/2]

amrex::FabArrayBase::BDKey::BDKey ( const BoxArray::RefID baid,
const DistributionMapping::RefID dmid 
)
inlinenoexcept

Member Function Documentation

◆ operator!=()

bool amrex::FabArrayBase::BDKey::operator!= ( const BDKey rhs) const
inlinenoexcept

◆ operator<()

bool amrex::FabArrayBase::BDKey::operator< ( const BDKey rhs) const
inlinenoexcept

◆ operator==()

bool amrex::FabArrayBase::BDKey::operator== ( const BDKey rhs) const
inlinenoexcept

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const BDKey id 
)
friend

Member Data Documentation

◆ m_ba_id

BoxArray::RefID amrex::FabArrayBase::BDKey::m_ba_id
private

◆ m_dm_id

DistributionMapping::RefID amrex::FabArrayBase::BDKey::m_dm_id
private

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