FreeFOAM The Cross-Platform CFD Toolkit
DiagTensor< Cmpt > Class Template Reference

Templated 3D DiagTensor derived from VectorSpace. More...

#include <OpenFOAM/DiagTensor_.H>


Detailed Description

template<class Cmpt>
class Foam::DiagTensor< Cmpt >

Templated 3D DiagTensor derived from VectorSpace.

Adding construction from 3 components, element access using xx(), yy() and zz() member functions and the inner-product (dot-product) and outer-product operators.

Source files

Definition at line 54 of file DiagTensor_.H.

+ Inheritance diagram for DiagTensor< Cmpt >:
+ Collaboration diagram for DiagTensor< Cmpt >:

List of all members.

Public Types

enum  { rank = 2 }
enum  components { XX, YY, ZZ }
 Component labeling enumeration. More...
- Public Types inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
enum  
typedef Cmpt cmptType
 Component type.

Public Member Functions

 DiagTensor ()
 Construct null.
 DiagTensor (const VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 > &)
 Construct given VectorSpace.
 DiagTensor (const Cmpt &txx, const Cmpt &tyy, const Cmpt &tzz)
 Construct given three components.
 DiagTensor (Istream &)
 Construct from Istream.
const Cmpt & xx () const
const Cmpt & yy () const
const Cmpt & zz () const
Cmpt & xx ()
Cmpt & yy ()
Cmpt & zz ()
- Public Member Functions inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
 VectorSpace ()
 Construct null.
 VectorSpace (Istream &)
 Construct from Istream.
 VectorSpace (const VectorSpace< DiagTensor< Cmpt >, Cmpt, nCmpt > &)
 Construct as copy.
label size () const
 Return the number of elements in the VectorSpace = nCmpt.
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< DiagTensor< Cmpt >, Cmpt, nCmpt > &)
void operator+= (const VectorSpace< DiagTensor< Cmpt >, Cmpt, nCmpt > &)
void operator-= (const VectorSpace< DiagTensor< 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 DiagTensor zero
static const DiagTensor one
static const DiagTensor max
static const DiagTensor min

Additional Inherited Members

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

Member Enumeration Documentation

anonymous enum
Enumerator:
rank 

Definition at line 63 of file DiagTensor_.H.

enum components

Component labeling enumeration.

Enumerator:
XX 
YY 
ZZ 

Definition at line 80 of file DiagTensor_.H.


Constructor & Destructor Documentation

DiagTensor ( )
inline

Construct null.

Definition at line 37 of file DiagTensorI_.H.

DiagTensor ( const VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 > &  vs)
inline

Construct given VectorSpace.

Definition at line 44 of file DiagTensorI_.H.

DiagTensor ( const Cmpt &  txx,
const Cmpt &  tyy,
const Cmpt &  tzz 
)
inline

Construct given three components.

Definition at line 55 of file DiagTensorI_.H.

DiagTensor ( Istream is)
inline

Construct from Istream.

Definition at line 69 of file DiagTensorI_.H.


Member Function Documentation

Cmpt & xx ( )
inline

Definition at line 97 of file DiagTensorI_.H.

Cmpt & yy ( )
inline

Definition at line 103 of file DiagTensorI_.H.

Cmpt & zz ( )
inline

Definition at line 109 of file DiagTensorI_.H.


Member Data Documentation

const char* const typeName
static

Definition at line 71 of file DiagTensor_.H.

const char* componentNames[]
static

Definition at line 72 of file DiagTensor_.H.

const DiagTensor zero
static

Definition at line 73 of file DiagTensor_.H.

const DiagTensor one
static

Definition at line 74 of file DiagTensor_.H.

const DiagTensor max
static

Definition at line 75 of file DiagTensor_.H.

const DiagTensor min
static

Definition at line 76 of file DiagTensor_.H.


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