IBAMR  IBAMR version 0.19.
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SAMRAI::hier::Index< DIM > Class Template Reference

#include <ibtk/PoissonUtilities.h>

Inheritance diagram for SAMRAI::hier::Index< DIM >:
Inheritance graph
[legend]

Public Member Functions

 Index ()
 
 Index (const int i)
 
 Index (const int i, const int j)
 
 Index (const int i, const int j, const int k)
 
 Index (const tbox::Array< int > i)
 
 Index (const Index< DIM > &rhs)
 
 Index (const IntVector< DIM > &rhs)
 
Index< DIM > & operator= (const Index< DIM > &rhs)
 
Index< DIM > & operator= (const IntVector< DIM > &rhs)
 
Index< DIM > & operator+= (const IntVector< DIM > &rhs)
 
Index< DIM > operator+ (const IntVector< DIM > &rhs) const
 
Index< DIM > & operator+= (const int rhs)
 
Index< DIM > operator+ (const int rhs) const
 
Index< DIM > & operator-= (const IntVector< DIM > &rhs)
 
Index< DIM > operator- (const IntVector< DIM > &rhs) const
 
Index< DIM > & operator-= (const int rhs)
 
Index< DIM > operator- (const int rhs) const
 
Index< DIM > & operator*= (const IntVector< DIM > &rhs)
 
Index< DIM > operator* (const IntVector< DIM > &rhs) const
 
Index< DIM > & operator*= (const int rhs)
 
Index< DIM > operator* (const int rhs) const
 
Index< DIM > & operator/= (const IntVector< DIM > &rhs)
 
Index< DIM > operator/ (const IntVector< DIM > &rhs) const
 
Index< DIM > & operator/= (const int rhs)
 
Index< DIM > operator/ (const int rhs) const
 
int & operator() (const int i)
 
const int & operator() (const int i) const
 
 operator int * ()
 
 operator const int * () const
 
IntVector< DIM > operator- () const
 
bool operator== (const IntVector< DIM > &rhs) const
 
bool operator!= (const IntVector< DIM > &rhs) const
 
bool operator< (const IntVector< DIM > &rhs) const
 
bool operator<= (const IntVector< DIM > &rhs) const
 
bool operator> (const IntVector< DIM > &rhs) const
 
bool operator>= (const IntVector< DIM > &rhs) const
 
void min (const IntVector< DIM > &rhs)
 
int min () const
 
void max (const IntVector< DIM > &rhs)
 
int max () const
 
int getProduct () const
 

Static Public Member Functions

static IntVector< DIM > min (const IntVector< DIM > &a, const IntVector< DIM > &b)
 
static IntVector< DIM > max (const IntVector< DIM > &a, const IntVector< DIM > &b)
 

Private Attributes

int d_vector [DIM]
 

Detailed Description

template<int DIM>
class SAMRAI::hier::Index< DIM >

Class Index<DIM> implements a simple n-dimensional integer vector in the AMR index space. Index is used as lower and upper bounds when creating a box and also when iterating over the cells in a box. An index is essentially an integer vector but it carries along the notion of indexing into AMR's abstract index space.

See also
hier::Box
hier::BoxIterator
hier::IntVector

Constructor & Destructor Documentation

◆ Index() [1/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( )

The default constructor for Index creates an uninitialized index.

◆ Index() [2/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const int  i)

Construct an index with all components equal to the argument.

◆ Index() [3/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const int  i,
const int  j 
)

Construct a two-dimensional index with the value (i,j).

◆ Index() [4/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const int  i,
const int  j,
const int  k 
)

Construct a three-dimensional index with the value (i,j,k).

◆ Index() [5/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const tbox::Array< int >  i)

Construct an n-dimensional index with the values copied from the integer tbox::Array i of size n.

◆ Index() [6/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const Index< DIM > &  rhs)

The copy constructor creates an index equal to the argument.

◆ Index() [7/7]

template<int DIM>
SAMRAI::hier::Index< DIM >::Index ( const IntVector< DIM > &  rhs)

Construct an index equal to the argument IntVector.

Member Function Documentation

◆ operator=() [1/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator= ( const Index< DIM > &  rhs)

The assignment operator sets the index equal to the argument.

◆ operator=() [2/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator= ( const IntVector< DIM > &  rhs)

The assignment operator sets the index equal to the argument IntVector.

◆ operator+=() [1/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator+= ( const IntVector< DIM > &  rhs)

Plus-equals operator for an index and an integer vector.

◆ operator+() [1/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator+ ( const IntVector< DIM > &  rhs) const

Plus operator for an index and an integer vector.

◆ operator+=() [2/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator+= ( const int  rhs)

Plus-equals operator for an index and an integer.

◆ operator+() [2/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator+ ( const int  rhs) const

Plus operator for an index and an integer.

◆ operator-=() [1/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator-= ( const IntVector< DIM > &  rhs)

Minus-equals operator for an index and an integer vector.

◆ operator-() [1/3]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator- ( const IntVector< DIM > &  rhs) const

Minus operator for an index and an integer vector.

◆ operator-=() [2/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator-= ( const int  rhs)

Minus-equals operator for an index and an integer.

◆ operator-() [2/3]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator- ( const int  rhs) const

Minus operator for an index and an integer.

◆ operator*=() [1/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator*= ( const IntVector< DIM > &  rhs)

Times-equals operator for an index and an integer vector.

◆ operator*() [1/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator* ( const IntVector< DIM > &  rhs) const

Times operator for an index and an integer vector.

◆ operator*=() [2/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator*= ( const int  rhs)

Times-equals operator for an index and an integer.

◆ operator*() [2/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator* ( const int  rhs) const

Times operator for an index and an integer.

◆ operator/=() [1/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator/= ( const IntVector< DIM > &  rhs)

Assign-quotient operator for an index and an integer vector.

◆ operator/() [1/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator/ ( const IntVector< DIM > &  rhs) const

Quotient operator for an index and an integer vector.

◆ operator/=() [2/2]

template<int DIM>
Index<DIM>& SAMRAI::hier::Index< DIM >::operator/= ( const int  rhs)

Assign-quotient operator for an index and an integer.

◆ operator/() [2/2]

template<int DIM>
Index<DIM> SAMRAI::hier::Index< DIM >::operator/ ( const int  rhs) const

Quotient operator for an index and an integer.

◆ operator()() [1/2]

template<int DIM>
int& SAMRAI::hier::IntVector< DIM >::operator() ( const int  i)
inherited

Return the specified component of the vector. No bounds checking.

◆ operator()() [2/2]

template<int DIM>
const int& SAMRAI::hier::IntVector< DIM >::operator() ( const int  i) const
inherited

Return the specified component of the vector as a const integer. No bounds checking.

◆ operator int *()

template<int DIM>
SAMRAI::hier::IntVector< DIM >::operator int * ( )
inherited

Return a pointer to the beginning of the vector data values.

◆ operator const int *()

template<int DIM>
SAMRAI::hier::IntVector< DIM >::operator const int * ( ) const
inherited

Return a const pointer to the beginning of the vector data values.

◆ operator-() [3/3]

template<int DIM>
IntVector<DIM> SAMRAI::hier::IntVector< DIM >::operator- ( ) const
inherited

Unary minus to negate an integer vector.

◆ operator==()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator== ( const IntVector< DIM > &  rhs) const
inherited

Returns true if two vector objects are equal. All components must be the same for equality.

◆ operator!=()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator!= ( const IntVector< DIM > &  rhs) const
inherited

Returns true if two vector objects are not equal. Any of the components may be different for inequality.

◆ operator<()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator< ( const IntVector< DIM > &  rhs) const
inherited

Returns true if each integer in vector is less than corresponding integer in comparison vector.

◆ operator<=()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator<= ( const IntVector< DIM > &  rhs) const
inherited

Returns true if each integer in vector is less or equal to corresponding integer in comparison vector.

◆ operator>()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator> ( const IntVector< DIM > &  rhs) const
inherited

Returns true if each integer in vector is greater than corresponding integer in comparison vector.

◆ operator>=()

template<int DIM>
bool SAMRAI::hier::IntVector< DIM >::operator>= ( const IntVector< DIM > &  rhs) const
inherited

Returns true if each integer in vector is greater or equal to corresponding integer in comparison vector.

◆ min() [1/3]

template<int DIM>
void SAMRAI::hier::IntVector< DIM >::min ( const IntVector< DIM > &  rhs)
inherited

Return the component-wise minimum of two integer vector objects.

◆ min() [2/3]

template<int DIM>
int SAMRAI::hier::IntVector< DIM >::min ( ) const
inherited

Return the minimum entry in an integer vector.

◆ min() [3/3]

template<int DIM>
static IntVector<DIM> SAMRAI::hier::IntVector< DIM >::min ( const IntVector< DIM > &  a,
const IntVector< DIM > &  b 
)
staticinherited

Utility function to take the minimum of two integer vector objects.

◆ max() [1/3]

template<int DIM>
void SAMRAI::hier::IntVector< DIM >::max ( const IntVector< DIM > &  rhs)
inherited

Return the component-wise maximum of two integer vector objects.

◆ max() [2/3]

template<int DIM>
int SAMRAI::hier::IntVector< DIM >::max ( ) const
inherited

Return the maximum entry in an integer vector.

◆ max() [3/3]

template<int DIM>
static IntVector<DIM> SAMRAI::hier::IntVector< DIM >::max ( const IntVector< DIM > &  a,
const IntVector< DIM > &  b 
)
staticinherited

Utility function to take the maximum of two integer vector objects.

◆ getProduct()

template<int DIM>
int SAMRAI::hier::IntVector< DIM >::getProduct ( ) const
inherited

Return the product of the entries in the integer vector.

Member Data Documentation

◆ d_vector

template<int DIM>
int SAMRAI::hier::IntVector< DIM >::d_vector[DIM]
privateinherited
The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.17