OpenFOAM logo
Open Source CFD Toolkit

turbulentInletFvPatchField Class Template Reference

Inheritance diagram for turbulentInletFvPatchField:

Inheritance graph
[legend]
Collaboration diagram for turbulentInletFvPatchField:

Collaboration graph
[legend]
List of all members.

template<class Type>
class Foam::turbulentInletFvPatchField< Type >


Public Member Functions

 TypeName ("turbulentInlet")
 Runtime type information.
 turbulentInletFvPatchField (const fvPatch &, const Field< Type > &)
 Construct from patch and internal field.
 turbulentInletFvPatchField (const fvPatch &, const Field< Type > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const fvPatch &, const Field< Type > &, const fvPatchFieldMapper &)
 Construct by mapping given turbulentInletFvPatchField onto a new patch.
virtual tmp< fvPatchField<
Type > > 
clone () const
 Construct and return a clone.
 turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const Field< Type > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField<
Type > > 
clone (const Field< Type > &iF) const
 Construct and return a clone setting internal field reference.
const Type & fluctuationScale () const
 Return the fluctuation scale.
Type & fluctuationScale ()
 Return reference to the fluctuation scale to allow adjustment.
const Field< Type > & referenceField () const
 Return the reference field.
Field< Type > & referenceField ()
 Return reference to the reference field to allow adjustment.
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const fvPatchField< Type > &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Constructor & Destructor Documentation

turbulentInletFvPatchField const fvPatch ,
const Field< Type > & 
 

Construct from patch and internal field.

turbulentInletFvPatchField const fvPatch ,
const Field< Type > &  ,
const dictionary
 

Construct from patch, internal field and dictionary.

turbulentInletFvPatchField const turbulentInletFvPatchField< Type > &  ,
const fvPatch ,
const Field< Type > &  ,
const fvPatchFieldMapper
 

Construct by mapping given turbulentInletFvPatchField onto a new patch.

turbulentInletFvPatchField const turbulentInletFvPatchField< Type > &  ,
const Field< Type > & 
 

Construct as copy setting internal field reference.


Member Function Documentation

virtual void autoMap const fvPatchFieldMapper  )  [virtual]
 

Map (and resize as needed) from self given a mapping object.

Reimplemented from fvPatchField.

virtual tmp<fvPatchField<Type> > clone const Field< Type > &  iF  )  const [inline, virtual]
 

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFvPatchField.

Definition at line 120 of file turbulentInletFvPatchField.H.

virtual tmp<fvPatchField<Type> > clone  )  const [inline, virtual]
 

Construct and return a clone.

Reimplemented from fixedValueFvPatchField.

Definition at line 104 of file turbulentInletFvPatchField.H.

Type& fluctuationScale  )  [inline]
 

Return reference to the fluctuation scale to allow adjustment.

Definition at line 140 of file turbulentInletFvPatchField.H.

const Type& fluctuationScale  )  const [inline]
 

Return the fluctuation scale.

Definition at line 134 of file turbulentInletFvPatchField.H.

Field<Type>& referenceField  )  [inline]
 

Return reference to the reference field to allow adjustment.

Definition at line 152 of file turbulentInletFvPatchField.H.

References Foam::labelList.

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

Return the reference field.

Definition at line 146 of file turbulentInletFvPatchField.H.

virtual void rmap const fvPatchField< Type > &  ,
const labelList
[virtual]
 

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField.

TypeName "turbulentInlet"   ) 
 

Runtime type information.

virtual void updateCoeffs  )  [virtual]
 

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField.

virtual void write Ostream  )  const [virtual]
 

Write.

Reimplemented from fixedValueFvPatchField.


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