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

#include <SymmTensor.H>

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.
Public Types inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
typedef VectorSpace< SymmTensor< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type.
typedef Cmpt	cmptType
	Component type.
typedef Cmpt	magType
	Magnitude type.
typedef direction	size_type
	The type to represent the size of a VectorSpace.
typedef Cmpt *	iterator
	Random access iterator for traversing VectorSpace.
typedef const Cmpt *	const_iterator
	Random access iterator for traversing VectorSpace.

Public Member Functions
	SymmTensor ()=default
	Default construct.
	SymmTensor (const SymmTensor &)=default
	Copy construct.
SymmTensor &	operator= (const SymmTensor &)=default
	Copy assignment.
	SymmTensor (Foam::zero)
	Construct initialized to zero.
template<class Cmpt2>
	SymmTensor (const VectorSpace< SymmTensor< Cmpt2 >, Cmpt2, 6 > &)
	Construct given VectorSpace of the same rank.
	SymmTensor (const SphericalTensor< Cmpt > &)
	Construct given SphericalTensor.
	SymmTensor (const Vector< Cmpt > &x, const Vector< Cmpt > &y, const Vector< Cmpt > &z, const bool transposed=false)
	Construct given the three row (or column) vectors.
	SymmTensor (const Cmpt txx, const Cmpt txy, const Cmpt txz, const Cmpt tyy, const Cmpt tyz, const Cmpt tzz)
	Construct given the six components.
	SymmTensor (Istream &is)
	Construct from Istream.
const Cmpt &	xx () const noexcept
const Cmpt &	xy () const noexcept
const Cmpt &	xz () const noexcept
const Cmpt &	yx () const noexcept
const Cmpt &	yy () const noexcept
const Cmpt &	yz () const noexcept
const Cmpt &	zx () const noexcept
const Cmpt &	zy () const noexcept
const Cmpt &	zz () const noexcept
Cmpt &	xx () noexcept
Cmpt &	xy () noexcept
Cmpt &	xz () noexcept
Cmpt &	yx () noexcept
Cmpt &	yy () noexcept
Cmpt &	yz () noexcept
Cmpt &	zx () noexcept
Cmpt &	zy () noexcept
Cmpt &	zz () noexcept
Vector< Cmpt >	cx () const
	Extract vector for column 0.
Vector< Cmpt >	cy () const
	Extract vector for column 1.
Vector< Cmpt >	cz () const
	Extract vector for column 2.
template<direction Idx>
Vector< Cmpt >	col () const
	Extract vector for given column: compile-time check of index.
Vector< Cmpt >	col (const direction c) const
	Extract vector for given column (0,1,2): runtime check of index.
void	col (const direction c, const Vector< Cmpt > &v)
	Set values of given column (0,1,2): runtime check of index.
void	cols (const Vector< Cmpt > &x, const Vector< Cmpt > &y, const Vector< Cmpt > &z)
	Set column values.
Vector< Cmpt >	x () const
	Extract vector for row 0.
Vector< Cmpt >	y () const
	Extract vector for row 1.
Vector< Cmpt >	z () const
	Extract vector for row 2.
template<direction Row>
Vector< Cmpt >	row () const
	Extract vector for given row: compile-time check of index.
Vector< Cmpt >	row (const direction r) const
	Extract vector for given row (0,1,2): runtime check of index.
template<direction Idx>
void	row (const Vector< Cmpt > &v)
	Set values of given row: compile-time check of index.
void	row (const direction r, const Vector< Cmpt > &v)
	Set values of given row (0,1,2): runtime check of row.
void	rows (const Vector< Cmpt > &x, const Vector< Cmpt > &y, const Vector< Cmpt > &z)
	Set row values.
Vector< Cmpt >	diag () const
	Extract the diagonal as a vector.
void	diag (const Vector< Cmpt > &v)
	Set values of the diagonal.
void	addDiag (const Vector< Cmpt > &v)
	Add to the diagonal.
void	subtractDiag (const Vector< Cmpt > &v)
	Subtract from the diagonal.
scalar	diagSqr () const
	The L2-norm squared of the diagonal.
bool	is_identity (const scalar tol=ROOTVSMALL) const
	Is identity tensor?
const SymmTensor< Cmpt > &	T () const noexcept
	Return non-Hermitian transpose.
Cmpt	det () const
	The determinate.
Cmpt	det2D (const direction excludeCmpt) const
	The 2D determinant by excluding given direction.
SymmTensor< Cmpt >	adjunct () const
	Return adjunct matrix (transpose of cofactor matrix).
SymmTensor< Cmpt >	cof () const
	Return cofactor matrix (transpose of adjunct matrix).
SymmTensor< Cmpt >	adjunct2D (const direction excludeCmpt) const
	Return 2D adjunct matrix by excluding given direction.
SymmTensor< Cmpt >	inv () const
	Return inverse.
SymmTensor< Cmpt >	safeInv () const
	Return inverse, with (ad hoc) failsafe handling of 2D tensors.
SymmTensor< Cmpt >	inv2D (const direction excludeCmpt) const
	Return inverse of 2D tensor (by excluding given direction).
void	operator= (const SphericalTensor< Cmpt > &)
	Assign to given SphericalTensor.
template<Foam::direction Idx>
Foam::Vector< Cmpt >	row () const
Public Member Functions inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
const Foam::VectorSpace< SymmTensor< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
	VectorSpace ()=default
	Default construct.
const Cmpt &	component (const direction) const
void	replace (const direction, const Cmpt &)
const Cmpt *	cdata () const noexcept
	Return const pointer to the first data element.
Cmpt *	data () noexcept
	Return pointer to the first data element.
void	fill (const Cmpt &s)
	Assign all components to given value.
const Cmpt &	operator[] (const direction) const
void	operator= (const VectorSpace< SymmTensor< Cmpt >, Cmpt, Ncmpts > &)
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 (pointer) to begin of VectorSpace.
const_iterator	cbegin () const noexcept
	Return const_iterator (const pointer) to begin of VectorSpace.
iterator	end () noexcept
	Return an iterator (pointer) to end of VectorSpace.
const_iterator	cend () const noexcept
	Return const_iterator (const pointer) to end of VectorSpace.

Static Public Attributes
static constexpr direction	rank = 2
	Rank of SymmTensor is 2.
static const SymmTensor	I
Static Public Attributes inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
static constexpr direction	dim
	Dimensionality of space.
static constexpr direction	nComponents
	Number of components in this vector space.
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.
static SymmTensor< Cmpt >	uniform (const Cmpt &s)
	Return a VectorSpace with all elements = s.
Public Attributes inherited from VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >
Cmpt	v_ [Ncmpts]
	The components of this vector space.

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.

Source files

Definition at line 50 of file SymmTensor.H.

Member Typedef Documentation

◆ labelType

template<class Cmpt>

typedef SymmTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 61 of file SymmTensor.H.

Member Enumeration Documentation

◆ components

template<class Cmpt>

enum components

Component labeling enumeration.

Enumerator
XX
XY
XZ
YY
YZ
ZZ

Definition at line 80 of file SymmTensor.H.

Constructor & Destructor Documentation

◆ SymmTensor() [1/8]

template<class Cmpt>

SymmTensor ( )

default

Default construct.

Referenced by adjunct(), adjunct2D(), safeInv(), SymmTensor(), SymmTensor(), and SymmTensor().

Here is the caller graph for this function:

◆ SymmTensor() [2/8]

template<class Cmpt>

SymmTensor ( const SymmTensor< Cmpt > & )

default

Copy construct.

◆ SymmTensor() [3/8]

template<class Cmpt>

SymmTensor ( Foam::zero )

inline

Construct initialized to zero.

Definition at line 27 of file SymmTensorI.H.

References SymmTensor(), and VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::zero.

Here is the call graph for this function:

◆ SymmTensor() [4/8]

template<class Cmpt>

template<class Cmpt2>

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

inline

Construct given VectorSpace of the same rank.

Definition at line 35 of file SymmTensorI.H.

References SymmTensor(), and VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::VectorSpace().

Here is the call graph for this function:

◆ SymmTensor() [5/8]

template<class Cmpt>

SymmTensor ( const SphericalTensor< Cmpt > & st )

inline

Construct given SphericalTensor.

Definition at line 45 of file SymmTensorI.H.

References SphericalTensor< Cmpt >::ii(), VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XX, XY, XZ, YY, YZ, Foam::Zero, and ZZ.

Here is the call graph for this function:

◆ SymmTensor() [6/8]

template<class Cmpt>

SymmTensor	(	const Vector< Cmpt > &	x,
		const Vector< Cmpt > &	y,
		const Vector< Cmpt > &	z,
		const bool	transposed = false )

inline

Construct given the three row (or column) vectors.

Definition at line 54 of file SymmTensorI.H.

References rows(), x(), y(), and z().

Here is the call graph for this function:

◆ SymmTensor() [7/8]

template<class Cmpt>

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

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XX, XY, XZ, YY, YZ, and ZZ.

◆ SymmTensor() [8/8]

template<class Cmpt>

SymmTensor ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 81 of file SymmTensorI.H.

References SymmTensor().

Here is the call graph for this function:

Member Function Documentation

◆ operator=() [1/2]

template<class Cmpt>

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

default

Copy assignment.

◆ xx() [1/2]

template<class Cmpt>

const Cmpt & xx ( ) const

inlinenoexcept

Definition at line 150 of file SymmTensor.H.

Here is the caller graph for this function:

◆ xy() [1/2]

template<class Cmpt>

const Cmpt & xy ( ) const

inlinenoexcept

Definition at line 151 of file SymmTensor.H.

Referenced by adjunct(), adjunct2D(), turbulentDFSEMInletFvPatchVectorField::checkStresses(), det(), det2D(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), is_identity(), Foam::lerp(), Foam::magSqr(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), Foam::transform(), Foam::transform(), and Foam::transform().

Here is the caller graph for this function:

◆ xz() [1/2]

template<class Cmpt>

const Cmpt & xz ( ) const

inlinenoexcept

Definition at line 152 of file SymmTensor.H.

Referenced by adjunct(), adjunct2D(), det(), det2D(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), is_identity(), Foam::lerp(), Foam::magSqr(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), Foam::transform(), Foam::transform(), and Foam::transform().

Here is the caller graph for this function:

◆ yx() [1/2]

template<class Cmpt>

const Cmpt & yx ( ) const

inlinenoexcept

Definition at line 153 of file SymmTensor.H.

◆ yy() [1/2]

template<class Cmpt>

const Cmpt & yy ( ) const

inlinenoexcept

Definition at line 154 of file SymmTensor.H.

Here is the caller graph for this function:

◆ yz() [1/2]

template<class Cmpt>

const Cmpt & yz ( ) const

inlinenoexcept

Definition at line 155 of file SymmTensor.H.

Referenced by adjunct(), adjunct2D(), det(), det2D(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), is_identity(), Foam::lerp(), Foam::magSqr(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), Tensor< Cmpt >::Tensor(), Foam::transform(), Foam::transform(), and Foam::transform().

Here is the caller graph for this function:

◆ zx() [1/2]

template<class Cmpt>

const Cmpt & zx ( ) const

inlinenoexcept

Definition at line 156 of file SymmTensor.H.

◆ zy() [1/2]

template<class Cmpt>

const Cmpt & zy ( ) const

inlinenoexcept

Definition at line 157 of file SymmTensor.H.

◆ zz() [1/2]

template<class Cmpt>

const Cmpt & zz ( ) const

inlinenoexcept

Definition at line 158 of file SymmTensor.H.

Referenced by adjunct(), adjunct2D(), primitiveMeshTools::cellDeterminant(), molecule::constantProperties::constantProperties(), det(), det2D(), Foam::diag(), diagSqr(), Foam::innerSqr(), Foam::invariantII(), Foam::invTransform(), is_identity(), Foam::lerp(), Foam::magSqr(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator/(), Tensor< Cmpt >::operator=(), safeInv(), Tensor< Cmpt >::Tensor(), Foam::tr(), Foam::transform(), Foam::transform(), and Foam::transform().

Here is the caller graph for this function:

◆ xx() [2/2]

template<class Cmpt>

Cmpt & xx ( )

inlinenoexcept

Definition at line 160 of file SymmTensor.H.

◆ xy() [2/2]

template<class Cmpt>

Cmpt & xy ( )

inlinenoexcept

Definition at line 161 of file SymmTensor.H.

◆ xz() [2/2]

template<class Cmpt>

Cmpt & xz ( )

inlinenoexcept

Definition at line 162 of file SymmTensor.H.

◆ yx() [2/2]

template<class Cmpt>

Cmpt & yx ( )

inlinenoexcept

Definition at line 163 of file SymmTensor.H.

◆ yy() [2/2]

template<class Cmpt>

Cmpt & yy ( )

inlinenoexcept

Definition at line 164 of file SymmTensor.H.

◆ yz() [2/2]

template<class Cmpt>

Cmpt & yz ( )

inlinenoexcept

Definition at line 165 of file SymmTensor.H.

◆ zx() [2/2]

template<class Cmpt>

Cmpt & zx ( )

inlinenoexcept

Definition at line 166 of file SymmTensor.H.

◆ zy() [2/2]

template<class Cmpt>

Cmpt & zy ( )

inlinenoexcept

Definition at line 167 of file SymmTensor.H.

◆ zz() [2/2]

template<class Cmpt>

Cmpt & zz ( )

inlinenoexcept

Definition at line 168 of file SymmTensor.H.

◆ cx()

template<class Cmpt>

Vector< Cmpt > cx ( ) const

inline

Extract vector for column 0.

Definition at line 176 of file SymmTensor.H.

◆ cy()

template<class Cmpt>

Vector< Cmpt > cy ( ) const

inline

Extract vector for column 1.

Definition at line 181 of file SymmTensor.H.

◆ cz()

template<class Cmpt>

Vector< Cmpt > cz ( ) const

inline

Extract vector for column 2.

Definition at line 186 of file SymmTensor.H.

◆ col() [1/3]

template<class Cmpt>

template<direction Idx>

Vector< Cmpt > col ( ) const

inline

Extract vector for given column: compile-time check of index.

Definition at line 192 of file SymmTensor.H.

◆ col() [2/3]

template<class Cmpt>

Vector< Cmpt > col ( const direction c ) const

inline

Extract vector for given column (0,1,2): runtime check of index.

Definition at line 197 of file SymmTensor.H.

◆ col() [3/3]

template<class Cmpt>

void col	(	const direction	c,
		const Vector< Cmpt > &	v )

inline

Set values of given column (0,1,2): runtime check of index.

Definition at line 202 of file SymmTensor.H.

◆ cols()

template<class Cmpt>

void cols	(	const Vector< Cmpt > &	x,
		const Vector< Cmpt > &	y,
		const Vector< Cmpt > &	z )

inline

Set column values.

Definition at line 207 of file SymmTensor.H.

◆ x()

template<class Cmpt>

Foam::Vector< Cmpt > x ( ) const

inline

Extract vector for row 0.

Definition at line 90 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XX, XY, and XZ.

Referenced by SymmTensor< scalar >::cx(), rows(), and SymmTensor().

Here is the caller graph for this function:

◆ y()

template<class Cmpt>

Foam::Vector< Cmpt > y ( ) const

inline

Extract vector for row 1.

Definition at line 97 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XY, YY, and YZ.

Referenced by SymmTensor< scalar >::cy(), rows(), and SymmTensor().

Here is the caller graph for this function:

◆ z()

template<class Cmpt>

Foam::Vector< Cmpt > z ( ) const

inline

Extract vector for row 2.

Definition at line 104 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XZ, YZ, and ZZ.

Referenced by SymmTensor< scalar >::cz(), row(), rows(), and SymmTensor().

Here is the caller graph for this function:

◆ row() [1/5]

template<class Cmpt>

template<direction Row>

Vector< Cmpt > row ( ) const

inline

Extract vector for given row: compile-time check of index.

Referenced by SymmTensor< scalar >::col(), SymmTensor< scalar >::col(), SymmTensor< scalar >::col(), and row().

Here is the caller graph for this function:

◆ row() [2/5]

template<class Cmpt>

Foam::Vector< Cmpt > row ( const direction r ) const

inline

Extract vector for given row (0,1,2): runtime check of index.

Definition at line 124 of file SymmTensorI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, x, y, z(), and Foam::Zero.

Here is the call graph for this function:

◆ row() [3/5]

template<class Cmpt>

template<Foam::direction Idx>

void row ( const Vector< Cmpt > & v )

inline

Set values of given row: compile-time check of index.

Definition at line 142 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, Vector< Cmpt >::x(), XX, XY, XZ, Vector< Cmpt >::y(), YY, YZ, Vector< Cmpt >::z(), and ZZ.

Here is the call graph for this function:

◆ row() [4/5]

template<class Cmpt>

void row	(	const direction	r,
		const Vector< Cmpt > &	v )

inline

Set values of given row (0,1,2): runtime check of row.

Definition at line 176 of file SymmTensorI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and row().

Here is the call graph for this function:

◆ rows()

template<class Cmpt>

void rows	(	const Vector< Cmpt > &	x,
		const Vector< Cmpt > &	y,
		const Vector< Cmpt > &	z )

inline

Set row values.

Definition at line 162 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, x(), XX, XY, XZ, y(), YY, YZ, z(), and ZZ.

Referenced by SymmTensor< scalar >::cols(), and SymmTensor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diag() [1/2]

template<class Cmpt>

Foam::Vector< Cmpt > diag ( ) const

inline

Extract the diagonal as a vector.

Definition at line 195 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XX, YY, and ZZ.

◆ diag() [2/2]

template<class Cmpt>

void diag ( const Vector< Cmpt > & v )

inline

Set values of the diagonal.

Definition at line 202 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, Vector< Cmpt >::x(), XX, Vector< Cmpt >::y(), YY, Vector< Cmpt >::z(), and ZZ.

Here is the call graph for this function:

◆ addDiag()

template<class Cmpt>

void addDiag ( const Vector< Cmpt > & v )

inline

Add to the diagonal.

Definition at line 209 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, Vector< Cmpt >::x(), XX, Vector< Cmpt >::y(), YY, Vector< Cmpt >::z(), and ZZ.

Here is the call graph for this function:

◆ subtractDiag()

template<class Cmpt>

void subtractDiag ( const Vector< Cmpt > & v )

inline

Subtract from the diagonal.

Definition at line 216 of file SymmTensorI.H.

References VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, Vector< Cmpt >::x(), XX, Vector< Cmpt >::y(), YY, Vector< Cmpt >::z(), and ZZ.

Here is the call graph for this function:

◆ diagSqr()

template<class Cmpt>

Foam::scalar diagSqr ( ) const

inline

The L2-norm squared of the diagonal.

Definition at line 223 of file SymmTensorI.H.

References Foam::magSqr(), xx(), yy(), and zz().

Here is the call graph for this function:

◆ is_identity()

template<class Cmpt>

bool is_identity ( const scalar tol = ROOTVSMALL ) const

inline

Is identity tensor?

Definition at line 235 of file SymmTensorI.H.

References Foam::mag(), xx(), xy(), xz(), yy(), yz(), and zz().

Here is the call graph for this function:

◆ T()

template<class Cmpt>

const SymmTensor< Cmpt > & T ( ) const

inlinenoexcept

Return non-Hermitian transpose.

Definition at line 309 of file SymmTensor.H.

◆ det()

template<class Cmpt>

Cmpt det ( ) const

inline

The determinate.

Definition at line 250 of file SymmTensorI.H.

References xx(), xy(), xz(), yy(), yz(), and zz().

Referenced by Foam::det(), and safeInv().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ det2D()

template<class Cmpt>

Cmpt det2D ( const direction excludeCmpt ) const

inline

The 2D determinant by excluding given direction.

Definition at line 262 of file SymmTensorI.H.

References xx(), xy(), xz(), yy(), yz(), and zz().

Referenced by inv2D().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ adjunct()

template<class Cmpt>

Foam::SymmTensor< Cmpt > adjunct ( ) const

inline

Return adjunct matrix (transpose of cofactor matrix).

Definition at line 283 of file SymmTensorI.H.

References SymmTensor(), xx(), xy(), xz(), yy(), yz(), and zz().

Referenced by cof(), Foam::inv(), inv(), and safeInv().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cof()

template<class Cmpt>

Foam::SymmTensor< Cmpt > cof ( ) const

inline

Return cofactor matrix (transpose of adjunct matrix).

Definition at line 296 of file SymmTensorI.H.

References adjunct().

Referenced by Foam::cof().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ adjunct2D()

template<class Cmpt>

Foam::SymmTensor< Cmpt > adjunct2D ( const direction excludeCmpt ) const

inline

Return 2D adjunct matrix by excluding given direction.

Definition at line 304 of file SymmTensorI.H.

References SymmTensor(), xx(), xy(), xz(), yy(), yz(), Foam::Zero, and zz().

Referenced by inv2D().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inv()

template<class Cmpt>

Foam::SymmTensor< Cmpt > inv ( ) const

inline

Return inverse.

Definition at line 356 of file SymmTensorI.H.

References Foam::abort(), adjunct(), Foam::det(), Foam::FatalError, FatalErrorInFunction, Foam::mag(), and Foam::nl.

Referenced by Foam::inv().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ safeInv()

template<class Cmpt>

Foam::SymmTensor< Cmpt > safeInv ( ) const

inline

Return inverse, with (ad hoc) failsafe handling of 2D tensors.

Definition at line 376 of file SymmTensorI.H.

References adjunct(), Foam::det(), det(), Foam::mag(), Foam::magSqr(), SymmTensor(), xx(), yy(), Foam::Zero, and zz().

Here is the call graph for this function:

◆ inv2D()

template<class Cmpt>

Foam::SymmTensor< Cmpt > inv2D ( const direction excludeCmpt ) const

inline

Return inverse of 2D tensor (by excluding given direction).

Definition at line 343 of file SymmTensorI.H.

References adjunct2D(), and det2D().

Here is the call graph for this function:

◆ operator=() [2/2]

template<class Cmpt>

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

inline

Assign to given SphericalTensor.

Definition at line 434 of file SymmTensorI.H.

References SphericalTensor< Cmpt >::ii(), VectorSpace< SymmTensor< Cmpt >, Cmpt, 6 >::v_, XX, XY, XZ, YY, YZ, Foam::Zero, and ZZ.

Here is the call graph for this function:

◆ row() [5/5]

template<class Cmpt>

template<Foam::direction Idx>

Foam::Vector< Cmpt > row ( ) const

inline

Definition at line 112 of file SymmTensorI.H.

Member Data Documentation

◆ rank

template<class Cmpt>

direction rank = 2

staticconstexpr

Rank of SymmTensor is 2.

Definition at line 69 of file SymmTensor.H.

◆ I

template<class Cmpt>

const SymmTensor I

static

Definition at line 74 of file SymmTensor.H.

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

src/fileFormats/vtk/base/foamVtkCore.H
src/OpenFOAM/primitives/SymmTensor/SymmTensor.H
src/OpenFOAM/primitives/SymmTensor/SymmTensorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ SymmTensor() [1/8]

◆ SymmTensor() [2/8]

◆ SymmTensor() [3/8]

◆ SymmTensor() [4/8]

◆ SymmTensor() [5/8]

◆ SymmTensor() [6/8]

◆ SymmTensor() [7/8]

◆ SymmTensor() [8/8]

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]

◆ cx()

◆ cy()

◆ cz()

◆ col() [1/3]

◆ col() [2/3]

◆ col() [3/3]

◆ cols()

◆ x()

◆ y()

◆ z()

◆ row() [1/5]

◆ row() [2/5]

◆ row() [3/5]

◆ row() [4/5]

◆ rows()

◆ diag() [1/2]

◆ diag() [2/2]

◆ addDiag()

◆ subtractDiag()

◆ diagSqr()

◆ is_identity()

◆ T()

◆ det()

◆ det2D()

◆ adjunct()

◆ cof()

◆ adjunct2D()

◆ inv()

◆ safeInv()

◆ inv2D()

◆ operator=() [2/2]

◆ row() [5/5]

Member Data Documentation

◆ rank

◆ I