OpenFOAM logo
Open Source CFD Toolkit

Vector Class Template Reference

Inheritance diagram for Vector:

Inheritance graph
[legend]
Collaboration diagram for Vector:

Collaboration graph
[legend]
List of all members.

template<class Cmpt>
class Foam::Vector< Cmpt >


Public Types

enum  { rank = 1 }
enum  components { X, Y, Z }
 Component labeling enumeration. More...

Public Member Functions

 Vector ()
 Construct null.
 Vector (const VectorSpace< Vector< Cmpt >, Cmpt, 3 > &)
 Construct given VectorSpace.
 Vector (const Cmpt &vx, const Cmpt &vy, const Cmpt &vz)
 Construct given three components.
 Vector (Istream &)
 Construct from Istream.
const Cmpt & x () const
const Cmpt & y () const
const Cmpt & z () const
Cmpt & x ()
Cmpt & y ()
Cmpt & z ()
const Vector< Cmpt > & centre (const List< Vector< Cmpt > > &) const
 Return *this (used for point which is a typedef to Vector<scalar>.

Static Public Attributes

const char *const typeName
const char * componentNames []
const Vector zero
const Vector one

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
rank 

Definition at line 75 of file Vector.H.

enum components
 

Component labeling enumeration.

Enumeration values:
X 
Y 
Z 

Definition at line 90 of file Vector.H.


Constructor & Destructor Documentation

Vector  )  [inline]
 

Construct null.

Definition at line 41 of file VectorI.H.

Vector const VectorSpace< Vector< Cmpt >, Cmpt, 3 > &   )  [inline]
 

Construct given VectorSpace.

Definition at line 47 of file VectorI.H.

Vector const Cmpt &  vx,
const Cmpt &  vy,
const Cmpt &  vz
[inline]
 

Construct given three components.

Definition at line 55 of file VectorI.H.

Vector Istream  )  [inline]
 

Construct from Istream.

Definition at line 65 of file VectorI.H.


Member Function Documentation

const Vector< Cmpt > & centre const List< Vector< Cmpt > > &   )  const [inline]
 

Return *this (used for point which is a typedef to Vector<scalar>.

Definition at line 117 of file VectorI.H.

References v1, v2, Vector::x(), Vector::y(), and Vector::z().

Here is the call graph for this function:

Cmpt & x  )  [inline]
 

Definition at line 93 of file VectorI.H.

const Cmpt & x  )  const [inline]
 

Definition at line 74 of file VectorI.H.

Referenced by Vector::centre(), boundBox::mag(), Foam::operator-(), and treeBoundBox::treeBoundBox().

Cmpt & y  )  [inline]
 

Definition at line 99 of file VectorI.H.

const Cmpt & y  )  const [inline]
 

Definition at line 80 of file VectorI.H.

Referenced by Vector::centre(), boundBox::mag(), Foam::operator &(), Foam::operator *(), Foam::operator-(), and treeBoundBox::treeBoundBox().

Cmpt & z  )  [inline]
 

Definition at line 105 of file VectorI.H.

const Cmpt & z  )  const [inline]
 

Definition at line 86 of file VectorI.H.

Referenced by Vector::centre(), boundBox::mag(), Foam::operator &(), Foam::operator *(), and treeBoundBox::treeBoundBox().


Member Data Documentation

const char* componentNames[] [static]
 

Definition at line 84 of file Vector.H.

const Vector one [static]
 

Definition at line 86 of file Vector.H.

const char* const typeName [static]
 

Definition at line 83 of file Vector.H.

const Vector zero [static]
 

Definition at line 85 of file Vector.H.


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org