Templated vector space. More...

Inheritance diagram for VectorSpace< Form, Cmpt, Ncmpts >:

[legend]

Collaboration diagram for VectorSpace< Form, Cmpt, Ncmpts >:

Classes
class	ConstBlock
	Const sub-block type. More...

Public Types
typedef VectorSpace< Form, 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
	VectorSpace ()=default
	Default construct. More...

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

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

template<class Form2 , class Cmpt2 >
	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...

template<class SubVector , direction BStart>
const ConstBlock< SubVector, BStart >	block () const

const Cmpt &	operator[] (const direction) const

Cmpt &	operator[] (const direction)

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

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

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

void	operator= (const Foam::zero)

void	operator*= (const scalar)

void	operator/= (const scalar)

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

iterator	end () noexcept
	Return an 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...

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

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

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

Static Public Member Functions
static constexpr direction	size () noexcept
	The number of elements in the VectorSpace = Ncmpts. More...

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

Public Attributes
Cmpt	v_ [Ncmpts]
	The components of this vector space. More...

Static Public Attributes
static constexpr direction	dim = 3
	Dimensionality of space. More...

static constexpr direction	nComponents = Ncmpts
	Number of components in this vector space. More...

static constexpr direction	mRows = Ncmpts

static constexpr direction	nCols = 1

static const char *const	typeName = "symmTensor"

static const char *const	componentNames []

static const Form	zero

static const Form	one

static const Form	max

static const Form	min

static const Form	rootMax

static const Form	rootMin

Friends
Istream &	operator>> (Istream &, VectorSpace< Form, Cmpt, Ncmpts > &)

Ostream &	operator (Ostream &, const VectorSpace< Form, Cmpt, Ncmpts > &)

Detailed Description

template<class Form, class Cmpt, direction Ncmpts>
class Foam::VectorSpace< Form, Cmpt, Ncmpts >

Templated vector space.

Template arguments are the Form the vector space will be used to create, the type of the elements and the number of elements.

Source files

Definition at line 52 of file VectorSpace.H.

Member Typedef Documentation

◆ vsType

typedef VectorSpace<Form, Cmpt, Ncmpts> vsType

VectorSpace type.

Definition at line 86 of file VectorSpace.H.

◆ cmptType

typedef Cmpt cmptType

Component type.

Definition at line 91 of file VectorSpace.H.

◆ magType

typedef Cmpt magType

Magnitude type.

Definition at line 96 of file VectorSpace.H.

◆ iterator

typedef Cmpt* iterator

Random access iterator for traversing VectorSpace.

Definition at line 255 of file VectorSpace.H.

◆ const_iterator

typedef const Cmpt* const_iterator

Random access iterator for traversing VectorSpace.

Definition at line 260 of file VectorSpace.H.

Constructor & Destructor Documentation

◆ VectorSpace() [1/5]

VectorSpace ( )

default

Default construct.

◆ VectorSpace() [2/5]

VectorSpace ( const Foam::zero )

inline

Construct initialized to zero.

Definition at line 31 of file VectorSpaceI.H.

◆ VectorSpace() [3/5]

VectorSpace ( const VectorSpace< Form, Cmpt, Ncmpts > & vs )

inline

Copy construct.

Definition at line 39 of file VectorSpaceI.H.

◆ VectorSpace() [4/5]

VectorSpace ( const VectorSpace< Form2, Cmpt2, Ncmpts > & vs )

inlineexplicit

Copy construct of a VectorSpace with the same size.

Definition at line 50 of file VectorSpaceI.H.

◆ VectorSpace() [5/5]

VectorSpace ( Istream & is )

explicit

Construct from Istream.

Definition at line 30 of file VectorSpace.C.

Member Function Documentation

◆ size()

static constexpr direction size ( )

inlinestaticnoexcept

The number of elements in the VectorSpace = Ncmpts.

Definition at line 206 of file VectorSpace.H.

Referenced by Foam::zip().

Here is the caller graph for this function:

◆ component() [1/3]

const Cmpt & component ( const direction d ) const

inline

Definition at line 80 of file VectorSpaceI.H.

Referenced by Foam::component(), and Foam::setComponent().

Here is the caller graph for this function:

◆ component() [2/3]

Cmpt & component ( const direction d )

inline

Definition at line 99 of file VectorSpaceI.H.

◆ component() [3/3]

void component	(	Cmpt &	c,
		const direction	d
	)		const

inline

Definition at line 118 of file VectorSpaceI.H.

◆ replace()

void replace	(	const direction	d,
		const Cmpt &	c
	)

inline

Definition at line 138 of file VectorSpaceI.H.

Referenced by particle< Type >::trackToMovingTri(), and particle< Type >::trackToStationaryTri().

Here is the caller graph for this function:

◆ cdata()

const Cmpt * cdata ( ) const

inlinenoexcept

Return const pointer to the first data element.

Definition at line 185 of file VectorSpaceI.H.

◆ data()

Cmpt * data ( )

inlinenoexcept

Return pointer to the first data element.

Definition at line 178 of file VectorSpaceI.H.

◆ uniform()

Form uniform ( const Cmpt & s )

inlinestatic

Return a VectorSpace with all elements = s.

Definition at line 157 of file VectorSpaceI.H.

◆ block() [1/2]

const ConstBlock<SubVector, BStart> block ( ) const

inline

◆ operator[]() [1/2]

const Cmpt & operator[] ( const direction d ) const

inline

Definition at line 241 of file VectorSpaceI.H.

◆ operator[]() [2/2]

Cmpt & operator[] ( const direction d )

inline

Definition at line 260 of file VectorSpaceI.H.

◆ operator=() [1/2]

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

inline

Definition at line 331 of file VectorSpaceI.H.

Referenced by MatrixSpace< Tensor< scalar >, scalar, 3, 3 >::operator=().

Here is the caller graph for this function:

◆ operator+=()

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

inline

Definition at line 341 of file VectorSpaceI.H.

◆ operator-=()

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

inline

Definition at line 351 of file VectorSpaceI.H.

◆ operator=() [2/2]

void operator= ( const Foam::zero )

inline

Definition at line 360 of file VectorSpaceI.H.

◆ operator*=()

void operator*= ( const scalar s )

inline

Definition at line 368 of file VectorSpaceI.H.

◆ operator/=()

void operator/= ( const scalar s )

inline

Definition at line 378 of file VectorSpaceI.H.

◆ begin() [1/2]

Cmpt * begin ( )

inlinenoexcept

Return an iterator to begin of VectorSpace.

Definition at line 192 of file VectorSpaceI.H.

◆ end() [1/2]

Cmpt * end ( )

inlinenoexcept

Return an iterator to end of VectorSpace.

Definition at line 199 of file VectorSpaceI.H.

◆ cbegin()

const Cmpt * cbegin ( ) const

inlinenoexcept

Return const_iterator to begin of VectorSpace.

Definition at line 206 of file VectorSpaceI.H.

◆ cend()

const Cmpt * cend ( ) const

inlinenoexcept

Return const_iterator to end of VectorSpace.

Definition at line 214 of file VectorSpaceI.H.

◆ begin() [2/2]

const Cmpt * begin ( ) const

inlinenoexcept

Return const_iterator to begin of VectorSpace.

Definition at line 222 of file VectorSpaceI.H.

◆ end() [2/2]

const Cmpt * end ( ) const

inlinenoexcept

Return const_iterator to end of VectorSpace.

Definition at line 230 of file VectorSpaceI.H.

◆ block() [2/2]

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

inline

Definition at line 169 of file VectorSpaceI.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>>	(	Istream &	,
		VectorSpace< Form, Cmpt, Ncmpts > &
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const VectorSpace< Form, Cmpt, Ncmpts > &
	)

friend

Member Data Documentation

◆ v_

Cmpt v_[Ncmpts]

The components of this vector space.

Definition at line 81 of file VectorSpace.H.

Referenced by Foam::cmptMax(), Foam::cmptMin(), Foam::cmptProduct(), Foam::cmptSum(), Foam::magSqr(), Foam::operator &&(), Foam::operator<(), and Foam::operator==().

◆ dim

constexpr direction dim = 3

static

Dimensionality of space.

Definition at line 104 of file VectorSpace.H.

Referenced by Foam::cof(), and Foam::det().

◆ nComponents

constexpr direction nComponents = Ncmpts

static

Number of components in this vector space.

Definition at line 109 of file VectorSpace.H.

Referenced by anisotropicFilter::operator()(), and genericPatchFieldBase::processEntry().

◆ mRows

constexpr direction mRows = Ncmpts

static

Definition at line 115 of file VectorSpace.H.

◆ nCols

constexpr direction nCols = 1

static

Definition at line 116 of file VectorSpace.H.

◆ typeName

const char *const typeName = "symmTensor"

static

Definition at line 121 of file VectorSpace.H.

◆ componentNames

const char *const componentNames

static

Initial value:

=
{
    "xx", "xy", "xz",
          "yy", "yz",
                "zz"
}

Definition at line 122 of file VectorSpace.H.

◆ zero

const Foam::symmTensor zero

static

Definition at line 123 of file VectorSpace.H.

◆ one

const Foam::symmTensor one

static

Definition at line 124 of file VectorSpace.H.

◆ max

const Foam::symmTensor max

static

Definition at line 125 of file VectorSpace.H.

◆ min

const Foam::symmTensor min

static

Definition at line 126 of file VectorSpace.H.

◆ rootMax

const Foam::symmTensor rootMax

static

Definition at line 127 of file VectorSpace.H.

◆ rootMin

const Foam::symmTensor rootMin

static

Definition at line 128 of file VectorSpace.H.

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

src/OpenFOAM/primitives/VectorSpace/VectorSpace.H
src/OpenFOAM/primitives/SymmTensor/symmTensor/symmTensor.C
src/OpenFOAM/primitives/VectorSpace/VectorSpace.C
src/OpenFOAM/primitives/VectorSpace/VectorSpaceI.H

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

template<class Form, class Cmpt, direction Ncmpts> class Foam::VectorSpace< Form, Cmpt, Ncmpts >

Member Typedef Documentation

◆ vsType

◆ cmptType

◆ magType

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ VectorSpace() [1/5]

◆ VectorSpace() [2/5]

◆ VectorSpace() [3/5]

◆ VectorSpace() [4/5]

◆ VectorSpace() [5/5]

Member Function Documentation

◆ size()

◆ component() [1/3]

◆ component() [2/3]

◆ component() [3/3]

◆ replace()

◆ cdata()

◆ data()

◆ uniform()

◆ block() [1/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator=() [1/2]

◆ operator+=()

◆ operator-=()

◆ operator=() [2/2]

◆ operator*=()

◆ operator/=()

◆ begin() [1/2]

◆ end() [1/2]

◆ cbegin()

◆ cend()

◆ begin() [2/2]

◆ end() [2/2]

◆ block() [2/2]

Friends And Related Function Documentation

◆ operator>>

◆ operator

Member Data Documentation

◆ v_

◆ dim

◆ nComponents

◆ mRows

◆ nCols

◆ typeName

◆ componentNames

◆ zero

◆ one

◆ max

◆ min

◆ rootMax

◆ rootMin

template<class Form, class Cmpt, direction Ncmpts>
class Foam::VectorSpace< Form, Cmpt, Ncmpts >