SphericalTensor< Cmpt > Class Template Reference

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

Inheritance diagram for SphericalTensor< Cmpt >:

Collaboration diagram for SphericalTensor< Cmpt >:

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

Public Member Functions
	SphericalTensor ()=default
	SphericalTensor (const SphericalTensor &)=default
SphericalTensor &	operator= (const SphericalTensor &)=default
	SphericalTensor (const Foam::zero)
template<class Cmpt2 >
	SphericalTensor (const VectorSpace< SphericalTensor< Cmpt2 >, Cmpt2, 1 > &)
	SphericalTensor (const Cmpt &tii)
	SphericalTensor (Istream &is)
const Cmpt &	ii () const
Cmpt &	ii ()
const SphericalTensor< Cmpt > &	T () const
Public Member Functions inherited from VectorSpace< SphericalTensor< 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 SphericalTensor	I
static const SphericalTensor	oneThirdI
static const SphericalTensor	twoThirdsI
Static Public Attributes inherited from VectorSpace< SphericalTensor< 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< SphericalTensor< Cmpt >, Cmpt, 1 >
static constexpr direction	size () noexcept
static Form	uniform (const Cmpt &s)
Public Attributes inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
const typedef Cmpt *	const_iterator
Cmpt	v_ [Ncmpts]

Detailed Description

template<class Cmpt>
class Foam::SphericalTensor< Cmpt >

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

See also

Test-SphericalTensor.C

Source files

• SphericalTensor.H
• SphericalTensorI.H

Definition at line 53 of file SphericalTensor.H.

Member Typedef Documentation

labelType

typedef SphericalTensor<label> labelType

Definition at line 62 of file SphericalTensor.H.

Member Enumeration Documentation

components

enum components

Enumerator
II

Definition at line 79 of file SphericalTensor.H.

Constructor & Destructor Documentation

SphericalTensor() [1/6]

SphericalTensor ( )

default

SphericalTensor() [2/6]

SphericalTensor ( const SphericalTensor< Cmpt > &  )

default

SphericalTensor() [3/6]

SphericalTensor ( const Foam::zero  )

inline

Definition at line 27 of file SphericalTensorI.H.

SphericalTensor() [4/6]

SphericalTensor ( const VectorSpace< SphericalTensor< Cmpt2 >, Cmpt2, 1 > &  vs )

inline

Definition at line 36 of file SphericalTensorI.H.

SphericalTensor() [5/6]

SphericalTensor ( const Cmpt &  tii )

inlineexplicit

Definition at line 45 of file SphericalTensorI.H.

SphericalTensor() [6/6]

SphericalTensor ( Istream &  is )

inlineexplicit

Definition at line 52 of file SphericalTensorI.H.

Member Function Documentation

operator=()

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

default

ii() [1/2]

Cmpt & ii

inline

Definition at line 61 of file SphericalTensorI.H.

Referenced by Foam::cmptAv(), Foam::cmptMax(), Foam::cmptMin(), Foam::cmptSum(), Foam::det(), Foam::inv(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), SymmTensor< scalar >::operator=(), Tensor< scalar >::operator=(), SymmTensor< scalar >::SymmTensor(), Tensor< scalar >::Tensor(), and Foam::tr().

Here is the caller graph for this function:

ii() [2/2]

Cmpt& ii ( )

inline

T()

const Foam::SphericalTensor< Cmpt > & T

inline

Definition at line 76 of file SphericalTensorI.H.

Member Data Documentation

rank

constexpr direction rank = 2

staticconstexpr

Definition at line 68 of file SphericalTensor.H.

I

const Foam::labelSphericalTensor I

static

Definition at line 73 of file SphericalTensor.H.

oneThirdI

const SphericalTensor oneThirdI

static

Definition at line 74 of file SphericalTensor.H.

twoThirdsI

const SphericalTensor twoThirdsI

static

Definition at line 75 of file SphericalTensor.H.

---

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

• src/OpenFOAM/primitives/SphericalTensor/SphericalTensor.H
• src/OpenFOAM/primitives/SphericalTensor/labelSphericalTensor/labelSphericalTensor.C
• src/OpenFOAM/primitives/SphericalTensor/SphericalTensorI.H