Templated 3D transposed compact spatial tensor derived from MatrixSpace used to represent transformations of spatial vectors of rigid bodies. More...

Inheritance diagram for CompactSpatialTensorT< Cmpt >:

[legend]

Collaboration diagram for CompactSpatialTensorT< Cmpt >:

[legend]

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

	CompactSpatialTensorT (const Foam::zero)

	CompactSpatialTensorT (const typename CompactSpatialTensorT::msType &)
	Construct given MatrixSpace of the same rank. More...

	CompactSpatialTensorT (const Cmpt &t00, const Cmpt &t01, const Cmpt &t02, const Cmpt &t10, const Cmpt &t11, const Cmpt &t12, const Cmpt &t20, const Cmpt &t21, const Cmpt &t22, const Cmpt &t30, const Cmpt &t31, const Cmpt &t32, const Cmpt &t40, const Cmpt &t41, const Cmpt &t42, const Cmpt &t50, const Cmpt &t51, const Cmpt &t52)
	Construct given 18 components. More...

	CompactSpatialTensorT (Istream &)
	Construct from Istream. More...

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

	MatrixSpace (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< CompactSpatialTensorT< 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, CompactSpatialTensorT< 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< CompactSpatialTensorT< Cmpt >, Cmpt, Mrows, Ncols >::template ConstBlock< SubTensor, BRowStart, BColStart >	block () const

Foam::MatrixSpace< CompactSpatialTensorT< 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= (Foam::zero)
	Assignment to zero. More...

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

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

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

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

	VectorSpace (const VectorSpace< CompactSpatialTensorT< 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...

void	fill (const Cmpt &s)
	Assign all components to given value. More...

const ConstBlock< SubVector, BStart >	block () const

const Foam::VectorSpace< CompactSpatialTensorT< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

void	operator= (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
	Copy assign from a VectorSpace with the same size. More...

void	operator= (Foam::zero)

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

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

void	operator*= (const scalar)

void	operator/= (const scalar)

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

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

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

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

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

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

Additional Inherited Members
Public Types inherited from MatrixSpace< CompactSpatialTensorT< Cmpt >, Cmpt, 3, 6 >
typedef MatrixSpace< CompactSpatialTensorT< Cmpt >, Cmpt, Mrows, Ncols >	msType
	MatrixSpace type. More...

Public Types inherited from VectorSpace< CompactSpatialTensorT< Cmpt >, Cmpt, Mrows *Ncols >
typedef VectorSpace< CompactSpatialTensorT< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type. More...

typedef Cmpt	cmptType
	Component type. More...

typedef Cmpt	magType
	Magnitude type. More...

typedef direction	size_type
	The type to represent the size of a VectorSpace. More...

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

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

Static Public Member Functions inherited from MatrixSpace< CompactSpatialTensorT< Cmpt >, Cmpt, 3, 6 >
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< CompactSpatialTensorT< Cmpt >, Cmpt, Mrows *Ncols >
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts. More...

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

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

Static Public Attributes inherited from MatrixSpace< CompactSpatialTensorT< Cmpt >, Cmpt, 3, 6 >
static constexpr direction	mRows

static constexpr direction	nCols

Static Public Attributes inherited from VectorSpace< CompactSpatialTensorT< 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 CompactSpatialTensorT< Cmpt >	zero

static const CompactSpatialTensorT< Cmpt >	one

static const CompactSpatialTensorT< Cmpt >	max

static const CompactSpatialTensorT< Cmpt >	min

static const CompactSpatialTensorT< Cmpt >	rootMax

static const CompactSpatialTensorT< Cmpt >	rootMin

Detailed Description

template<class Cmpt>
class Foam::CompactSpatialTensorT< Cmpt >

Templated 3D transposed compact spatial tensor derived from MatrixSpace used to represent transformations of spatial vectors of rigid bodies.

Reference:

    Featherstone, R. (2008).
    Rigid body dynamics algorithms.
    Springer.

Source files

See also: Foam::MatrixSpace Foam::CompactSpatialTensor

Definition at line 60 of file CompactSpatialTensorT.H.

Constructor & Destructor Documentation

◆ CompactSpatialTensorT() [1/5]

CompactSpatialTensorT ( )

default

Default construct.

◆ CompactSpatialTensorT() [2/5]

CompactSpatialTensorT ( const Foam::zero )

inline

Definition at line 25 of file CompactSpatialTensorTI.H.

◆ CompactSpatialTensorT() [3/5]

CompactSpatialTensorT ( const typename CompactSpatialTensorT< Cmpt >::msType & ms )

inline

Construct given MatrixSpace of the same rank.

Definition at line 35 of file CompactSpatialTensorTI.H.

◆ CompactSpatialTensorT() [4/5]

CompactSpatialTensorT	(	const Cmpt &	t00,
		const Cmpt &	t01,
		const Cmpt &	t02,
		const Cmpt &	t10,
		const Cmpt &	t11,
		const Cmpt &	t12,
		const Cmpt &	t20,
		const Cmpt &	t21,
		const Cmpt &	t22,
		const Cmpt &	t30,
		const Cmpt &	t31,
		const Cmpt &	t32,
		const Cmpt &	t40,
		const Cmpt &	t41,
		const Cmpt &	t42,
		const Cmpt &	t50,
		const Cmpt &	t51,
		const Cmpt &	t52
	)

inline

Construct given 18 components.

Definition at line 45 of file CompactSpatialTensorTI.H.

◆ CompactSpatialTensorT() [5/5]

CompactSpatialTensorT ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 81 of file CompactSpatialTensorTI.H.

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

src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorT.H
src/OpenFOAM/primitives/spatialVectorAlgebra/CompactSpatialTensorT/CompactSpatialTensorTI.H

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Cmpt> class Foam::CompactSpatialTensorT< Cmpt >

Constructor & Destructor Documentation

◆ CompactSpatialTensorT() [1/5]

◆ CompactSpatialTensorT() [2/5]

◆ CompactSpatialTensorT() [3/5]

◆ CompactSpatialTensorT() [4/5]

◆ CompactSpatialTensorT() [5/5]

template<class Cmpt>
class Foam::CompactSpatialTensorT< Cmpt >