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

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

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

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. More...
 

Public Member Functions

 DiagTensor ()
 Construct null. More...
 
template<class Cmpt2 >
 DiagTensor (const VectorSpace< DiagTensor< Cmpt2 >, Cmpt2, 3 > &)
 Construct given VectorSpace. More...
 
 DiagTensor (const Cmpt &txx, const Cmpt &tyy, const Cmpt &tzz)
 Construct given three components. More...
 
 DiagTensor (Istream &)
 Construct from Istream. More...
 
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. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
 VectorSpace (const VectorSpace< DiagTensor< 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< 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. More...
 

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 53 of file DiagTensor.H.

Member Enumeration Documentation

anonymous enum
Enumerator
rank 

Definition at line 62 of file DiagTensor.H.

enum components

Component labeling enumeration.

Enumerator
XX 
YY 
ZZ 

Definition at line 79 of file DiagTensor.H.

Constructor & Destructor Documentation

DiagTensor ( )
inline

Construct null.

Definition at line 37 of file DiagTensorI.H.

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

Here is the caller graph for this function:

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

Construct given VectorSpace.

Definition at line 44 of file DiagTensorI.H.

References DiagTensor< Cmpt >::DiagTensor().

Here is the call graph for this function:

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

Construct given three components.

Definition at line 54 of file DiagTensorI.H.

DiagTensor ( Istream is)
inline

Construct from Istream.

Definition at line 67 of file DiagTensorI.H.

Member Function Documentation

const Cmpt & xx ( ) const
inline
const Cmpt & yy ( ) const
inline
const Cmpt & zz ( ) const
inline
Cmpt & xx ( )
inline
Cmpt & yy ( )
inline
Cmpt & zz ( )
inline

Member Data Documentation

const char* const typeName
static

Definition at line 70 of file DiagTensor.H.

const char* componentNames[]
static

Definition at line 71 of file DiagTensor.H.

const DiagTensor zero
static

Definition at line 72 of file DiagTensor.H.

const DiagTensor one
static

Definition at line 73 of file DiagTensor.H.

const DiagTensor max
static

Definition at line 74 of file DiagTensor.H.

const DiagTensor min
static

Definition at line 75 of file DiagTensor.H.


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