Identity< Cmpt > Class Template Reference

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

Inheritance diagram for Identity< Cmpt >:
Collaboration diagram for Identity< Cmpt >:

Classes

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

Public Member Functions

 Identity ()
 Construct initialising 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 ()
 Construct null. More...
 
 SphericalTensor (const Foam::zero)
 Construct initialised 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 &)
 Construct from Istream. More...
 
const Cmpt & ii () const
 
Cmpt & ii ()
 
const SphericalTensor< Cmpt > & T () const
 Transpose. More...
 
- Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
 VectorSpace ()
 Construct null. More...
 
 VectorSpace (const Foam::zero)
 Construct initialised to zero. More...
 
 VectorSpace (Istream &)
 Construct from Istream. More...
 
 VectorSpace (const VectorSpace< Form2, Cmpt2, Ncmpts > &)
 Construct as copy of a VectorSpace with the same size. More...
 
const Cmpt & component (const direction) const
 
Cmpt & component (const direction)
 
void component (Cmpt &, const direction) const
 
void replace (const direction, const Cmpt &)
 
const ConstBlock< SubVector, BStart > block () const
 
const 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 VectorSpace< SphericalTensor< Cmpt >, Cmpt, Ncmpts > &)
 
void operator= (const Foam::zero)
 
void operator*= (const Type)
 
void operator/= (const Type)
 

Additional Inherited Members

- Public Types inherited from SphericalTensor< Cmpt >
enum  components { II }
 Component labeling enumeration. More...
 
typedef SphericalTensor< labellabelType
 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...
 
- Static Public Member Functions inherited from VectorSpace< SphericalTensor< Cmpt >, Cmpt, 1 >
static direction size ()
 Return 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 >
Cmpt v_ [Ncmpts]
 The components of this vector space. More...
 
- Static Public Attributes inherited from SphericalTensor< Cmpt >
static const 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 const direction dim
 Dimensionality of space. More...
 
static const direction nComponents
 Number of components in this vector space. More...
 
static const direction mRows
 
static const 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
 
static const SphericalTensor< Cmpt > nan
 

Detailed Description

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

Templated identity and dual space identity tensors derived from SphericalTensor.

Definition at line 47 of file Identity.H.

Constructor & Destructor Documentation

◆ Identity()

Identity ( )
inline

Construct initialising the SphericalTensor to 1.

Definition at line 55 of file Identity.H.

Member Function Documentation

◆ operator*()

dual operator* ( )
inline

Return the identity in the dual space.

Definition at line 73 of file Identity.H.

◆ operator label()

operator label ( ) const
inlineexplicit

Return 1 for label.

Definition at line 79 of file Identity.H.

◆ operator scalar()

operator scalar ( ) const
inlineexplicit

Return 1 for scalar.

Definition at line 85 of file Identity.H.


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