Public Member Functions | List of all members
freestreamVelocityFvPatchVectorField Class Reference

This boundary condition provides a free-stream condition for velocity. More...

Inheritance diagram for freestreamVelocityFvPatchVectorField:
Inheritance graph
[legend]
Collaboration diagram for freestreamVelocityFvPatchVectorField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("freestreamVelocity")
 Runtime type information. More...
 
 freestreamVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, fvMesh > &, const fieldMapper &)
 Construct by mapping given freestreamVelocityFvPatchVectorField onto. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &, const DimensionedField< vector, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const vectorField & freestreamValue () const
 
vectorField & freestreamValue ()
 
virtual void map (const fvPatchVectorField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchVectorField &)
 Reset the fvPatchField to the given fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition provides a free-stream condition for velocity.

It is an inlet-outlet condition that uses the velocity orientation to continuously blend between fixed value for normal inlet and zero gradient for normal outlet flow.

The freestreamValue can be specified as a uniform value, a field or a function.

Usage
Property Description Required Default value
freestreamValue freestream velocity yes

Example of the boundary condition specification with uniform freestream: 

    <patchName>
    {
        type            freestreamVelocity;
        freestreamValue uniform (300 0 0);
    }

Example of the boundary condition specification for an atmospheric boundary layer: 

    <patchName>
    {
        type            freestreamVelocity;
        freestreamValue
        {
            type            atmosphericBoundaryLayerVelocity;
            libs            ("libatmosphericModels.so");
        }
    }

Note: This condition is designed to operate with the freestreamPressure condition

See also
Foam::DimensionedFieldFunction Foam::UFunctionalDimensionedField Foam::mixedFvPatchField Foam::freestreamFvPatchField
Source files

Definition at line 105 of file freestreamVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ freestreamVelocityFvPatchVectorField() [1/4]

freestreamVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 31 of file freestreamVelocityFvPatchVectorField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, freestreamVelocityFvPatchVectorField::freestreamValue(), fvPatchField< Type >::operator, fvPatchField< Type >::operator=(), p, and Foam::Zero.

Referenced by freestreamVelocityFvPatchVectorField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ freestreamVelocityFvPatchVectorField() [2/4]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given freestreamVelocityFvPatchVectorField onto.

a new patch

Definition at line 73 of file freestreamVelocityFvPatchVectorField.C.

◆ freestreamVelocityFvPatchVectorField() [3/4]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ freestreamVelocityFvPatchVectorField() [4/4]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  ptf,
const DimensionedField< vector, fvMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 91 of file freestreamVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "freestreamVelocity"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in MRFFreestreamVelocityFvPatchVectorField.

Definition at line 156 of file freestreamVelocityFvPatchVectorField.H.

References freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ freestreamValue() [1/2]

const vectorField& freestreamValue ( ) const
inline

Definition at line 170 of file freestreamVelocityFvPatchVectorField.H.

Referenced by freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ freestreamValue() [2/2]

vectorField& freestreamValue ( )
inline

Definition at line 175 of file freestreamVelocityFvPatchVectorField.H.

◆ map()

void map ( const fvPatchVectorField &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 108 of file freestreamVelocityFvPatchVectorField.C.

References fieldMapper::direct(), and mixedFvPatchField< Type >::map().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchVectorField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 119 of file freestreamVelocityFvPatchVectorField.C.

References mixedFvPatchField< Type >::reset().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Reimplemented in MRFFreestreamVelocityFvPatchVectorField.

Definition at line 129 of file freestreamVelocityFvPatchVectorField.C.

References forAll, Foam::mag(), magUp, and fvPatchField< Type >::updateCoeffs().

Referenced by MRFFreestreamVelocityFvPatchVectorField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented in MRFFreestreamVelocityFvPatchVectorField.

Definition at line 161 of file freestreamVelocityFvPatchVectorField.C.

References fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: