SubField Class Reference

Pre-declare related SubField type. More...

Inheritance diagram for SubField:

Public Types
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

Public Member Functions
	SubField (const SubList< Type > &)
	Construct from a SubList. More...
	SubField (const UList< Type > &)
	Construct from a UList<Type>, using the entire size. More...
	SubField (const UList< Type > &list, const label subSize)
	Construct from a UList<Type> with a given size. More...
	SubField (const UList< Type > &list, const label subSize, const label startIndex)
	Construct from a UList<Type> with a given size and start index. More...
	SubField (const SubField< Type > &)
	Construct as copy. More...
tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...
tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...
void	operator= (const SubField< Type > &)
	Assignment via UList operator. Takes linear time. More...
	operator const Field< Type > & () const
	Allow cast to a const Field<Type>&. More...

Static Public Member Functions
static const SubField< Type > &	null ()
	Return a null SubField. More...

Detailed Description

Pre-declare related SubField type.

SubField is a Field obtained as a section of another Field.

Thus it is itself unallocated so that no storage is allocated or deallocated during its use. To achieve this behaviour, SubField is derived from a SubList rather than a List.

Source files

• SubField.H
• SubFieldI.H

Definition at line 61 of file Field.H.

Member Typedef Documentation

cmptType

typedef pTraits<Type>::cmptType cmptType

Component type.

Definition at line 67 of file SubField.H.

Constructor & Destructor Documentation

SubField() [1/5]

SubField ( const SubList< Type > &  )

inline

Construct from a SubList.

SubField() [2/5]

SubField ( const UList< Type > &  )

inlineexplicit

Construct from a UList<Type>, using the entire size.

SubField() [3/5]

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

inline

Construct from a UList<Type> with a given size.

Definition at line 50 of file SubFieldI.H.

SubField() [4/5]

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

inline

Construct from a UList<Type> with a given size and start index.

Definition at line 61 of file SubFieldI.H.

SubField() [5/5]

SubField ( const SubField< Type > &  )

inline

Construct as copy.

Member Function Documentation

null()

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

inlinestatic

Return a null SubField.

Definition at line 85 of file SubFieldI.H.

component()

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

inline

Return a component field of the field.

Definition at line 94 of file SubFieldI.H.

T()

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

inline

Return the field transpose (only defined for second rank tensors)

Definition at line 103 of file SubFieldI.H.

operator=()

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

inline

Assignment via UList operator. Takes linear time.

Definition at line 112 of file SubFieldI.H.

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

Here is the caller graph for this function:

operator const Field< Type > &()

operator const Field< Type > & ( ) const

inline

Allow cast to a const Field<Type>&.

---

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