Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

RealVect Class Reference

#include <RealVect.H>

Collaboration diagram for RealVect:

Collaboration graph
[legend]
List of all members.

Public Methods

 RealVect ()
 {\bf Constructors and Accessors}

 RealVect (D_DECL(Real i, Real j, Real k))
 RealVect (const RealVect &rhs)
RealVect & operator= (const RealVect &rhs)
Realoperator[] (int i)
const Realoperator[] (int i) const
bool operator== (const RealVect &p) const
 {\bf Comparison Operators}

bool operator!= (const RealVect &p) const
RealVect & operator+= (Real s)
RealVect & operator+= (const RealVect &p)
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 * (const RealVect &p) const
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
const RealdataPtr () const

Static Public Attributes

const RealVect Zero
const RealVect Unit
size_t io_offset

Friends

class HDF5Handle
RealVect BASISREALV (int dir)
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)

Constructor & Destructor Documentation

RealVect::RealVect  
 

{\bf Constructors and Accessors}

Construct an RealVect whose components are zero.

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

Construct an 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.


Member Function Documentation

const Real* RealVect::dataPtr   const
 

only for sending stuff to fortran

RealVect RealVect::operator * Real    s const
 

Returns an 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 with argument.

RealVect& RealVect::operator *= Real    s
 

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

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 with argument.

RealVect& RealVect::operator+= Real    s
 

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

RealVect RealVect::operator- Real    s const
 

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

RealVect RealVect::operator- const RealVect &    p const
 

Returns component-wise difference of this RealVect and argument.

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

Modifies this RealVect by component-wise subtraction with argument.

RealVect& RealVect::operator-= Real    s
 

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

RealVect RealVect::operator/ Real    s const
 

Returns component-wise division of this RealVect by scalar s.

RealVect RealVect::operator/ const RealVect &    p const
 

Returns component-wise division of this RealVect by RealVect argument.

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

Modifies this RealVect by component-wise division with RealVect argument.

RealVect& RealVect::operator/= Real    s
 

Modifies this RealVect by division by a scalar of each component.

RealVect& RealVect::operator= const RealVect &    rhs
 

The assignment operator.

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

{\bf Comparison Operators}

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; eg. RealVect3d BASISV(1) == (0,1,0). Note that the coordinate directions are zero based.

friend class HDF5Handle [friend]
 

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

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

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

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

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

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

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

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

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

Returns -p + s.

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

Returns -p + s.

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

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

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

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


Member Data Documentation

size_t RealVect::io_offset [static]
 

const RealVect RealVect::Unit [static]
 

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

const RealVect RealVect::Zero [static]
 

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


The documentation for this class was generated from the following file:
Generated on Thu Aug 29 11:07:49 2002 for Chombo&INS by doxygen1.2.16