OpenFOAM logo
Open Source CFD Toolkit

SubField Class Template Reference

Inheritance diagram for SubField:

Inheritance graph
[legend]
Collaboration diagram for SubField:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::SubField< Type >


Public Types

typedef pTraits< Type >::cmptType cmptType
 Component type.

Public Member Functions

 SubField (const SubList< Type > &slist)
 Construct from UnallocatedField and SubField size.
 SubField (const UList< Type > &list, const label subSize)
 Construct from UnallocatedField and SubField size.
 SubField (const UList< Type > &list, const label subSize, const label startIndex)
 Construct from UnallocatedField, start and end indices.
 SubField (const SubField< Type > &sfield)
 Construct as copy.
tmp< Field< cmptType > > component (const direction) const
 Return a component field of the field.
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors).
void operator= (const SubField< Type > &)
 Assignment from UList operator. Takes linear time.
 operator const Field () const
 Allow cast to a const Field<Type>&.

Static Public Member Functions

SubField< Type > & null ()
 Return a null SubField.

Member Typedef Documentation

typedef pTraits<Type>::cmptType cmptType
 

Component type.

Definition at line 72 of file SubField.H.


Constructor & Destructor Documentation

SubField const SubList< Type > &  slist  )  [inline]
 

Construct from UnallocatedField and SubField size.

Definition at line 41 of file SubFieldI.H.

SubField const UList< Type > &  list,
const label  subSize
[inline]
 

Construct from UnallocatedField and SubField size.

Definition at line 50 of file SubFieldI.H.

SubField const UList< Type > &  list,
const label  subSize,
const label  startIndex
[inline]
 

Construct from UnallocatedField, start and end indices.

Definition at line 61 of file SubFieldI.H.

SubField const SubField< Type > &  sfield  )  [inline]
 

Construct as copy.

Definition at line 73 of file SubFieldI.H.


Member Function Documentation

tmp< Field< typename SubField< Type >::cmptType > > component const   direction  )  const [inline]
 

Return a component field of the field.

Definition at line 95 of file SubFieldI.H.

Referenced by SubField::null().

SubField< Type > & null  )  [inline, static]
 

Return a null SubField.

Reimplemented from SubList< Type >.

Definition at line 86 of file SubFieldI.H.

References SubField::component(), and Foam::direction.

Here is the call graph for this function:

operator const Field< Type > &  )  const [inline]
 

Allow cast to a const Field<Type>&.

Definition at line 121 of file SubFieldI.H.

void operator= const SubField< Type > &   )  [inline]
 

Assignment from UList operator. Takes linear time.

Definition at line 113 of file SubFieldI.H.

tmp< Field< Type > > T  )  const [inline]
 

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

Definition at line 104 of file SubFieldI.H.


The documentation for this class was generated from the following files:
For further information go to www.openfoam.org