Public Types | Public Member Functions | List of all members
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 >:
Inheritance graph
[legend]
Collaboration diagram for RowVector< Cmpt >:
Collaboration graph
[legend]

Public Types

enum  components { X, Y, Z }
 
typedef RowVector< label > labelType
 
- Public Types inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
typedef MatrixSpace< RowVector< Cmpt >, Cmpt, Mrows, Ncols > msType
 
- Public Types inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
typedef VectorSpace< Form, Cmpt, Ncmpts > vsType
 
typedef Cmpt cmptType
 
typedef Cmpt magType
 
typedef Cmpt * iterator
 

Public Member Functions

 RowVector ()
 
 RowVector (const Foam::zero)
 
template<class Cmpt2 >
 RowVector (const MatrixSpace< RowVector< Cmpt2 >, Cmpt2, 1, 3 > &)
 
 RowVector (const Cmpt &rvx, const Cmpt &rvy, const Cmpt &rvz)
 
 RowVector (Istream &)
 
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 ()=default
 
 MatrixSpace (const Foam::zero)
 
 MatrixSpace (const VectorSpace< Form2, Cmpt2, Mrows *Ncols > &)
 
 MatrixSpace (const Block2< RowVector< Cmpt >, BRowStart, BColStart > &block)
 
 MatrixSpace (Istream &is)
 
const Cmpt & elmt () const
 
Cmpt & elmt ()
 
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
 
ConstBlock< SubTensor, BRowStart, BColStart > block () const
 
Block< SubTensor, BRowStart, BColStart > block ()
 
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
 
Cmpt & operator() (const direction &i, const direction &j)
 
void operator= (const Foam::zero)
 
void operator= (const Block2< RowVector< Cmpt >, BRowStart, BColStart > &block)
 
void operator&= (const MatrixSpace< RowVector< Cmpt >, Cmpt, Ncols, Ncols > &matrix)
 
- Public Member Functions inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
 VectorSpace ()=default
 
 VectorSpace (const Foam::zero)
 
 VectorSpace (const VectorSpace< Form, Cmpt, Ncmpts > &vs)
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 
 VectorSpace (Istream &is)
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
const Cmpt * cdata () const noexcept
 
Cmpt * data () noexcept
 
const ConstBlock< SubVector, BStart > block () const
 
const Foam::VectorSpace< Form, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart > block () const
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
void operator+= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator-= (const VectorSpace< Form, Cmpt, Ncmpts > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 
iterator begin () noexcept
 
const_iterator begin () const noexcept
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
const_iterator cbegin () const noexcept
 
const_iterator cend () const noexcept
 

Additional Inherited Members

- Static Public Member Functions inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
static direction m () noexcept
 
static direction n () noexcept
 
static msType identity ()
 
- Static Public Member Functions inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
static constexpr direction size () noexcept
 
static Form uniform (const Cmpt &s)
 
- Public Attributes inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
const typedef Cmpt * const_iterator
 
Cmpt v_ [Ncmpts]
 
- Static Public Attributes inherited from MatrixSpace< RowVector< Cmpt >, Cmpt, 1, 3 >
static constexpr direction mRows
 
static constexpr direction nCols
 
- Static Public Attributes inherited from VectorSpace< RowVector< Cmpt >, Cmpt, Mrows *Ncols >
static constexpr direction dim
 
static constexpr direction nComponents
 
static constexpr direction mRows
 
static constexpr direction nCols
 
static const char *const typeName
 
static const char *const componentNames []
 
static const Form zero
 
static const Form one
 
static const Form max
 
static const Form min
 
static const Form rootMax
 
static const Form 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 49 of file RowVector.H.

Member Typedef Documentation

◆ labelType

typedef RowVector<label> labelType

Definition at line 57 of file RowVector.H.

Member Enumeration Documentation

◆ components

enum components
Enumerator

Definition at line 61 of file RowVector.H.

Constructor & Destructor Documentation

◆ RowVector() [1/5]

RowVector
inline

Definition at line 24 of file RowVectorI.H.

◆ RowVector() [2/5]

RowVector ( const Foam::zero  )
inline

Definition at line 29 of file RowVectorI.H.

◆ RowVector() [3/5]

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

Definition at line 38 of file RowVectorI.H.

◆ RowVector() [4/5]

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

Definition at line 48 of file RowVectorI.H.

References Y.

◆ RowVector() [5/5]

RowVector ( Istream is)
inline

Definition at line 61 of file RowVectorI.H.

Member Function Documentation

◆ x() [1/2]

Cmpt & x
inline

Definition at line 70 of file RowVectorI.H.

◆ y() [1/2]

Cmpt & y
inline

Definition at line 76 of file RowVectorI.H.

References Y.

◆ z() [1/2]

Cmpt & z
inline

Definition at line 82 of file RowVectorI.H.

◆ 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: