This boundary condition provides a free-stream condition. It is a 'mixed' condition derived from the inletOutlet
condition, whereby the mode of operation switches between fixed (free stream) value and zero gradient based on the sign of the flux.
More...
Public Member Functions | |
TypeName ("freestream") | |
Runtime type information. More... | |
freestreamFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
freestreamFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
freestreamFvPatchField (const freestreamFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given freestreamFvPatchField onto a new patch. More... | |
freestreamFvPatchField (const freestreamFvPatchField< Type > &) | |
Construct as copy. More... | |
virtual tmp< fvPatchField< Type > > | clone () const |
Construct and return a clone. More... | |
freestreamFvPatchField (const freestreamFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< fvPatchField< Type > > | clone (const DimensionedField< Type, volMesh > &iF) const |
Construct and return a clone setting internal field reference. More... | |
virtual void | autoMap (const fvPatchFieldMapper &mapper) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const fvPatchField< Type > &ptf, const labelList &addr) |
Reverse map the given fvPatchField onto this fvPatchField. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
const Field< Type > & | freestreamValue () const |
Field< Type > & | freestreamValue () |
virtual void | write (Ostream &) const |
Write. More... | |
Public Member Functions inherited from inletOutletFvPatchField< Type > | |
TypeName ("inletOutlet") | |
Runtime type information. More... | |
inletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
inletOutletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
inletOutletFvPatchField (const inletOutletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping given inletOutletFvPatchField onto a new patch. More... | |
inletOutletFvPatchField (const inletOutletFvPatchField< Type > &) | |
Construct as copy. More... | |
inletOutletFvPatchField (const inletOutletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual bool | assignable () const |
Return true: this patch field is altered by assignment. More... | |
virtual void | operator= (const fvPatchField< Type > &pvf) |
Public Member Functions inherited from mixedFvPatchField< Type > | |
TypeName ("mixed") | |
Runtime type information. More... | |
mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given mixedFvPatchField onto a new patch. More... | |
mixedFvPatchField (const mixedFvPatchField< Type > &) | |
Construct as copy. More... | |
mixedFvPatchField (const mixedFvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual bool | fixesValue () const |
Return true if this patch field fixes a value. More... | |
virtual Field< Type > & | refValue () |
virtual const Field< Type > & | refValue () const |
virtual Field< Type > & | refGrad () |
virtual const Field< Type > & | refGrad () const |
virtual scalarField & | valueFraction () |
virtual const scalarField & | valueFraction () const |
virtual tmp< Field< Type > > | snGrad () const |
Return gradient at boundary. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field. More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< scalarField > &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< scalarField > &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientInternalCoeffs () const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs () const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | operator= (const UList< Type > &) |
virtual void | operator+= (const fvPatchField< Type > &) |
virtual void | operator-= (const fvPatchField< Type > &) |
virtual void | operator*= (const fvPatchField< scalar > &) |
virtual void | operator/= (const fvPatchField< scalar > &) |
virtual void | operator+= (const Field< Type > &) |
virtual void | operator-= (const Field< Type > &) |
virtual void | operator*= (const Field< scalar > &) |
virtual void | operator/= (const Field< scalar > &) |
virtual void | operator= (const Type &) |
virtual void | operator+= (const Type &) |
virtual void | operator-= (const Type &) |
virtual void | operator*= (const scalar) |
virtual void | operator/= (const scalar) |
Public Member Functions inherited from fvPatchField< Type > | |
TypeName ("fvPatchField") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &) | |
Construct from patch and internal field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value) | |
Construct from patch, internal field and value. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType) | |
Construct from patch and internal field and patch type. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &) | |
Construct from patch and internal field and patch field. More... | |
fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true) | |
Construct from patch, internal field and dictionary. More... | |
fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) | |
Construct by mapping the given fvPatchField onto a new patch. More... | |
fvPatchField (const fvPatchField< Type > &) | |
Construct as copy. More... | |
fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual | ~fvPatchField ()=default |
Destructor. More... | |
virtual bool | coupled () const |
Return true if this patch field is coupled. More... | |
const objectRegistry & | db () const |
Return local objectRegistry. More... | |
const fvPatch & | patch () const |
Return patch. More... | |
const DimensionedField< Type, volMesh > & | internalField () const |
Return dimensioned internal field reference. More... | |
const Field< Type > & | primitiveField () const |
Return internal field reference. More... | |
const word & | patchType () const |
Optional patch type. More... | |
word & | patchType () |
Optional patch type. More... | |
bool | updated () const |
Return true if the boundary condition has already been updated. More... | |
bool | manipulatedMatrix () const |
Return true if the matrix has already been manipulated. More... | |
virtual tmp< Field< Type > > | snGrad (const scalarField &deltaCoeffs) const |
Return patch-normal gradient for coupled-patches. More... | |
virtual void | updateWeightedCoeffs (const scalarField &weights) |
Update the coefficients associated with the patch field. More... | |
virtual tmp< Field< Type > > | patchInternalField () const |
Return internal field next to patch as patch field. More... | |
virtual void | patchInternalField (Field< Type > &) const |
Return internal field next to patch as patch field. More... | |
virtual tmp< Field< Type > > | patchNeighbourField () const |
Return patchField on the opposite patch of a coupled patch. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise the evaluation of the patch field. More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< Field< scalar >> &) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientInternalCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix diagonal coefficients corresponding to the. More... | |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const |
Return the matrix source coefficients corresponding to the. More... | |
virtual void | manipulateMatrix (fvMatrix< Type > &matrix) |
Manipulate matrix. More... | |
virtual void | manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights) |
Manipulate matrix with given weights. More... | |
void | check (const fvPatchField< Type > &) const |
Check fvPatchField<Type> against given fvPatchField<Type> More... | |
virtual void | operator== (const fvPatchField< Type > &) |
virtual void | operator== (const Field< Type > &) |
virtual void | operator== (const Type &) |
template<class Type2 > | |
Foam::tmp< Foam::fvPatchField< Type > > | NewCalculatedType (const fvPatchField< Type2 > &pf) |
Additional Inherited Members | |
Public Types inherited from fvPatchField< Type > | |
typedef fvPatch | Patch |
typedef calculatedFvPatchField< Type > | Calculated |
Static Public Member Functions inherited from fvPatchField< Type > | |
static tmp< fvPatchField< Type > > | New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< Type > > | New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
static tmp< fvPatchField< Type > > | New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &) |
Return a pointer to a new patchField created on freestore from. More... | |
static tmp< fvPatchField< Type > > | New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &) |
Return a pointer to a new patchField created on freestore. More... | |
static tmp< fvPatchField< Type > > | NewCalculatedType (const fvPatch &) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
template<class Type2 > | |
static tmp< fvPatchField< Type > > | NewCalculatedType (const fvPatchField< Type2 > &) |
Return a pointer to a new calculatedFvPatchField created on. More... | |
static const word & | calculatedType () |
Return the type of the calculated for of fvPatchField. More... | |
Static Public Attributes inherited from fvPatchField< Type > | |
static int | disallowGenericFvPatchField |
Debug switch to disallow the use of genericFvPatchField. More... | |
Protected Attributes inherited from inletOutletFvPatchField< Type > | |
word | phiName_ |
Name of flux field. More... | |
This boundary condition provides a free-stream condition. It is a 'mixed' condition derived from the inletOutlet
condition, whereby the mode of operation switches between fixed (free stream) value and zero gradient based on the sign of the flux.
Property | Description | Required | Default value |
---|---|---|---|
freestreamValue | freestream velocity | no | |
freestreamBC | patchField providing the inlet field | no | |
phi | flux field name | no | phi |
Example of the boundary condition specification using a fixed value inlet condition:
<patchName> { type freestream; freestreamValue uniform (300 0 0); }
Example of the boundary condition specification using a separate condition to proveide the inlet condition:
<patchName> { type freestream; freestreamBC { type atmBoundaryLayerInletVelocity; flowDir (1 0 0); zDir (0 0 1); Uref 20; Zref 20; z0 uniform 0.1; zGround uniform 935; } }
Definition at line 120 of file freestreamFvPatchField.H.
freestreamFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 35 of file freestreamFvPatchField.C.
freestreamFvPatchField | ( | const fvPatch & | p, |
const DimensionedField< Type, volMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 47 of file freestreamFvPatchField.C.
References dict, Foam::New(), and p.
freestreamFvPatchField | ( | const freestreamFvPatchField< Type > & | ptf, |
const fvPatch & | p, | ||
const DimensionedField< Type, volMesh > & | iF, | ||
const fvPatchFieldMapper & | mapper | ||
) |
Construct by mapping given freestreamFvPatchField onto a new patch.
Definition at line 95 of file freestreamFvPatchField.C.
References Foam::New(), and p.
freestreamFvPatchField | ( | const freestreamFvPatchField< Type > & | ptf | ) |
Construct as copy.
Definition at line 115 of file freestreamFvPatchField.C.
freestreamFvPatchField | ( | const freestreamFvPatchField< Type > & | ptf, |
const DimensionedField< Type, volMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 131 of file freestreamFvPatchField.C.
TypeName | ( | "freestream" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from inletOutletFvPatchField< Type >.
Definition at line 169 of file freestreamFvPatchField.H.
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented from inletOutletFvPatchField< Type >.
Definition at line 186 of file freestreamFvPatchField.H.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented from mixedFvPatchField< Type >.
Definition at line 149 of file freestreamFvPatchField.C.
|
virtual |
Reverse map the given fvPatchField onto this fvPatchField.
Reimplemented from mixedFvPatchField< Type >.
Definition at line 161 of file freestreamFvPatchField.C.
|
virtual |
Update the coefficients associated with the patch field.
Reimplemented from inletOutletFvPatchField< Type >.
Definition at line 178 of file freestreamFvPatchField.C.
|
inline |
Definition at line 217 of file freestreamFvPatchField.H.
References mixedFvPatchField< Type >::refValue().
|
inline |
Definition at line 222 of file freestreamFvPatchField.H.
References mixedFvPatchField< Type >::refValue().
|
virtual |
Write.
Reimplemented from inletOutletFvPatchField< Type >.
Definition at line 196 of file freestreamFvPatchField.C.
References Ostream::beginBlock(), Ostream::endBlock(), Foam::vtk::write(), Ostream::write(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().