A templated (3 x 3) symmetric tensor of objects of <T>, effectively containing 6 elements, derived from VectorSpace. More...

Inheritance diagram for SymmTensor< Cmpt >:

[legend]

Collaboration diagram for SymmTensor< Cmpt >:

[legend]

Public Types
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 >
typedef VectorSpace< SymmTensor< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type. More...

typedef Cmpt	cmptType
	Component type. More...

typedef Cmpt	magType
	Magnitude type. More...

typedef Cmpt *	iterator
	Random access iterator for traversing VectorSpace. More...

Public Member Functions
	SymmTensor ()=default
	Default construct. More...

	SymmTensor (const SymmTensor &)=default
	Copy construct. More...

SymmTensor &	operator= (const SymmTensor &)=default
	Copy assignment. More...

	SymmTensor (const Foam::zero)
	Construct initialized to zero. 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 &is)
	Construct from Istream. More...

const Cmpt &	xx () const

const Cmpt &	xy () const

const Cmpt &	xz () const

const Cmpt &	yx () const

const Cmpt &	yy () const

const Cmpt &	yz () const

const Cmpt &	zx () const

const Cmpt &	zy () const

const Cmpt &	zz () const

Cmpt &	xx ()

Cmpt &	xy ()

Cmpt &	xz ()

Cmpt &	yx ()

Cmpt &	yy ()

Cmpt &	yz ()

Cmpt &	zx ()

Cmpt &	zy ()

Cmpt &	zz ()

Vector< Cmpt >	diag () const
	Extract the diagonal as a vector. More...

void	diag (const Vector< Cmpt > &v)
	Set values of the diagonal. More...

const SymmTensor< Cmpt > &	T () const
	Return non-Hermitian transpose. More...

void	operator= (const SphericalTensor< Cmpt > &)
	Assign to given SphericalTensor. More...

Public Member Functions inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
	VectorSpace ()=default
	Default construct. More...

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

	VectorSpace (const VectorSpace< SymmTensor< Cmpt >, Cmpt, Ncmpts > &vs)
	Copy construct. More...

	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Copy construct of a VectorSpace with the same size. More...

	VectorSpace (Istream &is)
	Construct from Istream. 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 *	cdata () const noexcept
	Return const pointer to the first data element. More...

Cmpt *	data () noexcept
	Return pointer to the first data element. More...

const ConstBlock< SubVector, BStart >	block () const

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

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

void	operator= (const Foam::zero)

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

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

void	operator*= (const scalar)

void	operator/= (const scalar)

iterator	begin () noexcept
	Return an iterator to begin of VectorSpace. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of VectorSpace. More...

iterator	end () noexcept
	Return an iterator to end of VectorSpace. More...

const_iterator	end () const noexcept
	Return const_iterator to end of VectorSpace. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of VectorSpace. More...

const_iterator	cend () const noexcept
	Return const_iterator to end of VectorSpace. More...

Static Public Attributes
static constexpr direction	rank = 2
	Rank of SymmTensor is 2. More...

static const SymmTensor	I

Static Public Attributes inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
static constexpr direction	dim
	Dimensionality of space. More...

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

static constexpr direction	mRows

static constexpr direction	nCols

static const char *const	typeName

static const char *const	componentNames []

static const SymmTensor< Cmpt >	zero

static const SymmTensor< Cmpt >	one

static const SymmTensor< Cmpt >	max

static const SymmTensor< Cmpt >	min

static const SymmTensor< Cmpt >	rootMax

static const SymmTensor< Cmpt >	rootMin

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts. More...

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

Public Attributes inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
const typedef Cmpt *	const_iterator
	Random access iterator for traversing VectorSpace. More...

Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Detailed Description

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

A templated (3 x 3) symmetric tensor of objects of <T>, effectively containing 6 elements, derived from VectorSpace.

See also: Test-SymmTensor.C

Source files

Definition at line 58 of file SymmTensor.H.

Member Typedef Documentation

◆ labelType

typedef SymmTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 67 of file SymmTensor.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
XX
XY
XZ
YY
YZ
ZZ

Definition at line 82 of file SymmTensor.H.

Constructor & Destructor Documentation

◆ SymmTensor() [1/7]

SymmTensor ( )

default

Default construct.

◆ SymmTensor() [2/7]

SymmTensor ( const SymmTensor< Cmpt > & )

default

Copy construct.

◆ SymmTensor() [3/7]

SymmTensor ( const Foam::zero )

inline

Construct initialized to zero.

Definition at line 34 of file SymmTensorI.H.

◆ SymmTensor() [4/7]

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

inline

Construct given VectorSpace of the same rank.

Definition at line 43 of file SymmTensorI.H.

◆ SymmTensor() [5/7]

SymmTensor ( const SphericalTensor< Cmpt > & st )

inline

Construct given SphericalTensor.

Definition at line 52 of file SymmTensorI.H.

◆ SymmTensor() [6/7]

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 62 of file SymmTensorI.H.

◆ SymmTensor() [7/7]

SymmTensor ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 75 of file SymmTensorI.H.

Member Function Documentation

◆ operator=() [1/2]

SymmTensor& operator= ( const SymmTensor< Cmpt > & )

default

Copy assignment.

◆ xx() [1/2]

const Cmpt & xx ( ) const

inline

Definition at line 84 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), Foam::tr(), and Foam::transform().

Here is the caller graph for this function:

◆ xy() [1/2]

const Cmpt & xy ( ) const

inline

Definition at line 90 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), and Foam::transform().

Here is the caller graph for this function:

◆ xz() [1/2]

const Cmpt & xz ( ) const

inline

Definition at line 96 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), and Foam::transform().

Here is the caller graph for this function:

◆ yx() [1/2]

const Cmpt & yx ( ) const

inline

Definition at line 102 of file SymmTensorI.H.

◆ yy() [1/2]

const Cmpt & yy ( ) const

inline

Definition at line 108 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), Foam::tr(), and Foam::transform().

Here is the caller graph for this function:

◆ yz() [1/2]

const Cmpt & yz ( ) const

inline

Definition at line 114 of file SymmTensorI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), and Foam::transform().

Here is the caller graph for this function:

◆ zx() [1/2]

const Cmpt & zx ( ) const

inline

Definition at line 120 of file SymmTensorI.H.

◆ zy() [1/2]

const Cmpt & zy ( ) const

inline

Definition at line 126 of file SymmTensorI.H.

◆ zz() [1/2]

const Cmpt & zz ( ) const

inline

Definition at line 132 of file SymmTensorI.H.

Referenced by primitiveMeshTools::cellDeterminant(), Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor< scalar >::operator=(), Tensor< scalar >::Tensor(), Foam::tr(), and Foam::transform().

Here is the caller graph for this function:

◆ xx() [2/2]

Cmpt & xx ( )

inline

Definition at line 139 of file SymmTensorI.H.

◆ xy() [2/2]

Cmpt & xy ( )

inline

Definition at line 145 of file SymmTensorI.H.

◆ xz() [2/2]

Cmpt & xz ( )

inline

Definition at line 151 of file SymmTensorI.H.

◆ yx() [2/2]

Cmpt & yx ( )

inline

Definition at line 157 of file SymmTensorI.H.

◆ yy() [2/2]

Cmpt & yy ( )

inline

Definition at line 163 of file SymmTensorI.H.

◆ yz() [2/2]

Cmpt & yz ( )

inline

Definition at line 169 of file SymmTensorI.H.

◆ zx() [2/2]

Cmpt & zx ( )

inline

Definition at line 175 of file SymmTensorI.H.

◆ zy() [2/2]

Cmpt & zy ( )

inline

Definition at line 181 of file SymmTensorI.H.

◆ zz() [2/2]

Cmpt & zz ( )

inline

Definition at line 187 of file SymmTensorI.H.

◆ diag() [1/2]

Foam::Vector< Cmpt > diag ( ) const

inline

Extract the diagonal as a vector.

Definition at line 194 of file SymmTensorI.H.

◆ diag() [2/2]

void diag ( const Vector< Cmpt > & v )

inline

Set values of the diagonal.

Definition at line 201 of file SymmTensorI.H.

◆ T()

const Foam::SymmTensor< Cmpt > & T ( ) const

inline

Return non-Hermitian transpose.

Definition at line 208 of file SymmTensorI.H.

◆ operator=() [2/2]

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

inline

Assign to given SphericalTensor.

Definition at line 217 of file SymmTensorI.H.

Member Data Documentation

◆ rank

constexpr direction rank = 2

staticconstexpr

Rank of SymmTensor is 2.

Definition at line 73 of file SymmTensor.H.

◆ I

const Foam::labelSymmTensor I

static

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

◆ components

Constructor & Destructor Documentation

◆ SymmTensor() [1/7]

◆ SymmTensor() [2/7]

◆ SymmTensor() [3/7]

◆ SymmTensor() [4/7]

◆ SymmTensor() [5/7]

◆ SymmTensor() [6/7]

◆ SymmTensor() [7/7]

Member Function Documentation

◆ operator=() [1/2]

◆ xx() [1/2]

◆ xy() [1/2]

◆ xz() [1/2]

◆ yx() [1/2]

◆ yy() [1/2]

◆ yz() [1/2]

◆ zx() [1/2]

◆ zy() [1/2]

◆ zz() [1/2]

◆ xx() [2/2]

◆ xy() [2/2]

◆ xz() [2/2]

◆ yx() [2/2]

◆ yy() [2/2]

◆ yz() [2/2]

◆ zx() [2/2]

◆ zy() [2/2]

◆ zz() [2/2]

◆ diag() [1/2]

◆ diag() [2/2]

◆ T()

◆ operator=() [2/2]

Member Data Documentation

◆ rank

◆ I

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