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

Templated 3D symmetric tensor derived from VectorSpace adding construction from 6 components, element access using xx(), xy() etc. member functions and the inner-product (dot-product) and outer-product of two Vectors (tensor-product) operators. More...

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

Public Types

enum  { rank = 2 }
 
enum  components {
  XX, XY, XZ, YY,
  YZ, ZZ
}
 Component labeling enumeration. More...
 
typedef SymmTensor< labellabelType
 Equivalent type of labels used for valid component indexing. More...
 
- Public Types inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
enum  
 
typedef Cmpt cmptType
 Component type. More...
 

Public Member Functions

 SymmTensor ()
 Construct null. More...
 
template<class Cmpt2 >
 SymmTensor (const VectorSpace< SymmTensor< Cmpt2 >, Cmpt2, 6 > &)
 Construct given VectorSpace of the same rank. More...
 
 SymmTensor (const SphericalTensor< Cmpt > &)
 Construct given SphericalTensor. More...
 
 SymmTensor (const Cmpt txx, const Cmpt txy, const Cmpt txz, const Cmpt tyy, const Cmpt tyz, const Cmpt tzz)
 Construct given the six components. More...
 
 SymmTensor (Istream &)
 Construct from Istream. More...
 
const Cmpt & xx () const
 
const Cmpt & xy () const
 
const Cmpt & xz () const
 
const Cmpt & yy () const
 
const Cmpt & yz () const
 
const Cmpt & zz () const
 
Cmpt & xx ()
 
Cmpt & xy ()
 
Cmpt & xz ()
 
Cmpt & yy ()
 
Cmpt & yz ()
 
Cmpt & zz ()
 
const SymmTensor< Cmpt > & T () const
 Transpose. More...
 
void operator= (const SphericalTensor< Cmpt > &)
 Construct given SphericalTensor. More...
 
- Public Member Functions inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
 VectorSpace ()
 Construct null. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
 VectorSpace (const VectorSpace< SymmTensor< 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< SymmTensor< Cmpt >, Cmpt, nCmpt > &)
 
void operator+= (const VectorSpace< SymmTensor< Cmpt >, Cmpt, nCmpt > &)
 
void operator-= (const VectorSpace< SymmTensor< Cmpt >, Cmpt, nCmpt > &)
 
void operator*= (const scalar)
 
void operator/= (const scalar)
 

Static Public Attributes

static const char *const typeName = "labelSymmTensor"
 
static const char * componentNames []
 
static const SymmTensor zero
 
static const SymmTensor one
 
static const SymmTensor max
 
static const SymmTensor min
 
static const SymmTensor I
 

Additional Inherited Members

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

Detailed Description

template<class Cmpt>
class Foam::SymmTensor< Cmpt >

Templated 3D symmetric tensor derived from VectorSpace adding construction from 6 components, element access using xx(), xy() etc. member functions and the inner-product (dot-product) and outer-product of two Vectors (tensor-product) operators.

Source files

Definition at line 53 of file SymmTensor.H.

Member Typedef Documentation

Equivalent type of labels used for valid component indexing.

Definition at line 61 of file SymmTensor.H.

Member Enumeration Documentation

anonymous enum
Enumerator
rank 

Definition at line 66 of file SymmTensor.H.

enum components

Component labeling enumeration.

Enumerator
XX 
XY 
XZ 
YY 
YZ 
ZZ 

Definition at line 85 of file SymmTensor.H.

Constructor & Destructor Documentation

SymmTensor ( )
inline

Construct null.

Definition at line 37 of file SymmTensorI.H.

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

Here is the caller graph for this function:

SymmTensor ( const VectorSpace< SymmTensor< Cmpt2 >, Cmpt2, 6 > &  vs)
inline

Construct given VectorSpace of the same rank.

Definition at line 44 of file SymmTensorI.H.

SymmTensor ( const SphericalTensor< Cmpt > &  st)
inline

Construct given SphericalTensor.

Definition at line 53 of file SymmTensorI.H.

References SphericalTensor< Cmpt >::ii(), and SymmTensor< Cmpt >::SymmTensor().

Here is the call graph for this function:

SymmTensor ( const Cmpt  txx,
const Cmpt  txy,
const Cmpt  txz,
const Cmpt  tyy,
const Cmpt  tyz,
const Cmpt  tzz 
)
inline

Construct given the six components.

Definition at line 63 of file SymmTensorI.H.

SymmTensor ( Istream is)
inline

Construct from Istream.

Definition at line 76 of file SymmTensorI.H.

Member Function Documentation

const Cmpt & xx ( ) const
inline
const Cmpt & xy ( ) const
inline
const Cmpt & xz ( ) const
inline
const Cmpt & yy ( ) const
inline
const Cmpt & yz ( ) const
inline
const Cmpt & zz ( ) const
inline
Cmpt & xx ( )
inline
Cmpt & xy ( )
inline
Cmpt & xz ( )
inline
Cmpt & yy ( )
inline
Cmpt & yz ( )
inline
Cmpt & zz ( )
inline
const SymmTensor< Cmpt > & T ( ) const
inline

Transpose.

Definition at line 159 of file SymmTensorI.H.

void operator= ( const SphericalTensor< Cmpt > &  st)
inline

Member Data Documentation

const char *const typeName = "labelSymmTensor"
static

Definition at line 74 of file SymmTensor.H.

const char * componentNames
static
Initial value:
=
{
"xx", "xy", "xz",
"yy", "yz",
"zz"
}

Definition at line 75 of file SymmTensor.H.

const symmTensor zero
static
const symmTensor one
static

Definition at line 78 of file SymmTensor.H.

const symmTensor max
static

Definition at line 79 of file SymmTensor.H.

const symmTensor min
static

Definition at line 80 of file SymmTensor.H.

const symmTensor I
static

Definition at line 81 of file SymmTensor.H.


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