RowVector< Cmpt > Class Template Reference

Templated 3D row-vector derived from MatrixSpace adding construction from 3 components and element access using x(), y() and z(). More...

Inheritance diagram for RowVector< Cmpt >:
Collaboration diagram for RowVector< Cmpt >:

Public Types

enum  components { X, Y, Z }
 Component labeling enumeration. More...
 
typedef RowVector< labellabelType
 Equivalent type of labels used for valid component indexing. More...
 
- Public Types inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
typedef MatrixSpace< RowVector< Cmpt >, Cmpt, Mrows, Ncols > msType
 MatrixSpace type. More...
 
- Public Types inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
typedef VectorSpace< RowVector< Cmpt >, Cmpt, Ncmpts > vsType
 VectorSpace type. More...
 
typedef Cmpt cmptType
 Component type. More...
 

Public Member Functions

 RowVector ()
 Construct null. More...
 
 RowVector (const Foam::zero)
 Construct initialised to zero. More...
 
template<class Cmpt2 >
 RowVector (const MatrixSpace< RowVector< Cmpt2 >, Cmpt2, 1, 3 > &)
 Construct given VectorSpace of the same rank. More...
 
 RowVector (const Cmpt &rvx, const Cmpt &rvy, const Cmpt &rvz)
 Construct given three components. More...
 
 RowVector (Istream &)
 Construct from Istream. More...
 
const Cmpt & x () const
 
const Cmpt & y () const
 
const Cmpt & z () const
 
Cmpt & x ()
 
Cmpt & y ()
 
Cmpt & z ()
 
- Public Member Functions inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
 MatrixSpace ()
 Construct null. More...
 
 MatrixSpace (const Foam::zero)
 Construct initialised to zero. More...
 
 MatrixSpace (const VectorSpace< Form2, Cmpt2, Mrows *Ncols > &)
 Construct as copy of a VectorSpace with the same size. More...
 
 MatrixSpace (const Block2< RowVector< Cmpt >, BRowStart, BColStart > &block)
 Construct from a block of another matrix space. More...
 
 MatrixSpace (Istream &)
 Construct from Istream. More...
 
const Cmpt & elmt () const
 Fast const element access using compile-time addressing. More...
 
Cmpt & elmt ()
 Fast element access using compile-time addressing. More...
 
const Cmpt & xx () const
 
Cmpt & xx ()
 
const Cmpt & xy () const
 
Cmpt & xy ()
 
const Cmpt & xz () const
 
Cmpt & xz ()
 
const Cmpt & yx () const
 
Cmpt & yx ()
 
const Cmpt & yy () const
 
Cmpt & yy ()
 
const Cmpt & yz () const
 
Cmpt & yz ()
 
const Cmpt & zx () const
 
Cmpt & zx ()
 
const Cmpt & zy () const
 
Cmpt & zy ()
 
const Cmpt & zz () const
 
Cmpt & zz ()
 
typeOfTranspose< Cmpt, RowVector< Cmpt > >::type T () const
 Return the transpose of the matrix. More...
 
ConstBlock< SubTensor, BRowStart, BColStart > block () const
 Return a const sub-block corresponding to the specified type. More...
 
Block< SubTensor, BRowStart, BColStart > block ()
 Return a sub-block corresponding to the specified type. More...
 
Foam::MatrixSpace< RowVector< Cmpt >, Cmpt, Mrows, Ncols >::template ConstBlock< SubTensor, BRowStart, BColStart > block () const
 
Foam::MatrixSpace< RowVector< Cmpt >, Cmpt, Mrows, Ncols >::template Block< SubTensor, BRowStart, BColStart > block ()
 
const Cmpt & operator() (const direction &i, const direction &j) const
 (i, j) const element access operator More...
 
Cmpt & operator() (const direction &i, const direction &j)
 (i, j) element access operator More...
 
void operator= (const Foam::zero)
 Assignment to zero. More...
 
void operator= (const Block2< RowVector< Cmpt >, BRowStart, BColStart > &block)
 Assignment to a block of another matrix space. More...
 
void operator&= (const MatrixSpace< RowVector< Cmpt >, Cmpt, Ncols, Ncols > &matrix)
 Inner product with a compatible square matrix. More...
 
- Public Member Functions inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
 VectorSpace ()
 Construct null. More...
 
 VectorSpace (const Foam::zero)
 Construct initialised to zero. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 Construct as copy of a VectorSpace with the same size. More...
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
const ConstBlock< SubVector, BStart > block () const
 
const VectorSpace< RowVector< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart > block () const
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator+= (const VectorSpace< RowVector< Cmpt >, Cmpt, Ncmpts > &)
 
void operator-= (const VectorSpace< RowVector< Cmpt >, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Additional Inherited Members

- Static Public Member Functions inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
static direction m ()
 Return the number of rows. More...
 
static direction n ()
 Return the number of columns. More...
 
static msType identity ()
 Return the identity matrix for square matrix spaces. More...
 
- Static Public Member Functions inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
static direction size ()
 Return the number of elements in the VectorSpace = Ncmpts. More...
 
static RowVector< Cmpt > uniform (const Cmpt &s)
 Return a VectorSpace with all elements = s. More...
 
- Public Attributes inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
Cmpt v_ [Ncmpts]
 The components of this vector space. More...
 
- Static Public Attributes inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
static const direction mRows
 
static const direction nCols
 
- Static Public Attributes inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
static const direction dim
 Dimensionality of space. More...
 
static const direction nComponents
 Number of components in this vector space. More...
 
static const direction mRows
 
static const direction nCols
 
static const char *const typeName
 
static const char *const componentNames []
 
static const RowVector< Cmpt > zero
 
static const RowVector< Cmpt > one
 
static const RowVector< Cmpt > max
 
static const RowVector< Cmpt > min
 
static const RowVector< Cmpt > rootMax
 
static const RowVector< Cmpt > rootMin
 

Detailed Description

template<class Cmpt>
class Foam::RowVector< Cmpt >

Templated 3D row-vector derived from MatrixSpace adding construction from 3 components and element access using x(), y() and z().

Source files

Definition at line 51 of file RowVector.H.

Member Typedef Documentation

◆ labelType

Equivalent type of labels used for valid component indexing.

Definition at line 59 of file RowVector.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator

Definition at line 63 of file RowVector.H.

Constructor & Destructor Documentation

◆ RowVector() [1/5]

RowVector ( )
inline

Construct null.

Definition at line 29 of file RowVectorI.H.

Referenced by RowVector< Cmpt >::RowVector().

Here is the caller graph for this function:

◆ RowVector() [2/5]

RowVector ( const Foam::zero  )
inline

Construct initialised to zero.

Definition at line 34 of file RowVectorI.H.

References RowVector< Cmpt >::RowVector().

Here is the call graph for this function:

◆ RowVector() [3/5]

RowVector ( const MatrixSpace< RowVector< Cmpt2 >, Cmpt2, 1, 3 > &  ms)
inline

Construct given VectorSpace of the same rank.

Definition at line 43 of file RowVectorI.H.

References RowVector< Cmpt >::RowVector().

Here is the call graph for this function:

◆ RowVector() [4/5]

RowVector ( const Cmpt &  rvx,
const Cmpt &  rvy,
const Cmpt &  rvz 
)
inline

Construct given three components.

Definition at line 53 of file RowVectorI.H.

References VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >::v_, RowVector< Cmpt >::X, RowVector< Cmpt >::Y, and RowVector< Cmpt >::Z.

◆ RowVector() [5/5]

RowVector ( Istream is)
inline

Construct from Istream.

Definition at line 66 of file RowVectorI.H.

Member Function Documentation

◆ x() [1/2]

const Cmpt & x ( ) const
inline

◆ y() [1/2]

const Cmpt & y ( ) const
inline

◆ z() [1/2]

const Cmpt & z ( ) const
inline

◆ x() [2/2]

Cmpt & x ( )
inline

◆ y() [2/2]

Cmpt & y ( )
inline

◆ z() [2/2]

Cmpt & z ( )
inline

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