Tensor< Cmpt > Class Template Reference

Templated 3D tensor derived from VectorSpace adding construction from 9 components, element access using xx(), xy() etc. member functions and the inner-product (dot-product) and outer-product of two Vectors (tensor-product) operators. More...

Inheritance diagram for Tensor< Cmpt >:

[legend]

Collaboration diagram for Tensor< Cmpt >:

[legend]

List of all members.


Public Types
enum	{ rank = 2 }
enum	components { XX, XY, XZ, YX, YY, YZ, ZX, ZY, ZZ }
	Component labeling enumeration. More...
typedef Tensor< label >	labelType
	Equivalent type of labels used for valid component indexing.
Public Member Functions
	Tensor ()
	Construct null.
	Tensor (const VectorSpace< Tensor< Cmpt >, Cmpt, 9 > &)
	Construct given VectorSpace.
	Tensor (const SphericalTensor< Cmpt > &)
	Construct given SphericalTensor.
	Tensor (const SymmTensor< Cmpt > &)
	Construct given SymmTensor.
	Tensor (const Cmpt txx, const Cmpt txy, const Cmpt txz, const Cmpt tyx, const Cmpt tyy, const Cmpt tyz, const Cmpt tzx, const Cmpt tzy, const Cmpt tzz)
	Construct given the nine components.
	Tensor (Istream &)
	Construct from Istream.
const Vector< Cmpt > &	x () const
const Vector< Cmpt > &	y () const
const Vector< Cmpt > &	z () const
Vector< Cmpt > &	x ()
Vector< Cmpt > &	y ()
Vector< Cmpt > &	z ()
const Cmpt &	xx () const
const Cmpt &	xy () const
const Cmpt &	xz () const
const Cmpt &	yx () const
const Cmpt &	yy () const
const Cmpt &	yz () const
const Cmpt &	zx () const
const Cmpt &	zy () const
const Cmpt &	zz () const
Cmpt &	xx ()
Cmpt &	xy ()
Cmpt &	xz ()
Cmpt &	yx ()
Cmpt &	yy ()
Cmpt &	yz ()
Cmpt &	zx ()
Cmpt &	zy ()
Cmpt &	zz ()
Tensor< Cmpt >	T () const
	Transpose.
void	operator= (const SphericalTensor< Cmpt > &)
	Assign to a SphericalTensor.
void	operator= (const SymmTensor< Cmpt > &)
	Assign to a SymmTensor.
Static Public Attributes
static const char *const	typeName
static const char *	componentNames []
static const Tensor	zero
static const Tensor	one
static const Tensor	max
static const Tensor	min

Detailed Description

template<class Cmpt>
class Foam::Tensor< Cmpt >

Templated 3D tensor derived from VectorSpace adding construction from 9 components, element access using xx(), xy() etc. member functions and the inner-product (dot-product) and outer-product of two Vectors (tensor-product) operators.

Source files

Definition at line 50 of file Tensor.H.

Member Typedef Documentation

typedef Tensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 58 of file Tensor.H.

Member Enumeration Documentation

anonymous enum

Enumerator:

rank

Definition at line 63 of file Tensor.H.

enum components

Component labeling enumeration.

Enumerator:

XX
XY
XZ
YX
YY
YZ
ZX
ZY
ZZ

Definition at line 81 of file Tensor.H.

Constructor & Destructor Documentation

Tensor ( ) [inline]

Construct null.

Definition at line 27 of file TensorI.H.

Tensor ( const VectorSpace< Tensor< Cmpt >, Cmpt, 9 > & vs ) [inline]

Construct given VectorSpace.

Definition at line 33 of file TensorI.H.

Tensor ( const SphericalTensor< Cmpt > & st ) [inline]

Construct given SphericalTensor.

Definition at line 41 of file TensorI.H.

Tensor ( const SymmTensor< Cmpt > & st ) [inline]

Construct given SymmTensor.

Definition at line 51 of file TensorI.H.

References SphericalTensor< Cmpt >::ii(), VectorSpace< Tensor< Cmpt >, Cmpt, 9 >::v_, Tensor< Cmpt >::XX, Tensor< Cmpt >::XY, Tensor< Cmpt >::XZ, Tensor< Cmpt >::YX, Tensor< Cmpt >::YY, Tensor< Cmpt >::YZ, Tensor< Cmpt >::ZX, Tensor< Cmpt >::ZY, and Tensor< Cmpt >::ZZ.

Here is the call graph for this function:

Tensor	(	const Cmpt	txx,
		const Cmpt	txy,
		const Cmpt	txz,
		const Cmpt	tyx,
		const Cmpt	tyy,
		const Cmpt	tyz,
		const Cmpt	tzx,
		const Cmpt	tzy,
		const Cmpt	tzz
	)			`[inline]`