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 >:

[legend]

Collaboration diagram for SymmTensor< Cmpt >:

[legend]

Public Types
enum	{ rank = 2 }

enum	components { XX, XY, XZ, YY, YZ, ZZ }
	Component labeling enumeration. More...

typedef SymmTensor< label >	labelType
	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< 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 = "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
Data Fields 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

◆ labelType

typedef SymmTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 61 of file SymmTensor.H.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
rank

Definition at line 66 of file SymmTensor.H.

◆ components

enum components

Component labeling enumeration.

Enumerator
XX
XY
XZ
YY
YZ
ZZ

Definition at line 85 of file SymmTensor.H.

Constructor & Destructor Documentation

◆ SymmTensor() [1/5]

SymmTensor

inline

Construct null.

Definition at line 37 of file SymmTensorI.H.

◆ SymmTensor() [2/5]

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() [3/5]

SymmTensor ( const SphericalTensor< Cmpt > & st )

inline

Construct given SphericalTensor.

Definition at line 53 of file SymmTensorI.H.

◆ SymmTensor() [4/5]

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() [5/5]

SymmTensor ( Istream & is )

inline

Construct from Istream.

Definition at line 76 of file SymmTensorI.H.

Member Function Documentation

◆ xx() [1/2]

Cmpt & xx

inline

Definition at line 85 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), Foam::det(), Foam::diag(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::tr(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ xy() [1/2]

Cmpt & xy

inline

Definition at line 91 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ xz() [1/2]

Cmpt & xz

inline

Definition at line 97 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ yy() [1/2]

Cmpt & yy

inline

Definition at line 103 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), Foam::det(), Foam::diag(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::tr(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ yz() [1/2]

Cmpt & yz

inline

Definition at line 109 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ zz() [1/2]

Cmpt & zz

inline

Definition at line 115 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), Foam::det(), Foam::diag(), Foam::innerSqr(), vtkTools::insert(), writeFuns::insert(), Foam::inv(), Foam::invariantII(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Tensor< scalar >::Tensor(), Foam::tr(), Foam::transform(), and dxSurfaceWriter::writeData().

Here is the caller graph for this function:

◆ xx() [2/2]

Cmpt& xx ( )

inline

◆ xy() [2/2]

Cmpt& xy ( )

inline

◆ xz() [2/2]

Cmpt& xz ( )

inline

◆ yy() [2/2]

Cmpt& yy ( )

inline

◆ yz() [2/2]

Cmpt& yz ( )

inline

◆ zz() [2/2]

Cmpt& zz ( )

inline

◆ T()

const SymmTensor< Cmpt > & T

inline

Transpose.

Definition at line 159 of file SymmTensorI.H.

◆ operator=()

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

inline

Construct given SphericalTensor.

Definition at line 168 of file SymmTensorI.H.

Field Documentation

◆ typeName

const char *const typeName = "labelSymmTensor"

static

Definition at line 74 of file SymmTensor.H.

◆ componentNames

const char * componentNames

static

Initial value:

=
{
    "xx", "xy", "xz",
          "yy", "yz",
                "zz"
}

Definition at line 75 of file SymmTensor.H.

◆ zero

const labelSymmTensor zero

static

Definition at line 77 of file SymmTensor.H.

◆ one

const labelSymmTensor one

static

Definition at line 78 of file SymmTensor.H.

◆ max

const SymmTensor max

static

Definition at line 79 of file SymmTensor.H.

◆ min

const SymmTensor min

static

Definition at line 80 of file SymmTensor.H.

◆ I

const SymmTensor I

static

Definition at line 81 of file SymmTensor.H.

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

src/OpenFOAM/primitives/SymmTensor/SymmTensor.H
src/OpenFOAM/primitives/SymmTensor/labelSymmTensor/labelSymmTensor.C
src/OpenFOAM/primitives/SymmTensor/SymmTensorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ anonymous enum

◆ components

Constructor & Destructor Documentation

◆ SymmTensor() [1/5]

◆ SymmTensor() [2/5]

◆ SymmTensor() [3/5]

◆ SymmTensor() [4/5]

◆ SymmTensor() [5/5]

Member Function Documentation

◆ xx() [1/2]

◆ xy() [1/2]

◆ xz() [1/2]

◆ yy() [1/2]

◆ yz() [1/2]

◆ zz() [1/2]

◆ xx() [2/2]

◆ xy() [2/2]

◆ xz() [2/2]

◆ yy() [2/2]

◆ yz() [2/2]

◆ zz() [2/2]

◆ T()

◆ operator=()

Field Documentation

◆ typeName

◆ componentNames

◆ zero

◆ one

◆ max

◆ min

◆ I

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