FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

turbulentInletFvPatchField< Type > Class Template Reference

Generate a fluctuating inlet condition by adding a random component to a reference (mean) field. Input: referenceField Mean field. fluctuationScale RMS fluctuation, provided as the fraction of the mean field. alpha temporal correlation factor; the fraction of the new random component added to the previous time-step (defaults to 0.1). More...

#include <finiteVolume/turbulentInletFvPatchField.H>


Detailed Description

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

Generate a fluctuating inlet condition by adding a random component to a reference (mean) field. Input: referenceField Mean field. fluctuationScale RMS fluctuation, provided as the fraction of the mean field. alpha temporal correlation factor; the fraction of the new random component added to the previous time-step (defaults to 0.1).

Source files

Definition at line 61 of file turbulentInletFvPatchField.H.

Inheritance diagram for turbulentInletFvPatchField< Type >:
Collaboration diagram for turbulentInletFvPatchField< Type >:

List of all members.

Public Member Functions

 TypeName ("turbulentInlet")
 Runtime type information.
 turbulentInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
 Construct from patch and internal field.
 turbulentInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given turbulentInletFvPatchField.
 turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &)
 Construct as copy.
virtual tmp< fvPatchField< Type > >  clone () const
 Construct and return a clone.
 turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< fvPatchField< Type > >  clone (const DimensionedField< Type, volMesh > &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 &   p,
const DimensionedField< Type, volMesh > &   iF  
)

Construct from patch and internal field.

Definition at line 37 of file turbulentInletFvPatchField.C.

turbulentInletFvPatchField ( const fvPatch &   p,
const DimensionedField< Type, volMesh > &   iF,
const dictionary &   dict  
)

Construct from patch, internal field and dictionary.

Definition at line 71 of file turbulentInletFvPatchField.C.

References dictionary::found(), fvPatchField< Type >::operator==(), and fvPatch::size().

turbulentInletFvPatchField ( const turbulentInletFvPatchField< Type > &   ptf,
const fvPatch &   p,
const DimensionedField< Type, volMesh > &   iF,
const fvPatchFieldMapper &   mapper  
)

Construct by mapping given turbulentInletFvPatchField.

onto a new patch

Definition at line 53 of file turbulentInletFvPatchField.C.

Construct as copy.

Definition at line 100 of file turbulentInletFvPatchField.C.

turbulentInletFvPatchField ( const turbulentInletFvPatchField< Type > &   ptf,
const DimensionedField< Type, volMesh > &   iF  
)

Construct as copy setting internal field reference.

Definition at line 115 of file turbulentInletFvPatchField.C.


Member Function Documentation

TypeName ( "turbulentInlet"    )

Runtime type information.

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

Construct and return a clone.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 114 of file turbulentInletFvPatchField.H.

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > &   iF  ) const [inline, virtual]

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 131 of file turbulentInletFvPatchField.H.

const Type& fluctuationScale (  ) const [inline]

Return the fluctuation scale.

Definition at line 147 of file turbulentInletFvPatchField.H.

Type& fluctuationScale (  ) [inline]

Return reference to the fluctuation scale to allow adjustment.

Definition at line 153 of file turbulentInletFvPatchField.H.

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

Return the reference field.

Definition at line 159 of file turbulentInletFvPatchField.H.

Field<Type>& referenceField (  ) [inline]

Return reference to the reference field to allow adjustment.

Definition at line 165 of file turbulentInletFvPatchField.H.

void autoMap ( const fvPatchFieldMapper &   m  ) [virtual]

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

Reimplemented from fvPatchField< Type >.

Definition at line 133 of file turbulentInletFvPatchField.C.

References fvPatchField< Type >::autoMap().

void rmap ( const fvPatchField< Type > &   ptf,
const labelList &   addr  
) [virtual]
void updateCoeffs (  ) [virtual]

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 159 of file turbulentInletFvPatchField.C.

References Foam::cmptMultiply(), forAll, Foam::mag(), Foam::sqr(), Foam::sqrt(), timeIndex, and fvPatchField< Type >::updateCoeffs().

void write ( Ostream &   os  ) const [virtual]

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