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

Inheritance diagram for DiagTensor< Cmpt >:

Collaboration diagram for DiagTensor< Cmpt >:

Public Types
enum	components { XX , YY , ZZ }
	Component labeling enumeration. More...

typedef DiagTensor< label >	labelType
	Equivalent type of labels used for valid component indexing. More...

Public Types inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
typedef VectorSpace< DiagTensor< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type. More...

typedef Cmpt	cmptType
	Component type. More...

Public Member Functions
	DiagTensor ()
	Construct null. More...

	DiagTensor (const Foam::zero)
	Construct initialised to zero. 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 (const Vector< Cmpt > &v)
	Construct from Vector. 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 ()

	operator Vector< Cmpt > () const
	Explicit conversion to Vector. More...

Public Member Functions inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
	VectorSpace ()
	Construct null. More...

	VectorSpace (const Foam::zero)
	Construct initialised to zero. More...

	VectorSpace (Istream &)
	Construct from Istream. More...

	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Construct as copy of a VectorSpace with the same size. More...

const Cmpt &	component (const direction) const

Cmpt &	component (const direction)

void	component (Cmpt &, const direction) const

void	replace (const direction, const Cmpt &)

const ConstBlock< SubVector, BStart >	block () const

const VectorSpace< DiagTensor< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

void	operator+= (const VectorSpace< DiagTensor< Cmpt >, Cmpt, Ncmpts > &)

void	operator-= (const VectorSpace< DiagTensor< Cmpt >, Cmpt, Ncmpts > &)

void	operator= (const Foam::zero)

void	operator*= (const Type)

void	operator/= (const Type)

Static Public Attributes
static const direction	rank = 2
	Rank of DiagTensor is 2. More...

Static Public Attributes inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
static const direction	dim
	Dimensionality of space. More...

static const direction	nComponents
	Number of components in this vector space. More...

static const direction	mRows

static const direction	nCols

static const char *const	typeName

static const char *const	componentNames []

static const DiagTensor< Cmpt >	zero

static const DiagTensor< Cmpt >	one

static const DiagTensor< Cmpt >	max

static const DiagTensor< Cmpt >	min

static const DiagTensor< Cmpt >	rootMax

static const DiagTensor< Cmpt >	rootMin

static const DiagTensor< Cmpt >	nan

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
static direction	size ()
	Return the number of elements in the VectorSpace = Ncmpts. More...

static DiagTensor< Cmpt >	uniform (const Cmpt &s)
	Return a VectorSpace with all elements = s. More...

Public Attributes inherited from VectorSpace< DiagTensor< Cmpt >, Cmpt, 3 >
Cmpt	v_ [Ncmpts]
	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 Typedef Documentation

◆ labelType

typedef DiagTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 61 of file DiagTensor.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
XX
YY
ZZ

Definition at line 71 of file DiagTensor.H.

Constructor & Destructor Documentation

◆ DiagTensor() [1/6]

DiagTensor

inline

Construct null.

Definition at line 32 of file DiagTensorI.H.

◆ DiagTensor() [2/6]

DiagTensor ( const Foam::zero )

inline

Construct initialised to zero.

Definition at line 37 of file DiagTensorI.H.

◆ DiagTensor() [3/6]

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

inline

Construct given VectorSpace.

Definition at line 45 of file DiagTensorI.H.

◆ DiagTensor() [4/6]

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

inline

Construct given three components.

Definition at line 55 of file DiagTensorI.H.

◆ DiagTensor() [5/6]

DiagTensor ( const Vector< Cmpt > & v )

inlineexplicit

Construct from Vector.

Definition at line 69 of file DiagTensorI.H.

◆ DiagTensor() [6/6]

DiagTensor ( Istream & is )

inline

Construct from Istream.

Definition at line 76 of file DiagTensorI.H.

Member Function Documentation

◆ xx() [1/2]

const Cmpt & xx

inline

Definition at line 85 of file DiagTensorI.H.

Referenced by Foam::det(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), and Foam::tr().

Here is the caller graph for this function:

◆ yy() [1/2]

const Cmpt & yy

inline

Definition at line 91 of file DiagTensorI.H.

Referenced by molecule::constantProperties::constantProperties(), Foam::det(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), and Foam::tr().

Here is the caller graph for this function:

◆ zz() [1/2]

const Cmpt & zz

inline

Definition at line 97 of file DiagTensorI.H.

Referenced by molecule::constantProperties::constantProperties(), Foam::det(), Foam::inv(), Foam::operator&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), and Foam::tr().

Here is the caller graph for this function:

◆ xx() [2/2]

Cmpt & xx

inline

Definition at line 104 of file DiagTensorI.H.

◆ yy() [2/2]

Cmpt & yy

inline

Definition at line 110 of file DiagTensorI.H.

◆ zz() [2/2]

Cmpt & zz

inline

Definition at line 116 of file DiagTensorI.H.

◆ operator Vector< Cmpt >()

operator Vector< Cmpt > ( ) const

inlineexplicit

Explicit conversion to Vector.

Member Data Documentation

◆ rank

const direction rank = 2

static

Rank of DiagTensor is 2.

Definition at line 67 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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ DiagTensor() [1/6]

◆ DiagTensor() [2/6]

◆ DiagTensor() [3/6]

◆ DiagTensor() [4/6]

◆ DiagTensor() [5/6]

◆ DiagTensor() [6/6]

Member Function Documentation

◆ xx() [1/2]

◆ yy() [1/2]

◆ zz() [1/2]

◆ xx() [2/2]

◆ yy() [2/2]

◆ zz() [2/2]

◆ operator Vector< Cmpt >()

Member Data Documentation

◆ rank

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