Templated 2D symmetric tensor derived from VectorSpace adding construction from 4 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 SymmTensor2D< Cmpt >:

[legend]

Collaboration diagram for SymmTensor2D< Cmpt >:

[legend]

Public Types
enum	{ rank = 2 }

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

typedef Cmpt	cmptType
	Component type. More...

Public Member Functions
	SymmTensor2D ()
	Construct null. 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 &)
	Construct from Istream. More...

const Cmpt &	xx () const

const Cmpt &	xy () const

const Cmpt &	yy () const

Cmpt &	xx ()

Cmpt &	xy ()

Cmpt &	yy ()

const SymmTensor2D< Cmpt > &	T () const
	Transpose. More...

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

Public Member Functions inherited from VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >
	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 = "symmTensor2D"

static const char *	componentNames []

static const SymmTensor2D	zero

static const SymmTensor2D	one

static const SymmTensor2D	max

static const SymmTensor2D	min

static const SymmTensor2D	I

Additional Inherited Members
Data Fields inherited from VectorSpace< SymmTensor2D< Cmpt >, Cmpt, 3 >
Cmpt	v_ [nCmpt]
	The components of this vector space. More...

Detailed Description

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

Templated 2D symmetric tensor derived from VectorSpace adding construction from 4 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 SymmTensor2D.H.

Member Typedef Documentation

◆ labelType

typedef SymmTensor2D<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 61 of file SymmTensor2D.H.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
rank

Definition at line 66 of file SymmTensor2D.H.

◆ components

enum components

Component labeling enumeration.

Enumerator
XX
XY
YY

Definition at line 85 of file SymmTensor2D.H.

Constructor & Destructor Documentation

◆ SymmTensor2D() [1/5]

SymmTensor2D

inline

Construct null.

Definition at line 37 of file SymmTensor2DI.H.

◆ SymmTensor2D() [2/5]

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

inline

Construct given VectorSpace.

Definition at line 43 of file SymmTensor2DI.H.

◆ SymmTensor2D() [3/5]

SymmTensor2D ( const SphericalTensor2D< Cmpt > & st )

inline

Construct given SphericalTensor.

Definition at line 52 of file SymmTensor2DI.H.

References SphericalTensor2D< Cmpt >::ii().

Here is the call graph for this function:

◆ SymmTensor2D() [4/5]

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

inline

Construct given the three components.

Definition at line 61 of file SymmTensor2DI.H.

◆ SymmTensor2D() [5/5]

SymmTensor2D ( Istream & is )

inline

Construct from Istream.

Definition at line 72 of file SymmTensor2DI.H.

Member Function Documentation

◆ xx() [1/2]

Cmpt & xx

inline

Definition at line 81 of file SymmTensor2DI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), Foam::invariantII(), Foam::magSqr(), 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]

Cmpt & xy

inline

Definition at line 87 of file SymmTensor2DI.H.

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

Here is the caller graph for this function:

◆ yy() [1/2]

Cmpt & yy

inline

Definition at line 93 of file SymmTensor2DI.H.

Referenced by Foam::cof(), Foam::det(), Foam::innerSqr(), Foam::invariantII(), Foam::magSqr(), 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 ( )

inline

◆ xy() [2/2]

Cmpt& xy ( )

inline

◆ yy() [2/2]

Cmpt& yy ( )

inline

◆ T()

const SymmTensor2D< Cmpt > & T

inline

Transpose.

Definition at line 119 of file SymmTensor2DI.H.

◆ operator=()

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

inline

Construct given SphericalTensor2D.

Definition at line 128 of file SymmTensor2DI.H.

References SphericalTensor2D< Cmpt >::ii().

Here is the call graph for this function:

Field Documentation

◆ typeName

const char *const typeName = "symmTensor2D"

static

Definition at line 74 of file SymmTensor2D.H.

◆ componentNames

const char * componentNames

static

Initial value:

=
{
    "xx", "xy",
          "yy"
}

Definition at line 75 of file SymmTensor2D.H.

◆ zero

const symmTensor2D zero

static

Definition at line 77 of file SymmTensor2D.H.

Referenced by calcCurvature().

◆ one

const symmTensor2D one

static

Definition at line 78 of file SymmTensor2D.H.

◆ max

const symmTensor2D max

static

Definition at line 79 of file SymmTensor2D.H.

◆ min

const symmTensor2D min

static

Definition at line 80 of file SymmTensor2D.H.

◆ I

const symmTensor2D I

static

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

◆ anonymous enum

◆ components

Constructor & Destructor Documentation

◆ SymmTensor2D() [1/5]

◆ SymmTensor2D() [2/5]

◆ SymmTensor2D() [3/5]

◆ SymmTensor2D() [4/5]

◆ SymmTensor2D() [5/5]

Member Function Documentation

◆ xx() [1/2]

◆ xy() [1/2]

◆ yy() [1/2]

◆ xx() [2/2]

◆ xy() [2/2]

◆ yy() [2/2]

◆ T()

◆ operator=()

Field Documentation

◆ typeName

◆ componentNames

◆ zero

◆ one

◆ max

◆ min

◆ I

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