EBAMRData< T > Class Template Reference

Default class for holding LevelData<T> data across an EBAMR realm. More...

#include <CD_EBAMRData.H>

Public Member Functions
	EBAMRData () noexcept
	Default constructor. Does nothing.
	EBAMRData (int a_size) noexcept
	Destructor. Sets m_data to size a_size but does not allocate anything.
virtual	~EBAMRData () noexcept
	Destructor. Does nothing.
RefCountedPtr< LevelData< T > > &	operator[] (int a_level) noexcept
	Indexing operators. Returns m_data[a_level].
const RefCountedPtr< LevelData< T > > &	operator[] (int a_level) const noexcept
	Indexing operators. Returns const m_data[a_level].
void	resize (int a_size) noexcept
	Resize m_data to having size a_size.
void	setRealm (const std::string &a_realm) noexcept
	Sets the realm for this object.
int	size () const noexcept
	Get size of m_data.
void	exchange () noexcept
	Exchange on all AMR levels.
void	clear () noexcept
	Delete all data.
void	reserve () noexcept
	Reserve data.
void	release () noexcept
	Release data.
bool	isReserved () const noexcept
	Check if data is reserved.
Vector< RefCountedPtr< LevelData< T > > > &	getData () noexcept
	Get underlying data. Returns m_data.
const Vector< RefCountedPtr< LevelData< T > > > &	getData () const noexcept
	Get underlying data. Returns const m_data.
void	push_back (RefCountedPtr< LevelData< T > > &a_levelData) noexcept
	Push a LevelData<T> object to the back of the data vector.
const std::string	getRealm () const noexcept
	Returns the string identifier for whatever realm this data is supposed to be allocated over.

Protected Attributes
std::string	m_realm
	Identifier for realm.
bool	m_reserved
	Reserved or not.
Vector< RefCountedPtr< LevelData< T > > >	m_data
	Underlying data.

Detailed Description

template<typename T>
class EBAMRData< T >

Default class for holding LevelData<T> data across an EBAMR realm.

This class is a base class for holding LevelData<T> over a realm. The class does not have arithmetic operators or assignment operators because LevelData<T> does not have them. Manipulating the data is done directly by fetching the data on a level through the indexing operator [], or by fetching all the data through getData.

Constructor & Destructor Documentation

EBAMRData()

template<typename T >

EBAMRData< T >::EBAMRData ( int  a_size )

noexcept

Destructor. Sets m_data to size a_size but does not allocate anything.

Parameters

[in]

a_size

Description

Member Function Documentation

getData() [1/2]

template<typename T >

const Vector< RefCountedPtr< LevelData< T > > > & EBAMRData< T >::getData ( ) const

noexcept

Get underlying data. Returns const m_data.

Returns

Data

getData() [2/2]

template<typename T >

Vector< RefCountedPtr< LevelData< T > > > & EBAMRData< T >::getData ( )

noexcept

Get underlying data. Returns m_data.

Returns

Data

getRealm()

template<typename T >

const std::string EBAMRData< T >::getRealm ( ) const

noexcept

Returns the string identifier for whatever realm this data is supposed to be allocated over.

Returns

Realm

isReserved()

template<typename T >

bool EBAMRData< T >::isReserved ( ) const

noexcept

Check if data is reserved.

Returns

True if reserved, false otherwise

operator[]() [1/2]

template<typename T >

const RefCountedPtr< LevelData< T > > & EBAMRData< T >::operator[] ( int  a_level ) const

noexcept

Indexing operators. Returns const m_data[a_level].

Parameters

[in]

a_level

Grid level

Returns

Return value

operator[]() [2/2]

template<typename T >

RefCountedPtr< LevelData< T > > & EBAMRData< T >::operator[] ( int  a_level )

noexcept

Indexing operators. Returns m_data[a_level].

Parameters

[in]

a_level

Grid level

Returns

Return value

push_back()

template<typename T >

void EBAMRData< T >::push_back ( RefCountedPtr< LevelData< T > > &  a_levelData )

noexcept

Push a LevelData<T> object to the back of the data vector.

Parameters

[in]

a_levelData

Data to append to vector

resize()

template<typename T >

void EBAMRData< T >::resize ( int  a_size )

noexcept

Resize m_data to having size a_size.

Parameters

[in]

a_size

Data size

setRealm()

template<typename T >

void EBAMRData< T >::setRealm ( const std::string &  a_realm )

noexcept

Sets the realm for this object.

Parameters

[in]

a_realm

Realm name

size()

template<typename T >

int EBAMRData< T >::size ( ) const

noexcept

Get size of m_data.

Returns

Return value

---

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

• Source/AmrMesh/CD_EBAMRData.H
• Source/AmrMesh/CD_EBAMRDataImplem.H