SubField Class Reference

SubField is a Field obtained as a section of another Field, without its own allocation. SubField is derived from a SubList rather than a List. More...

Inheritance diagram for SubField:

Public Types
typedef pTraits< Type >::cmptType	cmptType

Public Member Functions
	SubField () noexcept=default
	SubField (const SubField< Type > &sfield)
	SubField (const SubList< Type > &list)
	SubField (const UList< Type > &list)
	SubField (const UList< Type > &list, const label subSize)
	SubField (const UList< Type > &list, const label subSize, const label startIndex)
	SubField (const UList< Type > &list, const labelRange &range)
	SubField (const labelRange &range, const UList< Type > &list)
tmp< Field< cmptType > >	component (const direction) const
tmp< Field< Type > >	T () const
	operator const Foam::Field< Type > & () const
void	operator= (const SubField< Type > &)
void	operator= (const Field< Type > &)
void	operator= (const Type &val)
void	operator= (const Foam::zero)
template<class Form , direction Ncmpts>
void	operator= (const VectorSpace< Form, Type, Ncmpts > &rhs)
void	operator+= (const Type &val)
void	operator-= (const Type &val)
void	operator*= (const scalar &s)
void	operator/= (const scalar &s)
template<class Type >
void	operator= (const SubField< Type > &rhs)
template<class Type >
void	operator= (const Field< Type > &rhs)
template<class Type >
void	operator= (const Type &val)
template<class Type >
void	operator= (const Foam::zero)

Static Public Member Functions
static const SubField< Type > &	null ()

Detailed Description

SubField is a Field obtained as a section of another Field, without its own allocation. SubField is derived from a SubList rather than a List.

Source files

• SubField.H
• SubFieldI.H

Definition at line 60 of file Field.H.

Member Typedef Documentation

cmptType

typedef pTraits<Type>::cmptType cmptType

Definition at line 62 of file SubField.H.

Constructor & Destructor Documentation

SubField() [1/8]

SubField ( )

defaultnoexcept

SubField() [2/8]

SubField ( const SubField< Type > &  sfield )

inline

Definition at line 35 of file SubFieldI.H.

SubField() [3/8]

SubField ( const SubList< Type > &  list )

inline

Definition at line 45 of file SubFieldI.H.

SubField() [4/8]

SubField ( const UList< Type > &  list )

inlineexplicit

Definition at line 55 of file SubFieldI.H.

SubField() [5/8]

SubField ( const UList< Type > &  list, const label  subSize  )

inline

Definition at line 65 of file SubFieldI.H.

SubField() [6/8]

SubField ( const UList< Type > &  list, const label  subSize, const label  startIndex  )

inline

Definition at line 76 of file SubFieldI.H.

SubField() [7/8]

SubField ( const UList< Type > &  list, const labelRange &  range  )

inline

Definition at line 88 of file SubFieldI.H.

SubField() [8/8]

SubField ( const labelRange &  range, const UList< Type > &  list  )

inline

Definition at line 99 of file SubFieldI.H.

Member Function Documentation

null()

const Foam::SubField< Type > & null ( )

inlinestatic

Definition at line 25 of file SubFieldI.H.

component()

Foam::tmp< Foam::Field< typename Foam::SubField< Type >::cmptType > > component ( const direction  d ) const

inline

Definition at line 113 of file SubFieldI.H.

T()

Foam::tmp< Foam::Field< Type > > T ( ) const

inline

Definition at line 122 of file SubFieldI.H.

operator const Foam::Field< Type > &()

operator const Foam::Field< Type > & ( ) const

inline

Definition at line 131 of file SubFieldI.H.

operator=() [1/9]

void operator= ( const SubField< Type > &  )

inline

Referenced by SubDimensionedField< Type, GeoMesh >::operator=().

Here is the caller graph for this function:

operator=() [2/9]

void operator= ( const Field< Type > &  )

inline

operator=() [3/9]

void operator= ( const Type &  val )

inline

operator=() [4/9]

void operator= ( const Foam::zero  )

inline

operator=() [5/9]

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

inline

Definition at line 168 of file SubFieldI.H.

operator+=()

void operator+= ( const Type &  val )

inline

Definition at line 180 of file SubFieldI.H.

operator-=()

void operator-= ( const Type &  val )

inline

Definition at line 190 of file SubFieldI.H.

operator*=()

void operator*= ( const scalar &  s )

inline

Definition at line 200 of file SubFieldI.H.

operator/=()

void operator/= ( const scalar &  s )

inline

Definition at line 210 of file SubFieldI.H.

operator=() [6/9]

void operator= ( const SubField< Type > &  rhs )

inline

Definition at line 138 of file SubFieldI.H.

operator=() [7/9]

void operator= ( const Field< Type > &  rhs )

inline

Definition at line 145 of file SubFieldI.H.

operator=() [8/9]

void operator= ( const Type &  val )

inline

Definition at line 152 of file SubFieldI.H.

operator=() [9/9]

void operator= ( const Foam::zero  )

inline

Definition at line 159 of file SubFieldI.H.

---

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

• src/OpenFOAM/fields/Fields/Field/Field.H
• src/OpenFOAM/fields/Fields/Field/SubField.H
• src/OpenFOAM/fields/Fields/Field/SubFieldI.H