DiagTensor< Cmpt > Class Template Reference

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

Inheritance diagram for DiagTensor< Cmpt >:

Collaboration diagram for DiagTensor< Cmpt >:

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< Form, 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< Form, Cmpt, nCmpt > &)
void	operator+= (const VectorSpace< Form, Cmpt, nCmpt > &)
void	operator-= (const VectorSpace< Form, 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
Data Fields 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

• DiagTensor.H
• DiagTensorI.H

Definition at line 53 of file DiagTensor.H.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
rank

Definition at line 62 of file DiagTensor.H.

components

enum components

Component labeling enumeration.

Enumerator
XX
YY
ZZ

Definition at line 79 of file DiagTensor.H.

Constructor & Destructor Documentation

DiagTensor() [1/4]

DiagTensor

inline

Construct null.

Definition at line 37 of file DiagTensorI.H.

DiagTensor() [2/4]

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

inline

Construct given VectorSpace.

Definition at line 44 of file DiagTensorI.H.

DiagTensor() [3/4]

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

inline

Construct given three components.

Definition at line 54 of file DiagTensorI.H.

DiagTensor() [4/4]

DiagTensor ( Istream &  is )

inline

Construct from Istream.

Definition at line 67 of file DiagTensorI.H.

Member Function Documentation

xx() [1/2]

Cmpt & xx

inline

Definition at line 76 of file DiagTensorI.H.

Referenced by Foam::det(), moleculeCloud::equipartitionAngularMomentum(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), wedgeFvPatchField< Type >::snGradTransformDiag(), and Foam::tr().

Here is the caller graph for this function:

yy() [1/2]

Cmpt & yy

inline

Definition at line 82 of file DiagTensorI.H.

Referenced by molecule::constantProperties::constantProperties(), Foam::det(), moleculeCloud::equipartitionAngularMomentum(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), wedgeFvPatchField< Type >::snGradTransformDiag(), and Foam::tr().

Here is the caller graph for this function:

zz() [1/2]

Cmpt & zz

inline

Definition at line 88 of file DiagTensorI.H.

Referenced by molecule::constantProperties::constantProperties(), Foam::det(), moleculeCloud::equipartitionAngularMomentum(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), wedgeFvPatchField< Type >::snGradTransformDiag(), and Foam::tr().

Here is the caller graph for this function:

xx() [2/2]

Cmpt& xx ( )

inline

yy() [2/2]

Cmpt& yy ( )

inline

zz() [2/2]

Cmpt& zz ( )

inline

Field Documentation

typeName

const char* const typeName

static

Definition at line 70 of file DiagTensor.H.

componentNames

const char* componentNames[]

static

Definition at line 71 of file DiagTensor.H.

zero

const DiagTensor zero

static

Definition at line 72 of file DiagTensor.H.

one

const DiagTensor one

static

Definition at line 73 of file DiagTensor.H.

max

const DiagTensor max

static

Definition at line 74 of file DiagTensor.H.

min

const DiagTensor min

static

Definition at line 75 of file DiagTensor.H.

---

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

• src/OpenFOAM/primitives/DiagTensor/DiagTensor.H
• src/OpenFOAM/primitives/DiagTensor/DiagTensorI.H