Templated 4x3 tensor derived from VectorSpace. Has 12 components. Can represent a barycentric transformation as a matrix-barycentric inner-product. More...

Inheritance diagram for BarycentricTensor< Cmpt >:

[legend]

Collaboration diagram for BarycentricTensor< Cmpt >:

[legend]

Public Types
enum	components { XA, XB, XC, XD, YA, YB, YC, YD, ZA, ZB, ZC, ZD }
	Component labeling enumeration. More...

typedef BarycentricTensor< label >	labelType
	Equivalent type of labels used for valid component indexing (unused) More...

Public Types inherited from MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, 4, 3 >
typedef MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows, Ncols >	msType
	MatrixSpace type. More...

Public Types inherited from VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >
typedef VectorSpace< BarycentricTensor< 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...

typedef const Cmpt *	const_iterator
	Random access iterator for traversing VectorSpace. More...

Public Member Functions
	BarycentricTensor ()=default
	Default construct. More...

	BarycentricTensor (const Foam::zero)
	Construct initialised to zero. More...

	BarycentricTensor (const Barycentric< Cmpt > &x, const Barycentric< Cmpt > &y, const Barycentric< Cmpt > &z)
	Construct given three barycentric components (rows) More...

	BarycentricTensor (const Vector< Cmpt > &a, const Vector< Cmpt > &b, const Vector< Cmpt > &c, const Vector< Cmpt > &d)
	Construct given four vector components (columns) More...

const Cmpt &	xa () const noexcept

const Cmpt &	xb () const noexcept

const Cmpt &	xc () const noexcept

const Cmpt &	xd () const noexcept

const Cmpt &	ya () const noexcept

const Cmpt &	yb () const noexcept

const Cmpt &	yc () const noexcept

const Cmpt &	yd () const noexcept

const Cmpt &	za () const noexcept

const Cmpt &	zb () const noexcept

const Cmpt &	zc () const noexcept

const Cmpt &	zd () const noexcept

Barycentric< Cmpt >	x () const

Barycentric< Cmpt >	y () const

Barycentric< Cmpt >	z () const

Vector< Cmpt >	a () const

Vector< Cmpt >	b () const

Vector< Cmpt >	c () const

Vector< Cmpt >	d () const

Vector< Cmpt >	inner (const Barycentric< Cmpt > &bry) const
	Tensor/barycentric inner product. More...

Public Member Functions inherited from MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, 4, 3 >
	MatrixSpace ()=default
	Default construct. More...

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

	MatrixSpace (const VectorSpace< Form2, Cmpt2, Mrows *Ncols > &)
	Construct as copy of a VectorSpace with the same size. More...

	MatrixSpace (const Block2< BarycentricTensor< Cmpt >, BRowStart, BColStart > &block)
	Construct from a block of another matrix space. More...

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

const Cmpt &	elmt () const noexcept
	Fast const element access using compile-time addressing. More...

Cmpt &	elmt () noexcept
	Fast element access using compile-time addressing. More...

const Cmpt &	xx () const noexcept

Cmpt &	xx () noexcept

const Cmpt &	xy () const noexcept

Cmpt &	xy () noexcept

const Cmpt &	xz () const noexcept

Cmpt &	xz () noexcept

const Cmpt &	yx () const noexcept

Cmpt &	yx () noexcept

const Cmpt &	yy () const noexcept

Cmpt &	yy () noexcept

const Cmpt &	yz () const noexcept

Cmpt &	yz () noexcept

const Cmpt &	zx () const noexcept

Cmpt &	zx () noexcept

const Cmpt &	zy () const noexcept

Cmpt &	zy () noexcept

const Cmpt &	zz () const noexcept

Cmpt &	zz () noexcept

typeOfTranspose< Cmpt, BarycentricTensor< Cmpt > >::type	T () const
	Return the transpose of the matrix. More...

ConstBlock< SubTensor, BRowStart, BColStart >	block () const
	Return a const sub-block corresponding to the specified type. More...

Block< SubTensor, BRowStart, BColStart >	block ()
	Return a sub-block corresponding to the specified type. More...

Foam::MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows, Ncols >::template ConstBlock< SubTensor, BRowStart, BColStart >	block () const

Foam::MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows, Ncols >::template Block< SubTensor, BRowStart, BColStart >	block ()

const Cmpt &	operator() (const direction &i, const direction &j) const
	(i, j) const element access operator More...

Cmpt &	operator() (const direction &i, const direction &j)
	(i, j) element access operator More...

void	operator= (const Foam::zero)
	Assignment to zero. More...

void	operator= (const Block2< BarycentricTensor< Cmpt >, BRowStart, BColStart > &block)
	Assignment to a block of another matrix space. More...

void	operator&= (const MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, Ncols, Ncols > &matrix)
	Inner product with a compatible square matrix. More...

Public Member Functions inherited from VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >
	VectorSpace ()=default
	Default construct. More...

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

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

	VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Copy construct of a VectorSpace with the same size. More...

	VectorSpace (Istream &is)
	Construct from Istream. 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< BarycentricTensor< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

void	operator= (const Foam::zero)

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

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

void	operator*= (const scalar)

void	operator/= (const scalar)

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

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

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

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

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

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

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

Static Public Attributes inherited from MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, 4, 3 >
static constexpr direction	mRows

static constexpr direction	nCols

Static Public Attributes inherited from VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >
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 BarycentricTensor< Cmpt >	zero

static const BarycentricTensor< Cmpt >	one

static const BarycentricTensor< Cmpt >	max

static const BarycentricTensor< Cmpt >	min

static const BarycentricTensor< Cmpt >	rootMax

static const BarycentricTensor< Cmpt >	rootMin

Additional Inherited Members
Static Public Member Functions inherited from MatrixSpace< BarycentricTensor< Cmpt >, Cmpt, 4, 3 >
static direction	m () noexcept
	The number of rows. More...

static direction	n () noexcept
	The number of columns. More...

static msType	identity ()
	An identity matrix for square matrix-spaces. More...

Static Public Member Functions inherited from VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts. More...

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

Public Attributes inherited from VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >
Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Detailed Description

template<class Cmpt>
class Foam::BarycentricTensor< Cmpt >

Templated 4x3 tensor derived from VectorSpace. Has 12 components. Can represent a barycentric transformation as a matrix-barycentric inner-product.

Source files

Definition at line 52 of file BarycentricTensor.H.

Member Typedef Documentation

◆ labelType

typedef BarycentricTensor<label> labelType

Equivalent type of labels used for valid component indexing (unused)

Definition at line 64 of file BarycentricTensor.H.

Member Enumeration Documentation

◆ components

enum components

Component labeling enumeration.

Enumerator
XA
XB
XC
XD
YA
YB
YC
YD
ZA
ZB
ZC
ZD

Definition at line 78 of file BarycentricTensor.H.

Constructor & Destructor Documentation

◆ BarycentricTensor() [1/4]

BarycentricTensor ( )

default

Default construct.

◆ BarycentricTensor() [2/4]

BarycentricTensor ( const Foam::zero )

inline

Construct initialised to zero.

Definition at line 25 of file BarycentricTensorI.H.

◆ BarycentricTensor() [3/4]

BarycentricTensor	(	const Barycentric< Cmpt > &	x,
		const Barycentric< Cmpt > &	y,
		const Barycentric< Cmpt > &	z
	)

inline

Construct given three barycentric components (rows)

Definition at line 33 of file BarycentricTensorI.H.

References Barycentric< Cmpt >::a(), Barycentric< Cmpt >::b(), Barycentric< Cmpt >::c(), Barycentric< Cmpt >::d(), x, and y.

Here is the call graph for this function:

◆ BarycentricTensor() [4/4]

BarycentricTensor	(	const Vector< Cmpt > &	a,
		const Vector< Cmpt > &	b,
		const Vector< Cmpt > &	c,
		const Vector< Cmpt > &	d
	)

inline

Construct given four vector components (columns)

Eg, the corners of a tetrahedron

Definition at line 58 of file BarycentricTensorI.H.

References Foam::constant::physicoChemical::b, Foam::constant::universal::c, Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

Member Function Documentation

◆ xa()

const Cmpt& xa ( ) const

inlinenoexcept

Definition at line 124 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::XA.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ xb()

const Cmpt& xb ( ) const

inlinenoexcept

Definition at line 125 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::XB.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ xc()

const Cmpt& xc ( ) const

inlinenoexcept

Definition at line 126 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::XC.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ xd()

const Cmpt& xd ( ) const

inlinenoexcept

Definition at line 127 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::XD.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ ya()

const Cmpt& ya ( ) const

inlinenoexcept

Definition at line 129 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::YA.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ yb()

const Cmpt& yb ( ) const

inlinenoexcept

Definition at line 130 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::YB.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ yc()

const Cmpt& yc ( ) const

inlinenoexcept

Definition at line 131 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::YC.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ yd()

const Cmpt& yd ( ) const

inlinenoexcept

Definition at line 132 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::YD.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ za()

const Cmpt& za ( ) const

inlinenoexcept

Definition at line 134 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::ZA.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ zb()

const Cmpt& zb ( ) const

inlinenoexcept

Definition at line 135 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::ZB.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ zc()

const Cmpt& zc ( ) const

inlinenoexcept

Definition at line 136 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::ZC.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ zd()

const Cmpt& zd ( ) const

inlinenoexcept

Definition at line 137 of file BarycentricTensor.H.

References VectorSpace< BarycentricTensor< Cmpt >, Cmpt, Mrows *Ncols >::v_, and BarycentricTensor< Cmpt >::ZD.

Referenced by BarycentricTensor< Cmpt >::inner().

Here is the caller graph for this function:

◆ x()

Foam::Barycentric< Cmpt > x ( ) const

inline

Definition at line 85 of file BarycentricTensorI.H.

◆ y()

Foam::Barycentric< Cmpt > y ( ) const

inline

Definition at line 99 of file BarycentricTensorI.H.

◆ z()

Foam::Barycentric< Cmpt > z ( ) const

inline

Definition at line 113 of file BarycentricTensorI.H.

◆ a()

Foam::Vector< Cmpt > a ( ) const

inline

Definition at line 127 of file BarycentricTensorI.H.

◆ b()

Foam::Vector< Cmpt > b ( ) const

inline

Definition at line 134 of file BarycentricTensorI.H.

◆ c()

Foam::Vector< Cmpt > c ( ) const

inline

Definition at line 141 of file BarycentricTensorI.H.

◆ d()

Foam::Vector< Cmpt > d ( ) const

inline

Definition at line 148 of file BarycentricTensorI.H.

◆ inner()

Foam::Vector< Cmpt > inner ( const Barycentric< Cmpt > & bry ) const

inline

Tensor/barycentric inner product.

(transforms barycentric coordinates to vector)

Definition at line 161 of file BarycentricTensorI.H.

Referenced by Foam::operator &().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ rank

constexpr direction rank = 2

static

Rank of BarycentricTensor is 2.

Definition at line 72 of file BarycentricTensor.H.

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

src/OpenFOAM/primitives/Barycentric/BarycentricTensor.H
src/OpenFOAM/primitives/Barycentric/BarycentricTensorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class Cmpt> class Foam::BarycentricTensor< Cmpt >

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ BarycentricTensor() [1/4]

◆ BarycentricTensor() [2/4]

◆ BarycentricTensor() [3/4]

◆ BarycentricTensor() [4/4]

Member Function Documentation

◆ xa()

◆ xb()

◆ xc()

◆ xd()

◆ ya()

◆ yb()

◆ yc()

◆ yd()

◆ za()

◆ zb()

◆ zc()

◆ zd()

◆ x()

◆ y()

◆ z()

◆ a()

◆ b()

◆ c()

◆ d()

◆ inner()

Member Data Documentation

◆ rank

template<class Cmpt>
class Foam::BarycentricTensor< Cmpt >