SphericalTensor2D< Cmpt > Class Template Reference

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

Collaboration diagram for SphericalTensor2D< Cmpt >:

Public Types
enum	{ rank = 2 }
enum	components { II }
	Component labeling enumeration. More...
Public Types inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
enum
typedef Cmpt	cmptType
	Component type. More...

Public Member Functions
	SphericalTensor2D ()
	Construct null. 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 (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 = "sphericalTensor2D"
static const char *	componentNames [] = {"ii"}
static const SphericalTensor2D	zero
static const SphericalTensor2D	one
static const SphericalTensor2D	max
static const SphericalTensor2D	min
static const SphericalTensor2D	I
static const SphericalTensor2D	oneThirdI
static const SphericalTensor2D	twoThirdsI

Additional Inherited Members
Data Fields inherited from VectorSpace< SphericalTensor2D< Cmpt >, Cmpt, 1 >
Cmpt	v_ [nCmpt]
	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

• SphericalTensor2D.H
• SphericalTensor2DI.H

Definition at line 51 of file SphericalTensor2D.H.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
rank

Definition at line 60 of file SphericalTensor2D.H.

components

enum components

Component labeling enumeration.

Enumerator
II

Definition at line 80 of file SphericalTensor2D.H.

Constructor & Destructor Documentation

SphericalTensor2D() [1/4]

SphericalTensor2D

inline

Construct null.

Definition at line 37 of file SphericalTensor2DI.H.

SphericalTensor2D() [2/4]

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

inline

Construct given VectorSpace.

Definition at line 44 of file SphericalTensor2DI.H.

SphericalTensor2D() [3/4]

SphericalTensor2D ( const Cmpt &  tii )

inline

Construct given the component.

Definition at line 54 of file SphericalTensor2DI.H.

SphericalTensor2D() [4/4]

SphericalTensor2D ( Istream &  is )

inline

Construct from Istream.

Definition at line 62 of file SphericalTensor2DI.H.

Member Function Documentation

ii() [1/2]

Cmpt & ii

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/(), SymmTensor2D< Cmpt >::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

Field Documentation

typeName

const char *const typeName = "sphericalTensor2D"

static

Definition at line 68 of file SphericalTensor2D.H.

componentNames

const char * componentNames = {"ii"}

static

Definition at line 69 of file SphericalTensor2D.H.

zero

const sphericalTensor2D zero

static

Definition at line 70 of file SphericalTensor2D.H.

one

const sphericalTensor2D one

static

Definition at line 71 of file SphericalTensor2D.H.

max

const sphericalTensor2D max

static

Definition at line 72 of file SphericalTensor2D.H.

min

const sphericalTensor2D min

static

Definition at line 73 of file SphericalTensor2D.H.

I

const sphericalTensor2D I

static

Definition at line 74 of file SphericalTensor2D.H.

oneThirdI

const sphericalTensor2D oneThirdI

static

Definition at line 75 of file SphericalTensor2D.H.

twoThirdsI

const sphericalTensor2D twoThirdsI

static

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