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

Inheritance diagram for SymmTensor2D< Cmpt >:

[legend]

Collaboration diagram for SymmTensor2D< Cmpt >:

[legend]

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

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

Public Types inherited from VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >
typedef VectorSpace< SymmTensor2D< 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...

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

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

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

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

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

	SymmTensor2D (const VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 > &)
	Construct given VectorSpace. More...

	SymmTensor2D (const SphericalTensor2D< Cmpt > &)
	Construct given SphericalTensor. More...

	SymmTensor2D (const Cmpt txx, const Cmpt txy, const Cmpt tyy)
	Construct given the three components. More...

	SymmTensor2D (Istream &is)
	Construct from Istream. More...

const Cmpt &	xx () const noexcept

const Cmpt &	xy () const noexcept

const Cmpt &	yx () const noexcept

const Cmpt &	yy () const noexcept

Cmpt &	xx () noexcept

Cmpt &	xy () noexcept

Cmpt &	yx () noexcept

Cmpt &	yy () noexcept

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

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

scalar	diagSqr () const
	The L2-norm squared of the diagonal. More...

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

Cmpt	det () const
	The determinate. More...

SymmTensor2D< Cmpt >	adjunct () const
	Return adjunct matrix (transpose of cofactor matrix) More...

SymmTensor2D< Cmpt >	cof () const
	Return cofactor matrix (transpose of adjunct matrix) More...

SymmTensor2D< Cmpt >	inv () const
	Return inverse. More...

void	operator= (const SphericalTensor2D< Cmpt > &)
	Construct given SphericalTensor2D. More...

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

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

	VectorSpace (const VectorSpace< SymmTensor2D< 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< SymmTensor2D< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

void	operator= (const Foam::zero)

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

void	operator-= (const VectorSpace< SymmTensor2D< 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 SymmTensor2D is 2. More...

static const SymmTensor2D	I

Static Public Attributes inherited from VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >
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 SymmTensor2D< Cmpt >	zero

static const SymmTensor2D< Cmpt >	one

static const SymmTensor2D< Cmpt >	max

static const SymmTensor2D< Cmpt >	min

static const SymmTensor2D< Cmpt >	rootMax

static const SymmTensor2D< Cmpt >	rootMin

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

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

Public Attributes inherited from VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >
Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Detailed Description

template<class Cmpt>
class Foam::SymmTensor2D< Cmpt >

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

See also: Test-SymmTensor2D.C

Source files

Definition at line 54 of file SymmTensor2D.H.

Member Typedef Documentation

◆ labelType

typedef SymmTensor2D<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 65 of file SymmTensor2D.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
XX
XY
YY

Definition at line 84 of file SymmTensor2D.H.

Constructor & Destructor Documentation

◆ SymmTensor2D() [1/7]

SymmTensor2D ( )

default

Default construct.

◆ SymmTensor2D() [2/7]

SymmTensor2D ( const SymmTensor2D< Cmpt > & )

default

Copy construct.

◆ SymmTensor2D() [3/7]

SymmTensor2D ( const Foam::zero )

inline

Construct initialized to zero.

Definition at line 27 of file SymmTensor2DI.H.

◆ SymmTensor2D() [4/7]

SymmTensor2D ( const VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 > & vs )

inline

Construct given VectorSpace.

Definition at line 35 of file SymmTensor2DI.H.

◆ SymmTensor2D() [5/7]

SymmTensor2D ( const SphericalTensor2D< Cmpt > & st )

inline

Construct given SphericalTensor.

Definition at line 44 of file SymmTensor2DI.H.

References SphericalTensor2D< Cmpt >::ii(), and Foam::Zero.

Here is the call graph for this function:

◆ SymmTensor2D() [6/7]

SymmTensor2D	(	const Cmpt	txx,
		const Cmpt	txy,
		const Cmpt	tyy
	)

inline

Construct given the three components.

Definition at line 53 of file SymmTensor2DI.H.

◆ SymmTensor2D() [7/7]

SymmTensor2D ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 64 of file SymmTensor2DI.H.

Member Function Documentation

◆ operator=() [1/2]

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

default

Copy assignment.

◆ xx() [1/2]

const Cmpt& xx ( ) const

inlinenoexcept

Definition at line 141 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XX.

Referenced by Foam::innerSqr(), Foam::magSqr(), Foam::operator &(), Foam::operator &&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor2D< Cmpt >::operator=(), Tensor2D< Cmpt >::Tensor2D(), and Foam::tr().

Here is the caller graph for this function:

◆ xy() [1/2]

const Cmpt& xy ( ) const

inlinenoexcept

Definition at line 142 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XY.

Referenced by Foam::innerSqr(), Foam::magSqr(), Foam::operator &(), Foam::operator &&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor2D< Cmpt >::operator=(), and Tensor2D< Cmpt >::Tensor2D().

Here is the caller graph for this function:

◆ yx() [1/2]

const Cmpt& yx ( ) const

inlinenoexcept

Definition at line 143 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XY.

◆ yy() [1/2]

const Cmpt& yy ( ) const

inlinenoexcept

Definition at line 144 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::YY.

Referenced by Foam::innerSqr(), Foam::magSqr(), Foam::operator &(), Foam::operator &&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), Tensor2D< Cmpt >::operator=(), Tensor2D< Cmpt >::Tensor2D(), and Foam::tr().

Here is the caller graph for this function:

◆ xx() [2/2]

Cmpt& xx ( )

inlinenoexcept

Definition at line 146 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XX.

◆ xy() [2/2]

Cmpt& xy ( )

inlinenoexcept

Definition at line 147 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XY.

◆ yx() [2/2]

Cmpt& yx ( )

inlinenoexcept

Definition at line 148 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::XY.

◆ yy() [2/2]

Cmpt& yy ( )

inlinenoexcept

Definition at line 149 of file SymmTensor2D.H.

References VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >::v_, and SymmTensor2D< Cmpt >::YY.

◆ diag() [1/2]

Foam::Vector2D< Cmpt > diag ( ) const

inline

Extract the diagonal as a vector.

Definition at line 73 of file SymmTensor2DI.H.

◆ diag() [2/2]

void diag ( const Vector2D< Cmpt > & v )

inline

Set values of the diagonal.

Definition at line 80 of file SymmTensor2DI.H.

References Vector2D< Cmpt >::x(), and Vector2D< Cmpt >::y().

Here is the call graph for this function:

◆ diagSqr()

Foam::scalar diagSqr ( ) const

inline

The L2-norm squared of the diagonal.

Definition at line 87 of file SymmTensor2DI.H.

References Foam::magSqr().

Here is the call graph for this function:

◆ T()

const SymmTensor2D<Cmpt>& T ( ) const

inlinenoexcept

Return non-Hermitian transpose.

Definition at line 175 of file SymmTensor2D.H.

◆ det()

Cmpt det ( ) const

inline

The determinate.

Definition at line 98 of file SymmTensor2DI.H.

Referenced by Foam::det().

Here is the caller graph for this function:

◆ adjunct()

Foam::SymmTensor2D< Cmpt > adjunct ( ) const

inline

Return adjunct matrix (transpose of cofactor matrix)

Definition at line 105 of file SymmTensor2DI.H.

Referenced by Foam::inv().

Here is the caller graph for this function:

◆ cof()

Foam::SymmTensor2D< Cmpt > cof ( ) const

inline

Return cofactor matrix (transpose of adjunct matrix)

Definition at line 117 of file SymmTensor2DI.H.

Referenced by Foam::cof().

Here is the caller graph for this function:

◆ inv()

Foam::SymmTensor2D< Cmpt > inv ( ) const

inline

Return inverse.

Definition at line 126 of file SymmTensor2DI.H.

References Foam::abort(), 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:

◆ operator=() [2/2]

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

inline

Construct given SphericalTensor2D.

Definition at line 148 of file SymmTensor2DI.H.

References Foam::Zero.

Member Data Documentation

◆ rank

constexpr direction rank = 2

static

Rank of SymmTensor2D is 2.

Definition at line 73 of file SymmTensor2D.H.

◆ I

const Foam::symmTensor2D I

static

Definition at line 78 of file SymmTensor2D.H.

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

src/OpenFOAM/primitives/SymmTensor2D/SymmTensor2D.H
src/OpenFOAM/primitives/SymmTensor2D/symmTensor2D/symmTensor2D.C
src/OpenFOAM/primitives/SymmTensor2D/SymmTensor2DI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class Cmpt> class Foam::SymmTensor2D< Cmpt >

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ SymmTensor2D() [1/7]

◆ SymmTensor2D() [2/7]

◆ SymmTensor2D() [3/7]

◆ SymmTensor2D() [4/7]

◆ SymmTensor2D() [5/7]

◆ SymmTensor2D() [6/7]

◆ SymmTensor2D() [7/7]

Member Function Documentation

◆ operator=() [1/2]

◆ xx() [1/2]

◆ xy() [1/2]

◆ yx() [1/2]

◆ yy() [1/2]

◆ xx() [2/2]

◆ xy() [2/2]

◆ yx() [2/2]

◆ yy() [2/2]

◆ diag() [1/2]

◆ diag() [2/2]

◆ diagSqr()

◆ T()

◆ det()

◆ adjunct()

◆ cof()

◆ inv()

◆ operator=() [2/2]

Member Data Documentation

◆ rank

◆ I

template<class Cmpt>
class Foam::SymmTensor2D< Cmpt >