Public Types | Public Member Functions | Static Public Attributes | List of all members
Vector2D< Cmpt > Class Template Reference

Templated 2D Vector derived from VectorSpace adding construction from 2 components, element access using x() and y() member functions and the inner-product (dot-product). More...

Inheritance diagram for Vector2D< Cmpt >:
Inheritance graph
[legend]
Collaboration diagram for Vector2D< Cmpt >:
Collaboration graph
[legend]

Public Types

enum  { rank = 1 }
 
enum  components { X, Y }
 Component labeling enumeration. More...
 
- Public Types inherited from VectorSpace< Vector2D< Cmpt >, Cmpt, 2 >
enum  
 
typedef Cmpt cmptType
 Component type. More...
 

Public Member Functions

 Vector2D ()
 Construct null. More...
 
 Vector2D (const VectorSpace< Vector2D< Cmpt >, Cmpt, 2 > &)
 Construct given VectorSpace. More...
 
 Vector2D (const Cmpt &vx, const Cmpt &vy)
 Construct given two components. More...
 
 Vector2D (Istream &)
 Construct from Istream. More...
 
const Cmpt & x () const
 
const Cmpt & y () const
 
Cmpt & x ()
 
Cmpt & y ()
 
scalar perp (const Vector2D< Cmpt > &b) const
 Perp dot product (dot product with perpendicular vector) More...
 
- Public Member Functions inherited from VectorSpace< Vector2D< Cmpt >, Cmpt, 2 >
 VectorSpace ()
 Construct null. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
 VectorSpace (const VectorSpace< Vector2D< Cmpt >, Cmpt, nCmpt > &)
 Construct as copy. More...
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, nCmpt > &)
 Construct as copy of another VectorSpace type of the same rank. More...
 
label size () const
 Return the number of elements in the VectorSpace = nCmpt. More...
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator= (const VectorSpace< Vector2D< Cmpt >, Cmpt, nCmpt > &)
 
void operator+= (const VectorSpace< Vector2D< Cmpt >, Cmpt, nCmpt > &)
 
void operator-= (const VectorSpace< Vector2D< Cmpt >, Cmpt, nCmpt > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Static Public Attributes

static const char *const typeName
 
static const char * componentNames []
 
static const Vector2D zero
 
static const Vector2D one
 
static const Vector2D max
 
static const Vector2D min
 

Additional Inherited Members

- Public Attributes inherited from VectorSpace< Vector2D< Cmpt >, Cmpt, 2 >
Cmpt v_ [nCmpt]
 The components of this vector space. More...
 

Detailed Description

template<class Cmpt>
class Foam::Vector2D< Cmpt >

Templated 2D Vector derived from VectorSpace adding construction from 2 components, element access using x() and y() member functions and the inner-product (dot-product).

Source files

Definition at line 51 of file Vector2D.H.

Member Enumeration Documentation

anonymous enum
Enumerator
rank 

Definition at line 60 of file Vector2D.H.

enum components

Component labeling enumeration.

Enumerator

Definition at line 77 of file Vector2D.H.

Constructor & Destructor Documentation

Vector2D ( )
inline

Construct null.

Definition at line 35 of file Vector2DI.H.

Vector2D ( const VectorSpace< Vector2D< Cmpt >, Cmpt, 2 > &  vs)
inline

Construct given VectorSpace.

Definition at line 41 of file Vector2DI.H.

Vector2D ( const Cmpt &  vx,
const Cmpt &  vy 
)
inline

Construct given two components.

Definition at line 49 of file Vector2DI.H.

References VectorSpace< Vector2D< Cmpt >, Cmpt, 2 >::v_, Vector2D< Cmpt >::X, and Vector2D< Cmpt >::Y.

Vector2D ( Istream is)
inline

Construct from Istream.

Definition at line 58 of file Vector2DI.H.

Member Function Documentation

const Cmpt & x ( ) const
inline
const Cmpt & y ( ) const
inline
Cmpt & x ( )
inline
Cmpt & y ( )
inline

Definition at line 86 of file Vector2DI.H.

References Foam::type(), VectorSpace< Vector2D< Cmpt >, Cmpt, 2 >::v_, and Vector2D< Cmpt >::Y.

Here is the call graph for this function:

scalar perp ( const Vector2D< Cmpt > &  b) const
inline

Perp dot product (dot product with perpendicular vector)

Definition at line 103 of file Vector2DI.H.

References Vector2D< Cmpt >::x(), and Vector2D< Cmpt >::y().

Referenced by line< Point, PointRef >::nearestDist().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const char* const typeName
static

Definition at line 68 of file Vector2D.H.

const char* componentNames[]
static

Definition at line 69 of file Vector2D.H.

const Vector2D zero
static

Definition at line 70 of file Vector2D.H.

const Vector2D one
static

Definition at line 71 of file Vector2D.H.

const Vector2D max
static

Definition at line 72 of file Vector2D.H.

const Vector2D min
static

Definition at line 73 of file Vector2D.H.


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