Identity< Cmpt > Class Template Reference

Templated identity and dual space identity tensors derived from SphericalTensor. More...

Inheritance diagram for Identity< Cmpt >:
[legend]
Collaboration diagram for Identity< Cmpt >:
[legend]

Classes

class  dual
 The identity type in the dual space. More...
 

Public Member Functions

 Identity ()
 Construct initializing the SphericalTensor to 1. More...
 
dual operator* ()
 Return the identity in the dual space. More...
 
 operator label () const
 Return 1 for label. More...
 
 operator scalar () const
 Return 1 for scalar. More...
 
- Public Member Functions inherited from SphericalTensor< Cmpt >
 SphericalTensor ()=default
 Default construct. More...
 
 SphericalTensor (const SphericalTensor &)=default
 Copy construct. More...
 
SphericalTensoroperator= (const SphericalTensor &)=default
 Copy assignment. More...
 
 SphericalTensor (const Foam::zero)
 Construct initialized to zero. More...
 
template<class Cmpt2 >
 SphericalTensor (const VectorSpace< SphericalTensor< Cmpt2 >, Cmpt2, 1 > &)
 Construct given VectorSpace. More...
 
 SphericalTensor (const Cmpt &tii)
 Construct given the component. More...
 
 SphericalTensor (Istream &is)
 Construct from Istream. More...
 
const Cmpt & ii () const
 
Cmpt & ii ()
 
const SphericalTensor< Cmpt > & T () const
 Return non-Hermitian transpose (no-op) More...
 
- Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
 VectorSpace ()=default
 Default construct. More...
 
 VectorSpace (const Foam::zero)
 Construct initialized to zero. More...
 
 VectorSpace (const VectorSpace< SphericalTensor< 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< SphericalTensor< Cmpt >, Cmpt, Ncmpts >::template ConstBlock< SubVector, BStart > block () const
 
const Cmpt & operator[] (const direction) const
 
Cmpt & operator[] (const direction)
 
void operator= (const VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
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 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...
 

Additional Inherited Members

- Public Types inherited from SphericalTensor< Cmpt >
enum  components { II }
 Component labeling enumeration. More...
 
typedef SphericalTensor< label > labelType
 Equivalent type of labels used for valid component indexing. More...
 
- Public Types inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
typedef VectorSpace< SphericalTensor< 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...
 
- Static Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
static constexpr direction size () noexcept
 The number of elements in the VectorSpace = Ncmpts. More...
 
static SphericalTensor< Cmpt > uniform (const Cmpt &s)
 Return a VectorSpace with all elements = s. More...
 
- Public Attributes inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
const typedef Cmpt * const_iterator
 Random access iterator for traversing VectorSpace. More...
 
Cmpt v_ [Ncmpts]
 The components of this vector space. More...
 
- Static Public Attributes inherited from SphericalTensor< Cmpt >
static constexpr direction rank = 2
 Rank of SphericalTensor is 2. More...
 
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. 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 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
 

Detailed Description

template<class Cmpt>
class Foam::Identity< Cmpt >

Templated identity and dual space identity tensors derived from SphericalTensor.

Definition at line 49 of file Identity.H.

Constructor & Destructor Documentation

◆ Identity()

Identity ( )
inline

Construct initializing the SphericalTensor to 1.

Definition at line 57 of file Identity.H.

Member Function Documentation

◆ operator*()

dual operator* ( )
inline

Return the identity in the dual space.

Definition at line 75 of file Identity.H.

◆ operator label()

operator label ( ) const
inlineexplicit

Return 1 for label.

Definition at line 81 of file Identity.H.

◆ operator scalar()

operator scalar ( ) const
inlineexplicit

Return 1 for scalar.

Definition at line 87 of file Identity.H.


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