IndexTM< T, N > Class Template Reference

#include <IndexTM.H>

Inheritance diagram for IndexTM< T, N >:

Inheritance graph
[legend]

List of all members.

template<typename T, int N = CH_SPACEDIM>
class IndexTM< T, N >


Constants

static const IndexTM Zero
static const IndexTM Unit
void linearIn (const void *a_inBuf)
void linearOut (void *a_outBuf) const
static int InitStatics ()

I/O Functions

void printOn (std::ostream &a_os) const
void p () const
void dumpOn (std::ostream &a_os) const
std::ostream & operator<< (std::ostream &a_os, const IndexTM &a_iv)
std::istream & operator>> (std::istream &a_os, IndexTM &a_iv)

Public Member Functions

template<typename OP>
bool operatorCompare (const IndexTM< T, N > &a_p, const OP &a_op) const
template<typename OP>
IndexTM< T, N > & operatorOpEquals (const IndexTM< T, N > &a_p, const OP &a_op)
template<typename OP>
IndexTM< T, N > & operatorOpEquals (const T &a_p, const OP &a_op)
IndexTM & reciprocal ()
int minDir (bool a_doAbs) const
int maxDir (bool a_doAbs) const
Constructors and Accessors
See derived class IndexTM for more constructors.

 IndexTM ()
 ~IndexTM ()
 IndexTM (T a_i)
 IndexTM (T a_i, T a_j)
 IndexTM (T a_i, T a_j, T a_k)
 IndexTM (T a_i, T a_j, T a_k, T a_l)
 IndexTM (T a_i, T a_j, T a_k, T a_l, T a_m)
 IndexTM (T a_i, T a_j, T a_k, T a_l, T a_m, T a_n)
 IndexTM (const T *a_a)
 IndexTM (const IndexTM &a_rhs)
IndexTM copy () const
IndexTM & operator= (const IndexTM &a_rhs)
T & operator[] (int a_i)
T operator[] (int a_i) const
void setVal (int a_i, T a_val)
void setAll (T a_val)
Data pointer functions
const T * getVect () const
const T * dataPtr () const
T * dataPtr ()
Comparison Operators
bool operator== (const IndexTM &a_p) const
bool operator!= (const IndexTM &a_p) const
bool lexLT (const IndexTM &a_s) const
bool lexGT (const IndexTM &a_s) const
Unary operators
IndexTM operator+ () const
IndexTM operator- () const
T dotProduct (const IndexTM &a_rhs) const
T sum () const
T product () const
Other arithmetic operators
IndexTM & min (const IndexTM &a_p)
IndexTM & max (const IndexTM &a_p)
IndexTM & scale (T a_s)
IndexTM & reflect (T a_refIx, int a_idir)
IndexTM & shift (int a_coord, T a_s)
IndexTM & shift (const IndexTM &a_iv)
IndexTM & diagShift (T a_s)
IndexTM & coarsen (const IndexTM &a_p)
IndexTM & coarsen (T a_p)

Protected Attributes

T m_vect [N]

Constructor & Destructor Documentation

template<typename T, int N = CH_SPACEDIM>
IndexTM< T, N >::IndexTM (  )  [inline]

Construct an IndexTM whose components are uninitialized.

template<typename T, int N = CH_SPACEDIM>
IndexTM< T, N >::~IndexTM (  )  [inline]

Destructor.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i  )  [inline, explicit]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i,
T  a_j 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i,
T  a_j,
T  a_k 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i,
T  a_j,
T  a_k,
T  a_l 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i,
T  a_j,
T  a_k,
T  a_l,
T  a_m 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( T  a_i,
T  a_j,
T  a_k,
T  a_l,
T  a_m,
T  a_n 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( const T *  a_a  )  [inline, explicit]

Construct an IndexTM setting the coordinates to the corresponding values in the integer array a_a.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N >::IndexTM ( const IndexTM< T, N > &  a_rhs  )  [inline]

The copy constructor.

References IndexTM< T, N >::m_vect.

Member Function Documentation

template<typename T, int N = CH_SPACEDIM>
IndexTM IndexTM< T, N >::copy (  )  const [inline]

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::operator= ( const IndexTM< T, N > &  a_rhs  )  [inline]

The assignment operator.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
T & IndexTM< T, N >::operator[] ( int  a_i  )  [inline]

Returns a modifiable lvalue reference to the i'th coordinate of the IndexTM.

References CH_assert, and IndexTM< T, N >::m_vect.

template<typename T, int N>
T IndexTM< T, N >::operator[] ( int  a_i  )  const [inline]

Returns the i'th coordinate of the IndexTM.

References CH_assert, and IndexTM< T, N >::m_vect.

template<typename T, int N>
void IndexTM< T, N >::setVal ( int  a_i,
T  a_val 
) [inline]

Set i'th coordinate of IndexTM to val.

References CH_assert, and IndexTM< T, N >::m_vect.

template<typename T, int N>
void IndexTM< T, N >::setAll ( T  a_val  )  [inline]

set all values to val

References IndexTM< T, N >::m_vect.

Referenced by IndexTM< T, N >::InitStatics().

template<typename T, int N>
const T * IndexTM< T, N >::getVect (  )  const [inline]

Returns a const pointer to an array of coordinates of the IndexTM. Useful for arguments to FORTRAN calls.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
const T * IndexTM< T, N >::dataPtr (  )  const [inline]

Only for sending to Fortran

References IndexTM< T, N >::m_vect.

Referenced by BASISV_TM().

template<typename T, int N>
T * IndexTM< T, N >::dataPtr (  )  [inline]

Only for sending to Fortran

References IndexTM< T, N >::m_vect.

template<typename T, int N>
bool IndexTM< T, N >::operator== ( const IndexTM< T, N > &  a_p  )  const [inline]

Returns true if this IndexTM is equivalent to argument IndexTM. All comparisons between analogous components must be satisfied.

References IndexTM< T, N >::m_vect.

Referenced by IndexTM< T, N >::operator!=().

template<typename T, int N>
bool IndexTM< T, N >::operator!= ( const IndexTM< T, N > &  a_p  )  const [inline]

Returns true if this IndexTM is different from argument IndexTM. All comparisons between analogous components must be satisfied.

References IndexTM< T, N >::operator==().

template<typename T, int N>
bool IndexTM< T, N >::lexLT ( const IndexTM< T, N > &  a_s  )  const [inline]

Returns true if this IndexTM is lexically less than the argument. An IndexTM MUST BE either lexically less than, lexically greater than, or equal to another IndexTM.

iv1 is lexically less than iv2 if:

in 2-D:
(iv1[0] < iv2[0]) || ((iv1[0] == iv2[0]) && (iv1[1] < iv2[1]));

in 3-D:
(iv1[0] < iv2[0]) || (iv1[0]==iv2[0] && ((iv1[1] < iv2[1] || ((iv1[1] == iv2[1]) && (iv1[2] < iv2[2])))));

References IndexTM< T, N >::m_vect.

template<typename T, int N>
bool IndexTM< T, N >::lexGT ( const IndexTM< T, N > &  a_s  )  const [inline]

Returns true if this IndexTM is lexically greater than the argument. An IndexTM MUST BE either lexically less than, lexically greater than, or equal to another IndexTM.

iv1 is lexically less than iv2 if:

in 2-D:
(iv1[0] > iv2[0]) || ((iv1[0] == iv2[0]) && (iv1[1] > iv2[1]));

in 3-D:
(iv1[0] > iv2[0]) || (iv1[0]==iv2[0] && ((iv1[1] > iv2[1] || ((iv1[1] == iv2[1]) && (iv1[2] > iv2[2])))));

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N > IndexTM< T, N >::operator+ (  )  const [inline]

Unary plus -- for completeness.

template<typename T, int N>
IndexTM< T, N > IndexTM< T, N >::operator- (  )  const [inline]

Unary minus -- negates all components of this IndexTM.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
T IndexTM< T, N >::dotProduct ( const IndexTM< T, N > &  a_rhs  )  const [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
T IndexTM< T, N >::sum (  )  const [inline]

Sum of all components of this IndexTM.

References IndexTM< T, N >::m_vect.

Referenced by LSProblem< dim >::computeBounds().

template<typename T, int N>
T IndexTM< T, N >::product (  )  const [inline]

Product of all components of this IndexTM.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
template<typename OP>
bool IndexTM< T, N >::operatorCompare ( const IndexTM< T, N > &  a_p,
const OP &  a_op 
) const [inline]

Used by GenericArithmeticable to implement all pointwise arithmetic and comparison functions.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
template<typename OP>
IndexTM< T, N > & IndexTM< T, N >::operatorOpEquals ( const IndexTM< T, N > &  a_p,
const OP &  a_op 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
template<typename OP>
IndexTM< T, N > & IndexTM< T, N >::operatorOpEquals ( const T &  a_p,
const OP &  a_op 
) [inline]

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::reciprocal (  )  [inline]

Modifies this IndexTM by division of each component into T(1).

References IndexTM< T, N >::m_vect.

template<typename T, int N>
int IndexTM< T, N >::minDir ( bool  a_doAbs  )  const [inline]

Component with the minimum value of this Index(returns 0 if they are all the same). a_doAbs : if true then take the absolute value before comparing

References IndexTM< T, N >::m_vect.

template<typename T, int N>
int IndexTM< T, N >::maxDir ( bool  a_doAbs  )  const [inline]

Component with the maximum value of this Index (returns 0 if they are all the same). a_doAbs : if true then take the absolute value before comparing.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::min ( const IndexTM< T, N > &  a_p  )  [inline]

Modifies this IndexTM by taking component-wise min with IndexTM argument.

References IndexTM< T, N >::m_vect.

Referenced by min().

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::max ( const IndexTM< T, N > &  a_p  )  [inline]

Modifies this IndexTM by taking component-wise max with IndexTM argument.

References IndexTM< T, N >::m_vect.

Referenced by max().

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::scale ( T  a_s  )  [inline]

Modifies this IndexTM by multiplying each component by a scalar.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::reflect ( T  a_refIx,
int  a_idir 
) [inline]

Modifies IndexTM by reflecting it in the plane defined by the index ref_ix and with normal in the direction of idir. Directions are based at zero.

References CH_assert, and IndexTM< T, N >::m_vect.

Referenced by reflect().

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::shift ( int  a_coord,
T  a_s 
) [inline]

Modifies this IndexTM by adding s to component in given coordinate direction.

References CH_assert, and IndexTM< T, N >::m_vect.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::shift ( const IndexTM< T, N > &  a_iv  )  [inline]

Modifies this IndexTM by component-wise addition with IndexTM argument.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::diagShift ( T  a_s  )  [inline]

Modifies this IndexTM by adding a scalar s to each component.

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::coarsen ( const IndexTM< T, N > &  a_p  )  [inline]

Modify IndexTM by component-wise integer projection.

References CH_assert, IndexTM< T, N >::m_vect, and IndexTM< T, N >::p().

Referenced by coarsen().

template<typename T, int N>
IndexTM< T, N > & IndexTM< T, N >::coarsen ( T  a_p  )  [inline]

Modify IndexTM by component-wise integer projection.

References CH_assert, and IndexTM< T, N >::m_vect.

template<typename T, int N = CH_SPACEDIM>
void IndexTM< T, N >::printOn ( std::ostream &  a_os  )  const

Print an IndexTM to the ostream.

template<typename T, int N>
void IndexTM< T, N >::p (  )  const [inline]

Print an IndexTM to the pout().

References pout().

Referenced by IndexTM< T, N >::coarsen().

template<typename T, int N = CH_SPACEDIM>
void IndexTM< T, N >::dumpOn ( std::ostream &  a_os  )  const

Print an IndexTM to the ostream a bit more verbosely.

template<typename T, int N>
int IndexTM< T, N >::InitStatics (  )  [inline, static]

Initializes Zero and Unit.

References IndexTM< T, N >::setAll().

template<typename T, int N>
void IndexTM< T, N >::linearIn ( const void *  a_inBuf  )  [inline]

Low-level data copy.

References IndexTM< T, N >::m_vect.

template<typename T, int N>
void IndexTM< T, N >::linearOut ( void *  a_outBuf  )  const [inline]

References IndexTM< T, N >::m_vect.

Friends And Related Function Documentation

template<typename T, int N = CH_SPACEDIM>
std::ostream& operator<< ( std::ostream &  a_os,
const IndexTM< T, N > &  a_iv 
) [friend]

Print the IndexTM to given output stream in ASCII.

template<typename T, int N = CH_SPACEDIM>
std::istream& operator>> ( std::istream &  a_os,
IndexTM< T, N > &  a_iv 
) [friend]

Read next IndexTM from given input stream.

Member Data Documentation

template<typename T, int N = CH_SPACEDIM>
const IndexTM< T, N > IndexTM< T, N >::Zero [inline, static]

This is an IndexTM all of whose components are equal to zero.

Referenced by LSProblem< dim >::computeBounds(), IFData< dim >::defineLocalCoords(), CutCellMoments< dim >::getVol(), and IFData< dim >::setNormalDerivatives().

template<typename T, int N = CH_SPACEDIM>
const IndexTM< T, N > IndexTM< T, N >::Unit [inline, static]

This is an IndexTM all of whose components are equal to one.

template<typename T, int N = CH_SPACEDIM>
T IndexTM< T, N >::m_vect[N] [protected]

The individual components of this IndexTM.

Referenced by IndexTM< T, N >::coarsen(), IndexTM< T, N >::dataPtr(), IndexTM< T, N >::dotProduct(), IndexTM< T, N >::getVect(), IndexTM< T, N >::IndexTM(), IndexTM< T, N >::lexGT(), IndexTM< T, N >::lexLT(), IndexTM< T, N >::linearIn(), IndexTM< T, N >::linearOut(), IndexTM< T, N >::max(), IndexTM< T, N >::maxDir(), IndexTM< T, N >::min(), IndexTM< T, N >::minDir(), IndexTM< T, N >::operator-(), IndexTM< T, N >::operator=(), IndexTM< T, N >::operator==(), IndexTM< T, N >::operator[](), IndexTM< T, N >::operatorCompare(), IndexTM< T, N >::operatorOpEquals(), IndexTM< T, N >::product(), IndexTM< T, N >::reciprocal(), IndexTM< T, N >::reflect(), IndexTM< T, N >::setAll(), IndexTM< T, N >::setVal(), IndexTM< T, N >::shift(), and IndexTM< T, N >::sum().

The documentation for this class was generated from the following files:
Generated on Tue Mar 6 17:56:16 2012 for Chombo + EB + MF by  doxygen 1.5.5