class RealVect
An Real Vector in SpaceDim-Dimensional Space
Inheritance:
RealVect
public members:
-
- Constructors and Accessors
-
RealVect ()
-
-
RealVect (D_DECL(Real i, Real j, Real k))
-
-
RealVect (const RealVect& rhs)
-
-
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
-
-
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/ (const RealVect& p) const
-
-
RealVect operator/ (Real s) const
-
-
const Real* dataPtr() const
-
-
Real* dataPtr()
-
-
friend RealVect BASISREALV(int dir)
-
-
static const RealVect Zero
-
-
static const RealVect Unit
-
-
friend RealVect operator+ (Real s, const RealVect& p)
-
-
friend RealVect operator- (Real s, const RealVect& p)
-
-
friend RealVect operator* (Real s, const RealVect& p)
-
-
friend RealVect operator/ (Real s, const RealVect& p)
-
-
friend RealVect operator+ (const RealVect& s, const RealVect& p)
-
-
friend RealVect operator- (const RealVect& s, const RealVect& p)
-
-
friend RealVect operator* (const RealVect& s, const RealVect& p)
-
-
friend RealVect operator/ (const RealVect& s, const RealVect& p)
-
Documentation
The class RealVect is an implementation of an 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.
- RealVect ()
-
Construct an RealVect whose components are zero.
- 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 (const RealVect& rhs)
-
The copy constructor.
- RealVect& operator= (const RealVect& rhs)
-
The assignment operator.
- Real& operator[] (int i)
-
Returns a modifiable lvalue reference to the i'th coordinate of the
RealVect.
- const Real& operator[] (int i) const
-
Returns the i'th coordinate of the RealVect.
- bool operator== (const RealVect& p) const
-
Returns true if this RealVect is equivalent to argument RealVect. All
comparisons between analogous components must be satisfied.
- bool operator!= (const RealVect& p) const
-
Returns true if this RealVect is different from argument RealVect.
All comparisons between analogous components must be satisfied.
- RealVect& operator+= (Real s)
-
Modifies this RealVect by addition of a scalar to each component.
- RealVect& operator+= (const RealVect& p)
-
Modifies this RealVect by component-wise addition with argument.
- RealVect& operator-= (Real s)
-
Modifies this RealVect by subtraction of a scalar from each
component.
- RealVect& operator-= (const RealVect& p)
-
Modifies this RealVect by component-wise subtraction with argument.
- RealVect operator- (Real s) const
-
Returns an RealVect that is this RealVect with a scalar s subtracted
from each component.
- RealVect& operator*= (Real s)
-
Modifies this RealVect by multiplication of a scalar to each
component.
- RealVect& operator*= (const RealVect& p)
-
Modifies this RealVect by component-wise multiplication with argument.
- RealVect operator* (const RealVect& p) const
-
Returns component-wise product of this RealVect and argument.
- RealVect operator* (Real s) const
-
Returns an RealVect that is this RealVect with each component
multiplied by a scalar.
- RealVect& operator/= (Real s)
-
Modifies this RealVect by division by a scalar of each component.
- RealVect& operator/= (const RealVect& p)
-
Modifies this RealVect by component-wise division with RealVect
argument.
- RealVect operator/ (const RealVect& p) const
-
Returns component-wise division of this RealVect by RealVect argument.
- RealVect operator/ (Real s) const
-
Returns component-wise division of this RealVect by scalar s.
- const Real* dataPtr () const
-
only for sending stuff to fortran
- Real* dataPtr ()
-
only for sending stuff to fortran
- friend RealVect BASISREALV (int dir)
-
Returns a basis vector in the given coordinate direction; eg.
RealVect3d BASISV(1) == (0,1,0). Note that the coordinate
directions are zero based.
- static const RealVect Zero
-
This is an RealVect all of whose components are equal to zero.
- static const RealVect Unit
-
This is an RealVect all of whose components are equal to one.
- friend RealVect operator+ (Real s, const RealVect& p)
-
Returns an RealVect that is an RealVect p with a scalar s added to
each component.
- friend RealVect operator- (Real s, const RealVect& p)
-
Returns -p + s.
- friend RealVect operator* (Real s, const RealVect& p)
-
Returns and RealVect that is an RealVect p with each component
multiplied by a scalar s.
- friend RealVect operator/ (Real s, const RealVect& p)
-
Returns and RealVect that is an RealVect p with each component
divided by a scalar s.
- friend RealVect operator+ (const RealVect& s, const RealVect& p)
-
Returns an RealVect that is an RealVect p with a scalar s added to
each component.
- friend RealVect operator- (const RealVect& s, const RealVect& p)
-
Returns -p + s.
- friend RealVect operator* (const RealVect& s, const RealVect& p)
-
Returns and RealVect that is an RealVect p with each component
multiplied by a scalar s.
- friend RealVect operator/ (const RealVect& s, const RealVect& p)
-
Returns and RealVect that is an RealVect p with each component
divided by a scalar s.
this class has no child classes.
alphabetic index hierarchy of classes
Chombo
Copyright Notice
This software is copyright (C) by the Lawrence Berkeley
National Laboratory. Permission is granted to reproduce
this software for non-commercial purposes provided that
this notice is left intact.
It is acknowledged that the U.S. Government has rights to
this software under Contract DE-AC03-765F00098 between
the U.S. Department of Energy and the University of
California.
This software is provided as a professional and academic
contribution for joint exchange. Thus it is experimental,
is provided ``as is'', with no warranties of any kind
whatsoever, no support, no promise of updates, or printed
documentation. By using this software, you acknowledge
that the Lawrence Berkeley National Laboratory and
Regents of the University of California shall have no
liability with respect to the infringement of other
copyrights by any part of this software.