A templated (3 x 3) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace. More...

#include <SphericalTensor.H>

Inheritance diagram for SphericalTensor< Cmpt >:

[legend]

Collaboration diagram for SphericalTensor< Cmpt >:

[legend]

Public Types
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 >
typedef VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts >	vsType
	VectorSpace type.
typedef Cmpt	cmptType
	Component type.
typedef Cmpt	magType
	Magnitude type.
typedef direction	size_type
	The type to represent the size of a VectorSpace.
typedef Cmpt *	iterator
	Random access iterator for traversing VectorSpace.
typedef const Cmpt *	const_iterator
	Random access iterator for traversing VectorSpace.

Public Member Functions
	SphericalTensor ()=default
	Default construct.
	SphericalTensor (const SphericalTensor &)=default
	Copy construct.
SphericalTensor &	operator= (const SphericalTensor &)=default
	Copy assignment.
	SphericalTensor (Foam::zero)
	Construct initialized to zero.
template<class Cmpt2>
	SphericalTensor (const VectorSpace< SphericalTensor< Cmpt2 >, Cmpt2, 1 > &)
	Construct given VectorSpace.
	SphericalTensor (const Cmpt &tii)
	Construct given the component.
	SphericalTensor (Istream &is)
	Construct from Istream.
const Cmpt &	ii () const noexcept
Cmpt &	ii () noexcept
scalar	diagSqr () const
	The L2-norm squared of the diagonal.
const SphericalTensor< Cmpt > &	T () const noexcept
	Return non-Hermitian transpose (no-op).
Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
const Foam::VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart >	block () const
	VectorSpace ()=default
	Default construct.
const Cmpt &	component (const direction) const
void	replace (const direction, const Cmpt &)
const Cmpt *	cdata () const noexcept
	Return const pointer to the first data element.
Cmpt *	data () noexcept
	Return pointer to the first data element.
void	fill (const Cmpt &s)
	Assign all components to given value.
const Cmpt &	operator[] (const direction) const
void	operator= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts > &)
void	operator+= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts > &)
void	operator-= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts > &)
void	operator*= (const scalar)
void	operator/= (const scalar)
iterator	begin () noexcept
	Return an iterator (pointer) to begin of VectorSpace.
const_iterator	cbegin () const noexcept
	Return const_iterator (const pointer) to begin of VectorSpace.
iterator	end () noexcept
	Return an iterator (pointer) to end of VectorSpace.
const_iterator	cend () const noexcept
	Return const_iterator (const pointer) to end of VectorSpace.

Static Public Attributes
static constexpr direction	rank = 2
	Rank of SphericalTensor is 2.
static const SphericalTensor	I
static const SphericalTensor	oneThirdI
static const SphericalTensor	twoThirdsI
Static Public Attributes inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
static constexpr direction	dim
	Dimensionality of space.
static constexpr direction	nComponents
	Number of components in this vector space.
static constexpr direction	mRows
static constexpr direction	nCols
static const char *const	typeName
static const char *const	componentNames []
static const SphericalTensor< Cmpt >	zero
static const SphericalTensor< Cmpt >	one
static const SphericalTensor< Cmpt >	max
static const SphericalTensor< Cmpt >	min
static const SphericalTensor< Cmpt >	rootMax
static const SphericalTensor< Cmpt >	rootMin

Additional Inherited Members
Static Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts.
static SphericalTensor< Cmpt >	uniform (const Cmpt &s)
	Return a VectorSpace with all elements = s.
Public Attributes inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
Cmpt	v_ [Ncmpts]
	The components of this vector space.

Detailed Description

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

A templated (3 x 3) diagonal tensor of objects of <T>, effectively containing 1 element, derived from VectorSpace.

See also: Test-SphericalTensor.C

Source files

Definition at line 53 of file SphericalTensor.H.

Member Typedef Documentation

◆ labelType

template<class Cmpt>

typedef SphericalTensor<label> labelType

Equivalent type of labels used for valid component indexing.

Definition at line 64 of file SphericalTensor.H.

Member Enumeration Documentation

◆ components

template<class Cmpt>

enum components

Component labeling enumeration.

Enumerator
II

Definition at line 85 of file SphericalTensor.H.

Constructor & Destructor Documentation

◆ SphericalTensor() [1/6]

template<class Cmpt>

SphericalTensor ( )

default

Default construct.

Referenced by Identity< Cmpt >::Identity(), SphericalTensor(), SphericalTensor(), and SphericalTensor().

Here is the caller graph for this function:

◆ SphericalTensor() [2/6]

template<class Cmpt>

SphericalTensor ( const SphericalTensor< Cmpt > & )

default

Copy construct.

◆ SphericalTensor() [3/6]

template<class Cmpt>

SphericalTensor ( Foam::zero )

inline

Construct initialized to zero.

Definition at line 27 of file SphericalTensorI.H.

References SphericalTensor(), and VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >::zero.

Here is the call graph for this function:

◆ SphericalTensor() [4/6]

template<class Cmpt>

template<class Cmpt2>

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

inline

Construct given VectorSpace.

Definition at line 35 of file SphericalTensorI.H.

References SphericalTensor(), and VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >::VectorSpace().

Here is the call graph for this function:

◆ SphericalTensor() [5/6]

template<class Cmpt>

SphericalTensor ( const Cmpt & tii )

inlineexplicit

Construct given the component.

Definition at line 45 of file SphericalTensorI.H.

References II, and VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >::v_.

◆ SphericalTensor() [6/6]

template<class Cmpt>

SphericalTensor ( Istream & is )

inlineexplicit

Construct from Istream.

Definition at line 52 of file SphericalTensorI.H.

References SphericalTensor().

Here is the call graph for this function:

Member Function Documentation

◆ operator=()

template<class Cmpt>

SphericalTensor & operator= ( const SphericalTensor< Cmpt > & )

default

Copy assignment.

◆ ii() [1/2]

template<class Cmpt>

const Cmpt & ii ( ) const

inlinenoexcept

Definition at line 137 of file SphericalTensor.H.

Referenced by Foam::cmptAv(), Foam::cmptMax(), Foam::cmptMin(), Foam::cmptSum(), Foam::det(), diagSqr(), DiagTensor< Cmpt >::DiagTensor(), Foam::inv(), Foam::lerp(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator&&(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator+(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator-(), Foam::operator/(), Foam::operator/(), SymmTensor< Cmpt >::operator=(), Tensor< Cmpt >::operator=(), SymmTensor< Cmpt >::SymmTensor(), Tensor< Cmpt >::Tensor(), and Foam::tr().

Here is the caller graph for this function:

◆ ii() [2/2]

template<class Cmpt>

Cmpt & ii ( )

inlinenoexcept

Definition at line 139 of file SphericalTensor.H.

◆ diagSqr()

template<class Cmpt>

Foam::scalar diagSqr ( ) const

inline

The L2-norm squared of the diagonal.

Definition at line 61 of file SphericalTensorI.H.

References ii(), and Foam::magSqr().

Referenced by Foam::magSqr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ T()

template<class Cmpt>

const SphericalTensor< Cmpt > & T ( ) const

inlinenoexcept

Return non-Hermitian transpose (no-op).

Definition at line 155 of file SphericalTensor.H.

Member Data Documentation

◆ rank

template<class Cmpt>

direction rank = 2

staticconstexpr

Rank of SphericalTensor is 2.

Definition at line 72 of file SphericalTensor.H.

◆ I

template<class Cmpt>

const SphericalTensor I

static

Definition at line 77 of file SphericalTensor.H.

◆ oneThirdI

template<class Cmpt>

const SphericalTensor oneThirdI

static

Definition at line 78 of file SphericalTensor.H.

◆ twoThirdsI

template<class Cmpt>

const SphericalTensor twoThirdsI

static

Definition at line 79 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/SphericalTensorI.H

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ labelType

Member Enumeration Documentation

◆ components

Constructor & Destructor Documentation

◆ SphericalTensor() [1/6]

◆ SphericalTensor() [2/6]

◆ SphericalTensor() [3/6]

◆ SphericalTensor() [4/6]

◆ SphericalTensor() [5/6]

◆ SphericalTensor() [6/6]

Member Function Documentation

◆ operator=()

◆ ii() [1/2]

◆ ii() [2/2]

◆ diagSqr()

◆ T()

Member Data Documentation

◆ rank

◆ I

◆ oneThirdI

◆ twoThirdsI