Shift Class Reference

#include <Shift.H>

List of all members.


Detailed Description

A direction in space represented by a Point object.

Public Member Functions

 Shift ()
 Default Constructor.
 Shift (Point a_pt)
 Construct a Shift using a Point.
Shift operator* (Shift a_s)
 Defines the "*" operator between two Shift objects.
Point getExp ()
 Retrieves the data in *this.
int getExp (int dir)
 Retrieves the data corresponding to direction dir in *this.
void print ()
 Print method.

Public Attributes

Point m_shift
 Direction of the Shift.

Constructor & Destructor Documentation

Shift::Shift (  )  [inline]

Default Constructor.

References getZeros(), and m_shift.

Referenced by operator*().

Shift::Shift ( Point  a_pt  )  [inline]

Construct a Shift using a Point.

References m_shift.


Member Function Documentation

Shift Shift::operator* ( Shift  a_s  )  [inline]

Defines the "*" operator between two Shift objects.

The product of two Shifts results in a new Shift which is the sum of the two base objects' vectors.

References m_shift, and Shift().

Point Shift::getExp (  )  [inline]

Retrieves the data in *this.

References m_shift.

int Shift::getExp ( int  dir  )  [inline]

Retrieves the data corresponding to direction dir in *this.

void Shift::print (  )  [inline]

Print method.

Calls Point.print()

References m_shift, and Point::print().


Member Data Documentation

Direction of the Shift.

Referenced by getExp(), operator*(), print(), Shift(), and Stencil< T >::Stencil().


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

Generated on Fri Mar 11 12:53:44 2016 for AMRStencil by  doxygen 1.5.5