MooseArray< T > Class Template Reference

forward declarations More...

#include <MooseArray.h>

Public Member Functions
	MooseArray ()
	Default constructor. More...
	MooseArray (const unsigned int size)
	MooseArray (const unsigned int size, const T &default_value)
	MooseArray (const MooseArray &rhs)
void	setAllValues (const T &value)
	Sets all values of the array to the passed in value. More...
void	release ()
	Manually deallocates the data pointer. More...
void	clear ()
	Change the number of elements the array can store to zero. More...
void	resize (unsigned int size)
	Change the number of elements the array can store. More...
void	resize (unsigned int size, const T &default_value)
	Change the number of elements the array can store. More...
unsigned int	size () const
	The number of elements that can currently be stored in the array. More...
T &	operator[] (const unsigned int i)
	Get element i out of the array. More...
const T &	operator[] (const unsigned int i) const
	Get element i out of the array. More...
void	swap (MooseArray &rhs)
	Swap memory in this object with the 'rhs' object. More...
void	shallowCopy (const MooseArray &rhs)
	Doesn't actually make a copy of the data. More...
void	shallowCopy (std::vector< T > &rhs)
	Doesn't actually make a copy of the data. More...
MooseArray< T > &	operator= (const std::vector< T > &rhs)
	Actual operator=... More...
MooseArray< T > &	operator= (const MooseArray< T > &rhs)
	Actual operator=... More...
std::vector< T >	stdVector () const
	Extremely inefficient way to produce a std::vector from a MooseArray! More...
const T *	data () const
	Reference to first element of array. More...

Private Attributes
std::unique_ptr< T[]>	_data_ptr
	Smart pointer storage. More...
T *	_data
unsigned int	_size
	The current number of elements the array can hold. More...
unsigned int	_allocated_size
	Number of allocated memory positions for storage. More...

Detailed Description

template<typename T>
class MooseArray< T >

forward declarations

Definition at line 17 of file MooseArray.h.

Constructor & Destructor Documentation

MooseArray() [1/4]

template<typename T>

MooseArray< T >::MooseArray ( )

inline

Default constructor.

Doesn't initialize anything.

Definition at line 23 of file MooseArray.h.

: _data(nullptr), _size(0), _allocated_size(0) {}

MooseArray() [2/4]

template<typename T>

MooseArray< T >::MooseArray ( const unsigned int  size )

inlineexplicit

Parameters

size	The initial size of the array.

Definition at line 28 of file MooseArray.h.

                                               : _data(nullptr), _allocated_size(0)
  {
    resize(size);
  }

MooseArray() [3/4]

template<typename T>

MooseArray< T >::MooseArray ( const unsigned int  size, const T &  default_value  )

inlineexplicit

Parameters

size	The initial size of the array.
default_value	The default value to set.

Definition at line 37 of file MooseArray.h.

    : _data(nullptr), _allocated_size(0)
  {
    resize(size);

    setAllValues(default_value);
  }

MooseArray() [4/4]

template<typename T>

MooseArray< T >::MooseArray ( const MooseArray< T > &  rhs )

inlineexplicit

Definition at line 45 of file MooseArray.h.

                                              : _data(nullptr), _allocated_size(0)
  {
    resize(rhs._size);

    for (unsigned int i = 0; i < _size; i++)
      _data[i] = rhs._data[i];
  }

Member Function Documentation

clear()

template<typename T >

void MooseArray< T >::clear ( )

inline

Change the number of elements the array can store to zero.

Will destroy data currently in array!

Note that this does not free unused memory. This is done for speed.

Definition at line 212 of file MooseArray.h.

{
  _size = 0;
}

data()

template<typename T>

const T* MooseArray< T >::data ( ) const

inline

Reference to first element of array.

Definition at line 186 of file MooseArray.h.

{ return _data; }

operator=() [1/2]

template<typename T>

MooseArray< T > & MooseArray< T >::operator= ( const std::vector< T > &  rhs )

inline

Actual operator=...

really does make a copy of the data

If you don't want a copy use shallowCopy()

Definition at line 313 of file MooseArray.h.

{
  unsigned int rhs_size = rhs.size();

  resize(rhs_size);

  for (unsigned int i = 0; i < rhs_size; i++)
    _data[i] = rhs[i];

  return *this;
}

operator=() [2/2]

template<typename T>

MooseArray< T > & MooseArray< T >::operator= ( const MooseArray< T > &  rhs )

inline

Actual operator=...

really does make a copy of the data

If you don't want a copy use shallowCopy()

Definition at line 327 of file MooseArray.h.

{
  //  mooseError("Shouldn't be doing this!");
  resize(rhs._size);
  //  memcpy(_data,rhs._data,sizeof(T)*_size);

  for (unsigned int i = 0; i < _size; i++)
    _data[i] = rhs._data[i];

  return *this;
}

operator[]() [1/2]

template<typename T >

T & MooseArray< T >::operator[] ( const unsigned int  i )

inline

Get element i out of the array.

Definition at line 266 of file MooseArray.h.

{
  mooseAssert(i < _size,
              "Access out of bounds in MooseArray (i: " << i << " size: " << _size << ")");

  return _data[i];
}

operator[]() [2/2]

template<typename T >

const T & MooseArray< T >::operator[] ( const unsigned int  i ) const

inline

Get element i out of the array.

Definition at line 275 of file MooseArray.h.

{
  mooseAssert(i < _size,
              "Access out of bounds in MooseArray (i: " << i << " size: " << _size << ")");

  return _data[i];
}

release()

template<typename T>

void MooseArray< T >::release ( )

inline

Manually deallocates the data pointer.

Definition at line 62 of file MooseArray.h.

Referenced by Assembly::modifyFaceWeightsDueToXFEM(), Assembly::modifyWeightsDueToXFEM(), Assembly::~Assembly(), and Coupleable::~Coupleable().

  {
    if (_data_ptr)
    {
      _data_ptr.reset();
      _data = nullptr;
      _allocated_size = _size = 0;
    }
  }

resize() [1/2]

template<typename T >

void MooseArray< T >::resize ( unsigned int  size )

inline

Change the number of elements the array can store.

Will allocate more memory if necessary.

Can destroy data currently in array! Basically, data retention not guaranteed.

Note that this does not free unused memory. This is done for speed.

Definition at line 219 of file MooseArray.h.

Referenced by MooseVariableConstMonomial::computeMonomialNeighborValuesHelper(), MooseVariableConstMonomial::computeMonomialValuesHelper(), Coupleable::Coupleable(), MooseArray< Real >::MooseArray(), MooseVariableFE< Real >::MooseVariableFE(), Assembly::reinitFE(), Assembly::reinitFEFace(), Assembly::reinitNeighbor(), and Assembly::setCoordinateTransformation().

{
  if (size <= _allocated_size)
    _size = size;
  else
  {
    _data_ptr.reset(new T[size]);
    mooseAssert(_data_ptr, "Failed to allocate MooseArray memory!");

    _data = _data_ptr.get();
    _allocated_size = size;
    _size = size;
  }
}

resize() [2/2]

template<typename T>

void MooseArray< T >::resize ( unsigned int  size, const T &  default_value  )

inline

Change the number of elements the array can store.

Will allocate more memory if necessary.

Can destroy data currently in array! Basically, data retention not guaranteed.

Note that this does not free unused memory. This is done for speed.

Also note that default_value is only applied to NEW entries.

Definition at line 236 of file MooseArray.h.

{
  if (size > _allocated_size)
  {
    T * new_pointer = new T[size];
    mooseAssert(new_pointer, "Failed to allocate MooseArray memory!");

    if (_data)
      for (unsigned int i = 0; i < _size; i++)
        new_pointer[i] = _data[i];

    _data_ptr.reset(new_pointer);
    _data = _data_ptr.get();
    _allocated_size = size;
  }

  for (unsigned int i = _size; i < size; i++)
    _data[i] = default_value;

  _size = size;
}

setAllValues()

template<typename T>

void MooseArray< T >::setAllValues ( const T &  value )

inline

Sets all values of the array to the passed in value.

Parameters

value

The value every entry of the array will be set to.

Definition at line 204 of file MooseArray.h.

Referenced by MooseArray< Real >::MooseArray().

{
  for (unsigned int i = 0; i < _size; i++)
    _data[i] = value;
}

shallowCopy() [1/2]

template<typename T >

void MooseArray< T >::shallowCopy ( const MooseArray< T > &  rhs )

inline

Doesn't actually make a copy of the data.

Just makes this object operate on the same data.

Note! You can leak memory with this function if you don't take care to have a copy of this array somewhere else. This is because the data pointer will get overridden here.

Definition at line 295 of file MooseArray.h.

Referenced by Assembly::reinitFE(), Assembly::reinitFEFace(), and Assembly::reinitNeighborAtPhysical().

{
  _data = rhs._data;
  _size = rhs._size;
  _allocated_size = rhs._allocated_size;
}

shallowCopy() [2/2]

template<typename T>

void MooseArray< T >::shallowCopy ( std::vector< T > &  rhs )

inline

Doesn't actually make a copy of the data.

Just makes this object operate on the same data.

Note! You can leak memory with this function if you don't take care to have a copy of this array somewhere else. This is because the data pointer will get overridden here.

I repeat! This is an extremely dangerous function!

DO NOT USE UNLESS YOU KNOW WHAT YOU ARE DOING!

YOU HAVE BEEN WARNED!

Definition at line 304 of file MooseArray.h.

{
  _data = &rhs[0];
  _size = rhs.size();
  _allocated_size = rhs.size();
}

size()

template<typename T >

unsigned int MooseArray< T >::size ( ) const

inline

The number of elements that can currently be stored in the array.

Definition at line 260 of file MooseArray.h.

Referenced by NodalPatchRecovery::compute(), Assembly::computeGradPhiAD(), VectorKernel::computeJacobian(), VectorIntegratedBC::computeJacobian(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), GeometricSearchData::generateMortarNodes(), GeometricSearchData::generateQuadratureNodes(), MaterialStdVectorAux::getRealValue(), Assembly::modifyFaceWeightsDueToXFEM(), Assembly::modifyWeightsDueToXFEM(), MooseArray< Real >::MooseArray(), MooseVariableFE< Real >::phiFaceNeighborSize(), MooseVariableFE< Real >::phiFaceSize(), MooseVariableFE< Real >::phiNeighborSize(), MooseVariableFE< Real >::phiSize(), GeometricSearchData::updateMortarNodes(), and GeometricSearchData::updateQuadratureNodes().

{
  return _size;
}

stdVector()

template<class T >

std::vector< T > MooseArray< T >::stdVector

(

)

const

Extremely inefficient way to produce a std::vector from a MooseArray!

Returns

A copy of the MooseArray contents.

Definition at line 341 of file MooseArray.h.

Referenced by Assembly::reinitElemAndNeighbor().

{
  return std::vector<T>(_data, _data + _size);
}

swap()

template<typename T >

void MooseArray< T >::swap ( MooseArray< T > &  rhs )

inline

Swap memory in this object with the 'rhs' object.

Parameters

rhs	The object we are swapping with

Definition at line 285 of file MooseArray.h.

{
  _data_ptr.swap(rhs._data_ptr);
  std::swap(_data, rhs._data);
  std::swap(_size, rhs._size);
  std::swap(_allocated_size, rhs._allocated_size);
}

Member Data Documentation

_allocated_size

template<typename T>

unsigned int MooseArray< T >::_allocated_size

private

Number of allocated memory positions for storage.

Definition at line 199 of file MooseArray.h.

Referenced by MooseArray< Real >::release(), MooseArray< Real >::shallowCopy(), and MooseArray< Real >::swap().

_data

template<typename T>

T* MooseArray< T >::_data

private

Definition at line 193 of file MooseArray.h.

Referenced by MooseArray< Real >::data(), MooseArray< Real >::MooseArray(), MooseArray< Real >::operator=(), MooseArray< Real >::release(), MooseArray< Real >::shallowCopy(), and MooseArray< Real >::swap().

_data_ptr

template<typename T>

std::unique_ptr<T[]> MooseArray< T >::_data_ptr

private

Smart pointer storage.

Definition at line 190 of file MooseArray.h.

Referenced by MooseArray< Real >::release(), and MooseArray< Real >::swap().

_size

template<typename T>

unsigned int MooseArray< T >::_size

private

The current number of elements the array can hold.

Definition at line 196 of file MooseArray.h.

Referenced by MooseArray< Real >::MooseArray(), MooseArray< Real >::operator=(), MooseArray< Real >::release(), MooseArray< Real >::shallowCopy(), and MooseArray< Real >::swap().

---

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

• include/utils/MooseArray.h