SphericalTensor< Cmpt > Class Template Reference

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

#include <OpenFOAM/SphericalTensor_.H>

---

Detailed Description

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

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

Source files

• src/OpenFOAM/primitives/SphericalTensor/SphericalTensor_.H
• src/OpenFOAM/primitives/SphericalTensor/SphericalTensorI.H

Definition at line 52 of file SphericalTensor_.H.

Inheritance diagram for SphericalTensor< Cmpt >:

Collaboration diagram for SphericalTensor< Cmpt >:

List of all members.

Public Types
enum	{ rank = 2 }
enum	components { II }
	Component labeling enumeration. More...
typedef SphericalTensor< label >	labelType
	Equivalent type of labels used for valid component indexing.
Public Types inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
enum
typedef Cmpt	cmptType
	Component type.

Public Member Functions
	SphericalTensor ()
	Construct null.
	SphericalTensor (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 > &)
	Construct given VectorSpace.
	SphericalTensor (const Cmpt &tii)
	Construct given the component.
	SphericalTensor (Istream &)
	Construct from Istream.
const Cmpt &	ii () const
Cmpt &	ii ()
const SphericalTensor< Cmpt > &	T () const
	Transpose.
Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
	VectorSpace ()
	Construct null.
	VectorSpace (Istream &)
	Construct from Istream.
	VectorSpace (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, nCmpt > &)
	Construct as copy.
label	size () const
	Return the number of elements in the VectorSpace = nCmpt.
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< SphericalTensor< Cmpt >, Cmpt, nCmpt > &)
void	operator+= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, nCmpt > &)
void	operator-= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, nCmpt > &)
void	operator*= (const scalar)
void	operator/= (const scalar)

Static Public Attributes
static const char *const	typeName = "labelSphericalTensor"
static const char *	componentNames [] = {"ii"}
static const SphericalTensor	zero
static const SphericalTensor	one
static const SphericalTensor	max
static const SphericalTensor	min
static const SphericalTensor	I
static const SphericalTensor	oneThirdI
static const SphericalTensor	twoThirdsI

Additional Inherited Members
Public Attributes inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
Cmpt	v_ [nCmpt]
	The components of this vector space.

---

Member Typedef Documentation

typedef SphericalTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 60 of file SphericalTensor_.H.

---

Member Enumeration Documentation

anonymous enum

Enumerator:

rank

Definition at line 65 of file SphericalTensor_.H.

enum components

Component labeling enumeration.

Enumerator:

II

Definition at line 85 of file SphericalTensor_.H.

---

Constructor & Destructor Documentation

SphericalTensor ( )

inline

Construct null.

Definition at line 37 of file SphericalTensorI_.H.

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

inline

Construct given VectorSpace.

Definition at line 44 of file SphericalTensorI_.H.

SphericalTensor ( const Cmpt &  tii )

inline

Construct given the component.

Definition at line 54 of file SphericalTensorI_.H.

SphericalTensor ( Istream &  is )

inline

Construct from Istream.

Definition at line 62 of file SphericalTensorI_.H.

---

Member Function Documentation

const Cmpt & ii ( ) const

inline

Definition at line 71 of file SphericalTensorI_.H.

Referenced by Foam::det(), Foam::inv(), Foam::magSqr(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::operator/(), SymmTensor< Cmpt >::operator=(), Tensor< Cmpt >::operator=(), Random::sphericalTensor01(), SymmTensor< Cmpt >::SymmTensor(), Tensor< Cmpt >::Tensor(), and Foam::tr().

Cmpt & ii ( )

inline

Definition at line 78 of file SphericalTensorI_.H.

const SphericalTensor< Cmpt > & T ( ) const

inline

Transpose.

Definition at line 85 of file SphericalTensorI_.H.

---

Member Data Documentation

const char *const typeName = "labelSphericalTensor"

static

Definition at line 73 of file SphericalTensor_.H.

const char * componentNames = {"ii"}

static

Definition at line 74 of file SphericalTensor_.H.

const sphericalTensor zero

static

Definition at line 75 of file SphericalTensor_.H.

const sphericalTensor one

static

Definition at line 76 of file SphericalTensor_.H.

const sphericalTensor max

static

Definition at line 77 of file SphericalTensor_.H.

const sphericalTensor min

static

Definition at line 78 of file SphericalTensor_.H.

const sphericalTensor I

static

Definition at line 79 of file SphericalTensor_.H.

Referenced by coordinateRotation::operator=().

const sphericalTensor oneThirdI

static

Definition at line 80 of file SphericalTensor_.H.

const sphericalTensor twoThirdsI

static

Definition at line 81 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/sphericalTensor/sphericalTensor.C
• src/OpenFOAM/primitives/SphericalTensor/SphericalTensorI_.H