RealVect Class Reference

A Real vector in SpaceDim-dimensional space. More...

#include <RealVect.H>

Collaboration diagram for RealVect:

[legend]List of all members.

Constants
const RealVect	Zero
const RealVect	Unit
RealVect	BASISREALV (int dir)
Public Member Functions
Constructors and Accessors
	RealVect ()
	RealVect (D_DECL(Real i, Real j, Real k))
	RealVect (const RealVect &rhs)
	RealVect (const IntVect &iv)
RealVect &	operator= (const RealVect &rhs)
Real &	operator[] (int i)
const Real &	operator[] (int i) const
Comparison Operators
bool	operator== (const RealVect &p) const
bool	operator!= (const RealVect &p) const
Arithmetic Operators
RealVect &	operator+= (Real s)
RealVect &	operator+= (const RealVect &p)
RealVect &	operator-= (Real s)
RealVect &	operator-= (const RealVect &p)
RealVect	operator- (Real s) const
RealVect &	operator *= (Real s)
RealVect &	operator *= (const RealVect &p)
RealVect	operator * (const RealVect &p) const
RealVect	operator * (Real s) const
RealVect &	operator/= (Real s)
RealVect &	operator/= (const RealVect &p)
RealVect	operator/ (Real s) const
Data pointer functions
const Real *	dataPtr () const
Real *	dataPtr ()
Static Public Attributes
size_t	io_offset
Friends
class	HDF5Handle
std::ostream &	operator<< (std::ostream &ostr, const RealVect &p)
Arithmetic friend functions
RealVect	operator+ (Real s, const RealVect &p)
RealVect	operator- (Real s, const RealVect &p)
RealVect	operator * (Real s, const RealVect &p)
RealVect	operator/ (Real s, const RealVect &p)
RealVect	operator+ (const RealVect &s, const RealVect &p)
RealVect	operator- (const RealVect &s, const RealVect &p)
RealVect	operator * (const RealVect &s, const RealVect &p)
RealVect	operator/ (const RealVect &s, const RealVect &p)

---

Detailed Description

A Real vector in SpaceDim-dimensional space.

The class RealVect is an implementation of a Real vector in a SpaceDim-dimensional space. RealVect values are accessed using the operator[] function, as for a normal C++ array. In addition, the basic arithmetic operators have been overloaded to implement scaling and translation operations.

---

Constructor & Destructor Documentation

RealVect::RealVect (   )

Construct a RealVect whose components are zero.

RealVect::RealVect (  D_DECL(Real i, Real j, Real k)   )

Construct a RealVect given the specific values for its coordinates. D_DECL is a macro that sets the constructor to take CH_SPACEDIM arguments.

RealVect::RealVect (  const RealVect &  rhs  )

The copy constructor.

RealVect::RealVect (  const IntVect &  iv  )  [inline]

Construct a RealVect from an IntVect by coercing each component from int to Real.

---

Member Function Documentation

Real* RealVect::dataPtr (   )

Only for sending stuff to Fortran

const Real* RealVect::dataPtr (   )  const

Only for sending stuff to Fortran

RealVect RealVect::operator * (  Real  s  )  const

Returns a RealVect that is this RealVect with each component multiplied by a scalar.

RealVect RealVect::operator * (  const RealVect &  p  )  const

Returns component-wise product of this RealVect and argument.

RealVect& RealVect::operator *= (  const RealVect &  p  )

Modifies this RealVect by component-wise multiplication by argument.

RealVect& RealVect::operator *= (  Real  s  )

Modifies this RealVect by multiplying each component by a scalar.

bool RealVect::operator!= (  const RealVect &  p  )  const

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

RealVect& RealVect::operator+= (  const RealVect &  p  )

Modifies this RealVect by component-wise addition by argument.

RealVect& RealVect::operator+= (  Real  s  )

Modifies this RealVect by addition of a scalar to each component.

RealVect RealVect::operator- (  Real  s  )  const

Returns a RealVect that is this RealVect with a scalar s subtracted from each component.

RealVect& RealVect::operator-= (  const RealVect &  p  )

Modifies this RealVect by component-wise subtraction by argument.

RealVect& RealVect::operator-= (  Real  s  )

Modifies this RealVect by subtraction of a scalar from each component.

RealVect RealVect::operator/ (  Real  s  )  const

Returns a RealVect that is this RealVect with each component divided by a scalar.

RealVect& RealVect::operator/= (  const RealVect &  p  )

Modifies this RealVect by component-wise division by argument.

RealVect& RealVect::operator/= (  Real  s  )

Modifies this RealVect by dividing each component by a scalar.

RealVect& RealVect::operator= (  const RealVect &  rhs  )

The assignment operator.

bool RealVect::operator== (  const RealVect &  p  )  const

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

const Real& RealVect::operator[] (  int  i  )  const

Returns the i'th coordinate of the RealVect.

Real& RealVect::operator[] (  int  i  )

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

---

Friends And Related Function Documentation

RealVect BASISREALV (  int  dir  )  [friend]

Returns a basis vector in the given coordinate direction. In 2-D: BASISREALV(0) == (1.,0.); BASISREALV(1) == (0.,1.). In 3-D: BASISREALV(0) == (1.,0.,0.); BASISREALV(1) == (0.,1.,0.); BASISREALV(2) == (0.,0.,1.). Note that the coordinate directions are based at zero.

friend class HDF5Handle [friend]

RealVect operator * (  const RealVect &  s, const RealVect &  p )  [friend]

Returns component-wise product of s and p.

RealVect operator * (  Real  s, const RealVect &  p )  [friend]

Returns a RealVect that is a RealVect p with each component multiplied by a scalar s.

RealVect operator+ (  const RealVect &  s, const RealVect &  p )  [friend]

Returns component-wise sum of RealVects s and p.

RealVect operator+ (  Real  s, const RealVect &  p )  [friend]

Returns a RealVect that is a RealVect p with a scalar s added to each component.

RealVect operator- (  const RealVect &  s, const RealVect &  p )  [friend]

Returns s - p.

RealVect operator- (  Real  s, const RealVect &  p )  [friend]

Returns s - p.

RealVect operator/ (  const RealVect &  s, const RealVect &  p )  [friend]

Returns component-wise quotient p / s.

RealVect operator/ (  Real  s, const RealVect &  p )  [friend]

Returns a RealVect that is a RealVect p with each component divided by a scalar s.

std::ostream& operator<< (  std::ostream &  ostr, const RealVect &  p )  [friend]

Print to the given output stream in ASCII.

---

Member Data Documentation

size_t RealVect::io_offset [static]

const RealVect RealVect::Unit [static]

This is a RealVect all of whose components are equal to one.

const RealVect RealVect::Zero [static]

This is a RealVect all of whose components are equal to zero.

---

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

• RealVect.H

---