Public Member Functions | List of all members
freestreamVelocityFvPatchVectorField Class Reference
Boundary conditions » InletBoundary conditions » | Outlet

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, volMesh > &)
 Construct from patch and internal field. More...
 
 freestreamVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given freestreamVelocityFvPatchVectorField onto. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &)
 Construct as copy. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchField< vector > > clone () const
 Return a clone. More...
 
virtual tmp< fvPatchField< vector > > clone (const DimensionedField< vector, volMesh > &iF) const
 Clone with an internal field reference. More...
 
const vectorField & freestreamValue () const
 Same as refValue() More...
 
vectorField & freestreamValue ()
 Same as refValue() 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.

Usage
Property Description Required Default value
freestreamValue freestream velocity yes

Example of the boundary condition specification: 

    <patchName>
    {
        type            freestreamVelocity;
        freestreamValue uniform (300 0 0);
    }
Note
This condition is designed to operate with the freestreamPressure condition
See also
Foam::mixedFvPatchField Foam::freestreamFvPatchField
Source files

Definition at line 86 of file freestreamVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ freestreamVelocityFvPatchVectorField() [1/5]

freestreamVelocityFvPatchVectorField ( const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 27 of file freestreamVelocityFvPatchVectorField.C.

◆ freestreamVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 37 of file freestreamVelocityFvPatchVectorField.C.

References dict, p, and Foam::Zero.

◆ freestreamVelocityFvPatchVectorField() [3/5]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  ptf,
const fvPatch &  p,
const DimensionedField< vector, volMesh > &  iF,
const fvPatchFieldMapper &  mapper 
)

Construct by mapping given freestreamVelocityFvPatchVectorField onto.

a new patch

Definition at line 58 of file freestreamVelocityFvPatchVectorField.C.

◆ freestreamVelocityFvPatchVectorField() [4/5]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  wbppsf)

Construct as copy.

Definition at line 70 of file freestreamVelocityFvPatchVectorField.C.

◆ freestreamVelocityFvPatchVectorField() [5/5]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  wbppsf,
const DimensionedField< vector, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 79 of file freestreamVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "freestreamVelocity"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<vector> > clone ( ) const
inlinevirtual

Return a clone.

Definition at line 153 of file freestreamVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchField<vector> > clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Clone with an internal field reference.

Definition at line 162 of file freestreamVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ freestreamValue() [1/2]

const vectorField& freestreamValue ( ) const
inline

Same as refValue()

Definition at line 175 of file freestreamVelocityFvPatchVectorField.H.

◆ freestreamValue() [2/2]

vectorField& freestreamValue ( )
inline

Same as refValue()

Definition at line 180 of file freestreamVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 90 of file freestreamVelocityFvPatchVectorField.C.

References Foam::mag(), Foam::foamVersion::patch, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 105 of file freestreamVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

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