Templated 2D sphericalTensor derived from VectorSpace adding construction from 1 component, element access using ii() member function and the inner-product (dot-product) and outer-product operators. More...

Inheritance diagram for SphericalTensor2D< Cmpt >:

[legend]

Collaboration diagram for SphericalTensor2D< Cmpt >:

[legend]

Public Types
enum	components { II }
	Component labeling enumeration. More...

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

Public Member Functions
	SphericalTensor2D ()
	Construct null. More...

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

	SphericalTensor2D (const VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 > &)
	Construct given VectorSpace. More...

	SphericalTensor2D (const Cmpt &tii)
	Construct given the component. More...

	SphericalTensor2D (Istream &)
	Construct from Istream. More...

const Cmpt &	ii () const

Cmpt &	ii ()

Public Member Functions inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
	VectorSpace ()
	Construct null. More...

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

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

	VectorSpace (const VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, Ncmpts > &vs)
	Copy construct. More...

	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Copy construct of a VectorSpace with the same size. 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< SphericalTensor2D< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

void	operator= (const Foam::zero)

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

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

void	operator*= (const scalar)

void	operator/= (const scalar)

iterator	begin ()
	Return an iterator to begin of VectorSpace. More...

const_iterator	begin () const
	Return const_iterator to begin of VectorSpace. More...

iterator	end ()
	Return an iterator to end of VectorSpace. More...

const_iterator	end () const
	Return const_iterator to end of VectorSpace. More...

const_iterator	cbegin () const
	Return const_iterator to begin of VectorSpace. More...

const_iterator	cend () const
	Return const_iterator to end of VectorSpace. More...

Static Public Attributes
static constexpr direction	rank = 2
	Rank of SphericalTensor2D is 2. More...

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
	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 SphericalTensor2D< Cmpt >	zero

static const SphericalTensor2D< Cmpt >	one

static const SphericalTensor2D< Cmpt >	max

static const SphericalTensor2D< Cmpt >	min

static const SphericalTensor2D< Cmpt >	rootMax

static const SphericalTensor2D< Cmpt >	rootMin

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

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

Public Attributes inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
const typedef Cmpt *	const_iterator
	Random access iterator for traversing VectorSpace. More...

Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Detailed Description

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

Templated 2D sphericalTensor derived from VectorSpace adding construction from 1 component, element access using ii() member function and the inner-product (dot-product) and outer-product operators.

Source files

Definition at line 55 of file SphericalTensor2D.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
II

Definition at line 76 of file SphericalTensor2D.H.

Constructor & Destructor Documentation

◆ SphericalTensor2D() [1/5]

SphericalTensor2D ( )

inline

Construct null.

Definition at line 33 of file SphericalTensor2DI.H.

◆ SphericalTensor2D() [2/5]

SphericalTensor2D ( const Foam::zero )

inline

Construct initialized to zero.

Definition at line 38 of file SphericalTensor2DI.H.

◆ SphericalTensor2D() [3/5]

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

inline

Construct given VectorSpace.

Definition at line 46 of file SphericalTensor2DI.H.

◆ SphericalTensor2D() [4/5]

SphericalTensor2D ( const Cmpt & tii )

inline

Construct given the component.

Definition at line 55 of file SphericalTensor2DI.H.

◆ SphericalTensor2D() [5/5]

SphericalTensor2D ( Istream & is )

inline

Construct from Istream.

Definition at line 62 of file SphericalTensor2DI.H.

Member Function Documentation

◆ ii() [1/2]

const Cmpt & ii ( ) const

inline

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

Definition at line 78 of file SphericalTensor2DI.H.

Member Data Documentation

◆ rank

constexpr direction rank = 2

staticconstexpr

Rank of SphericalTensor2D is 2.

Definition at line 65 of file SphericalTensor2D.H.

◆ I

const Foam::sphericalTensor2D I

static

Definition at line 70 of file SphericalTensor2D.H.

◆ oneThirdI

const Foam::sphericalTensor2D oneThirdI

static

Definition at line 71 of file SphericalTensor2D.H.

◆ twoThirdsI

const Foam::sphericalTensor2D twoThirdsI

static

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ SphericalTensor2D() [1/5]

◆ SphericalTensor2D() [2/5]

◆ SphericalTensor2D() [3/5]

◆ SphericalTensor2D() [4/5]

◆ SphericalTensor2D() [5/5]

Member Function Documentation

◆ ii() [1/2]

◆ ii() [2/2]

Member Data Documentation

◆ rank

◆ I

◆ oneThirdI

◆ twoThirdsI

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