FlexELA
Loading...
Searching...
No Matches
Public Member Functions | List of all members
fields::Owner< T > Class Template Reference

An extension of Helper<T> which owns the array. More...

#include <fields.h>

Inheritance diagram for fields::Owner< T >:
fields::Helper< T >

Public Member Functions

 Owner (const int n[3], const int pad[6])
 
 Owner (T *array, const int n[3], const int pad[6])=delete
 
 Owner (const Owner< T > &rhs)
 Copy constructor.
 
- Public Member Functions inherited from fields::Helper< T >
 Helper (T *array, const int n[3], const int pad[6])
 Construct a new Array Helper object pointing to array.
 
Tat (int i, int j, int k) const
 Get the element at (i,j,k)
 
std::size_t size () const
 Return the number of (not pad) cells.
 
Helper< Tslice (int is, int ie, int js, int je, int ks, int ke) const
 Create a slice of the array.
 
forward_Iterator begin () const
 Iterator to the start (0,0,0) of the data.
 
forward_Iterator end () const
 Iterator to the end of the data.
 
reverse_Iterator rbegin () const
 Reverse Iterator to the end (ni-1,nj-1,nk-1) of the data.
 
reverse_Iterator rend () const
 Reverse Iterator end.
 

Additional Inherited Members

- Protected Attributes inherited from fields::Helper< T >
T *const basePtr
 Pointer to start of underlying data.
 
int const n [3]
 \(\left[N_{i},N_{j},N_{k}\right]\)
 
int const pad [6]
 \(\left[n_{i-},n_{i+},n_{j-},n_{j+},n_{k-},n_{k+}\right]\)
 

Detailed Description

template<class T>
class fields::Owner< T >

An extension of Helper<T> which owns the array.

Template Parameters
T

Constructor & Destructor Documentation

◆ Owner()

template<class T >
fields::Owner< T >::Owner ( const int  n[3],
const int  pad[6] 
)
inline

For definitions of n and pad, see fields

See also
Helper()
Parameters
nThe number of (not pad) cells in each direction, \(\left[N_{i},N_{j},N_{k}\right]\)
padThe number of ghost cells in each direction, \(\left[n_{i-},n_{i+},n_{j-},n_{j+},n_{k-},n_{k+}\right]\)

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