SphericalTensor2D< Cmpt > Class Template Reference

A templated (2 x 2) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace. More...

Inheritance diagram for SphericalTensor2D< Cmpt >:

Collaboration diagram for SphericalTensor2D< Cmpt >:

Public Types
enum	components { II }
typedef SphericalTensor2D< label >	labelType
Public Types inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
typedef VectorSpace< Form, Cmpt, Ncmpts >	vsType
typedef Cmpt	cmptType
typedef Cmpt	magType
typedef Cmpt *	iterator

Public Member Functions
	SphericalTensor2D ()=default
	SphericalTensor2D (const SphericalTensor2D &)=default
SphericalTensor2D &	operator= (const SphericalTensor2D &)=default
	SphericalTensor2D (const Foam::zero)
	SphericalTensor2D (const VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 > &)
	SphericalTensor2D (const Cmpt &tii)
	SphericalTensor2D (Istream &is)
const Cmpt &	ii () const
Cmpt &	ii ()
Public Member Functions inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
	VectorSpace ()=default
	VectorSpace (const Foam::zero)
	VectorSpace (const VectorSpace< Form, Cmpt, Ncmpts > &vs)
	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	VectorSpace (Istream &is)
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
Cmpt *	data () noexcept
const ConstBlock< SubVector, BStart >	block () const
const Foam::VectorSpace< Form, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
const Cmpt &	operator[] (const direction) const
Cmpt &	operator[] (const direction)
void	operator= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator= (const Foam::zero)
void	operator+= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator-= (const VectorSpace< Form, Cmpt, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)
iterator	begin () noexcept
const_iterator	begin () const noexcept
iterator	end () noexcept
const_iterator	end () const noexcept
const_iterator	cbegin () const noexcept
const_iterator	cend () const noexcept

Static Public Attributes
static constexpr direction	rank = 2
static const SphericalTensor2D	I
static const SphericalTensor2D	oneThirdI
static const SphericalTensor2D	twoThirdsI
Static Public Attributes inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
static constexpr direction	dim
static constexpr direction	nComponents
static constexpr direction	mRows
static constexpr direction	nCols
static const char *const	typeName
static const char *const	componentNames []
static const Form	zero
static const Form	one
static const Form	max
static const Form	min
static const Form	rootMax
static const Form	rootMin

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
static constexpr direction	size () noexcept
static Form	uniform (const Cmpt &s)
Public Attributes inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
const typedef Cmpt *	const_iterator
Cmpt	v_ [Ncmpts]

Detailed Description

template<class Cmpt>
class Foam::SphericalTensor2D< Cmpt >

A templated (2 x 2) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace.

See also

Test-SphericalTensor2D.C

Source files

• SphericalTensor2D.H
• SphericalTensor2DI.H

Definition at line 53 of file SphericalTensor2D.H.

Member Typedef Documentation

labelType

typedef SphericalTensor2D<label> labelType

Definition at line 62 of file SphericalTensor2D.H.

Member Enumeration Documentation

components

enum components

Enumerator
II

Definition at line 79 of file SphericalTensor2D.H.

Constructor & Destructor Documentation

SphericalTensor2D() [1/6]

SphericalTensor2D ( )

default

SphericalTensor2D() [2/6]

SphericalTensor2D ( const SphericalTensor2D< Cmpt > &  )

default

SphericalTensor2D() [3/6]

SphericalTensor2D ( const Foam::zero  )

inline

Definition at line 27 of file SphericalTensor2DI.H.

SphericalTensor2D() [4/6]

SphericalTensor2D ( const VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 > &  vs )

inline

Definition at line 35 of file SphericalTensor2DI.H.

SphericalTensor2D() [5/6]

SphericalTensor2D ( const Cmpt &  tii )

inlineexplicit

Definition at line 44 of file SphericalTensor2DI.H.

SphericalTensor2D() [6/6]

SphericalTensor2D ( Istream &  is )

inlineexplicit

Definition at line 51 of file SphericalTensor2DI.H.

Member Function Documentation

operator=()

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

default

ii() [1/2]

Cmpt & ii

inline

Definition at line 60 of file SphericalTensor2DI.H.

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

Here is the caller graph for this function:

ii() [2/2]

Cmpt& ii ( )

inline

Member Data Documentation

rank

constexpr direction rank = 2

staticconstexpr

Definition at line 68 of file SphericalTensor2D.H.

I

const Foam::sphericalTensor2D I

static

Definition at line 73 of file SphericalTensor2D.H.

oneThirdI

const Foam::sphericalTensor2D oneThirdI

static

Definition at line 74 of file SphericalTensor2D.H.

twoThirdsI

const Foam::sphericalTensor2D twoThirdsI

static

Definition at line 75 of file SphericalTensor2D.H.

---

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

• src/OpenFOAM/primitives/SphericalTensor2D/SphericalTensor2D.H
• src/OpenFOAM/primitives/SphericalTensor2D/sphericalTensor2D/sphericalTensor2D.C
• src/OpenFOAM/primitives/SphericalTensor2D/SphericalTensor2DI.H