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

#include <OpenFOAM/Tensor_.H>

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

src/OpenFOAM/primitives/Tensor/Tensor_.H
src/OpenFOAM/primitives/Tensor/TensorI.H

Definition at line 57 of file Tensor_.H.

Inheritance diagram for Tensor< Cmpt >:

Collaboration diagram for Tensor< Cmpt >:

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 Vector< Cmpt > &x, const Vector< Cmpt > &y, const Vector< Cmpt > &z)
	Construct given the three vectors.
	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 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 ()
const Vector< Cmpt >	x () const
const Vector< Cmpt >	y () const
const Vector< Cmpt >	z () const
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 = "labelTensor"
static const char *	componentNames []
static const Tensor	zero
static const Tensor	one
static const Tensor	max
static const Tensor	min

Member Typedef Documentation

typedef Tensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 65 of file Tensor_.H.

Member Enumeration Documentation

anonymous enum

Enumerator:

rank

Definition at line 70 of file Tensor_.H.

enum components

Component labeling enumeration.

Enumerator:

XX
XY
XZ
YX
YY
YZ
ZX
ZY
ZZ

Definition at line 88 of file Tensor_.H.

Constructor & Destructor Documentation

Tensor ( ) [inline]

Construct null.

Definition at line 37 of file TensorI_.H.

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

Construct given VectorSpace.

Definition at line 43 of file TensorI_.H.

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

Construct given SphericalTensor.

Definition at line 51 of file TensorI_.H.

References SphericalTensor< Cmpt >::ii().

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

Construct given SymmTensor.

Definition at line 61 of file TensorI_.H.

References SymmTensor< Cmpt >::xx(), SymmTensor< Cmpt >::xy(), SymmTensor< Cmpt >::xz(), SymmTensor< Cmpt >::yy(), SymmTensor< Cmpt >::yz(), and SymmTensor< Cmpt >::zz().

Tensor	(	const Vector< Cmpt > &	x,
		const Vector< Cmpt > &	y,
		const Vector< Cmpt > &	z
	)		`[inline]`

Construct given the three vectors.

Construct given the three vector components.

Definition at line 72 of file TensorI_.H.

References Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

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]`

Construct given the nine components.

Construct from components.

Definition at line 87 of file TensorI_.H.

Tensor ( Istream & is ) [inline]

Construct from Istream.

Definition at line 101 of file TensorI_.H.

Member Function Documentation

const Cmpt & xx ( ) const [inline]

Definition at line 129 of file TensorI_.H.

Referenced by Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::symm(), Foam::tr(), Foam::transform(), and Foam::twoSymm().

const Cmpt & xy ( ) const [inline]

Definition at line 135 of file TensorI_.H.

Referenced by Foam::cof(), LRR::correct(), LaunderGibsonRSTM::correct(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & xz ( ) const [inline]

Definition at line 141 of file TensorI_.H.

Referenced by Foam::cof(), LRR::correct(), LaunderGibsonRSTM::correct(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & yx ( ) const [inline]

Definition at line 148 of file TensorI_.H.

Referenced by Foam::cof(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & yy ( ) const [inline]

Definition at line 154 of file TensorI_.H.

Referenced by Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::symm(), Foam::tr(), Foam::transform(), and Foam::twoSymm().

const Cmpt & yz ( ) const [inline]

Definition at line 160 of file TensorI_.H.

Referenced by Foam::cof(), LRR::correct(), LaunderGibsonRSTM::correct(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator*(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & zx ( ) const [inline]

Definition at line 167 of file TensorI_.H.

Referenced by Foam::cof(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & zy ( ) const [inline]

Definition at line 173 of file TensorI_.H.

Referenced by Foam::cof(), Foam::det(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::skew(), Foam::symm(), Foam::transform(), and Foam::twoSymm().

const Cmpt & zz ( ) const [inline]

Definition at line 179 of file TensorI_.H.

Referenced by Foam::cof(), molecule::constantProperties::constantProperties(), Foam::det(), Foam::diag(), Foam::eigenValues(), Foam::eigenVector(), Foam::inv(), Foam::invariantII(), Foam::operator&(), Foam::operator&&(), Foam::operator+(), Foam::operator-(), Foam::symm(), Foam::tr(), Foam::transform(), and Foam::twoSymm().

Cmpt & xx ( ) [inline]

Definition at line 186 of file TensorI_.H.

Cmpt & xy ( ) [inline]

Definition at line 192 of file TensorI_.H.

Cmpt & xz ( ) [inline]

Definition at line 198 of file TensorI_.H.

Cmpt & yx ( ) [inline]

Definition at line 205 of file TensorI_.H.

Cmpt & yy ( ) [inline]

Definition at line 211 of file TensorI_.H.

Cmpt & yz ( ) [inline]

Definition at line 217 of file TensorI_.H.

Cmpt & zx ( ) [inline]

Definition at line 224 of file TensorI_.H.

Cmpt & zy ( ) [inline]

Definition at line 230 of file TensorI_.H.

Cmpt & zz ( ) [inline]

Definition at line 236 of file TensorI_.H.

const Vector< Cmpt > x ( ) const [inline]

Definition at line 110 of file TensorI_.H.

Referenced by molecule::constantProperties::constantProperties(), coordinateSystem::direction(), and coordinateSystem::e1().

const Vector< Cmpt > y ( ) const [inline]

Definition at line 116 of file TensorI_.H.

Referenced by molecule::constantProperties::constantProperties(), and coordinateSystem::e2().

const Vector< Cmpt > z ( ) const [inline]

Definition at line 122 of file TensorI_.H.

Referenced by coordinateSystem::axis(), molecule::constantProperties::constantProperties(), and coordinateSystem::e3().

Tensor< Cmpt > T ( ) const [inline]

Transpose.

Return tensor transpose.

Definition at line 244 of file TensorI_.H.

References xx.

Referenced by fixedAxis::constrain(), coordinateRotation::e1(), coordinateRotation::e2(), coordinateRotation::e3(), porousZone::porousZone(), sixDoFRigidBodyMotion::predictedOrientation(), sixDoFRigidBodyMotion::predictedPosition(), and sixDoFRigidBodyMotion::updateForce().

void operator= ( const SphericalTensor< Cmpt > & st ) [inline]

Assign to a SphericalTensor.

Definition at line 258 of file TensorI_.H.

References SphericalTensor< Cmpt >::ii().

void operator= ( const SymmTensor< Cmpt > & st ) [inline]

Assign to a SymmTensor.

Definition at line 267 of file TensorI_.H.

References SymmTensor< Cmpt >::xx(), SymmTensor< Cmpt >::xy(), SymmTensor< Cmpt >::xz(), SymmTensor< Cmpt >::yy(), SymmTensor< Cmpt >::yz(), and SymmTensor< Cmpt >::zz().

Member Data Documentation

const char *const typeName = "labelTensor" [static]

Definition at line 78 of file Tensor_.H.

const char * componentNames [static]

Initial value:

{
    "xx", "xy", "xz",
    "yx", "yy", "yz",
    "zx", "zy", "zz"
}

Definition at line 79 of file Tensor_.H.

const Foam::labelTensor zero [static]

Definition at line 81 of file Tensor_.H.

const Foam::labelTensor one [static]

Definition at line 82 of file Tensor_.H.

const Tensor max [static]

Definition at line 83 of file Tensor_.H.

const Tensor min [static]

Definition at line 84 of file Tensor_.H.

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

src/OpenFOAM/primitives/Tensor/Tensor_.H
src/OpenFOAM/primitives/Tensor/labelTensor/labelTensor.C
src/OpenFOAM/primitives/Tensor/TensorI_.H

Tensor< Cmpt > Class Template Reference

Detailed Description

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

Public Types

Public Member Functions

Static Public Attributes

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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