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, 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 &)=delete
 Disallow copy without setting internal field reference. More...
 
 freestreamVelocityFvPatchVectorField (const freestreamVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const vectorField & freestreamValue () const
 
vectorField & freestreamValue ()
 
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 85 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 32 of file freestreamVelocityFvPatchVectorField.C.

Referenced by freestreamVelocityFvPatchVectorField::clone(), and freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField().

Here is the caller graph for this function:

◆ 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 42 of file freestreamVelocityFvPatchVectorField.C.

References dictionary::found(), freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField(), fvPatch::size(), vectorField(), and Foam::Zero.

Here is the call graph for this function:

◆ 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 70 of file freestreamVelocityFvPatchVectorField.C.

References freestreamVelocityFvPatchVectorField::freestreamVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ freestreamVelocityFvPatchVectorField() [4/5]

freestreamVelocityFvPatchVectorField ( const freestreamVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ freestreamVelocityFvPatchVectorField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 82 of file freestreamVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "freestreamVelocity"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 138 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 151 of file freestreamVelocityFvPatchVectorField.H.

Referenced by freestreamVelocityFvPatchVectorField::write().

Here is the caller graph for this function:

◆ freestreamValue() [2/2]

vectorField& freestreamValue ( )
inline

Definition at line 156 of file freestreamVelocityFvPatchVectorField.H.

References freestreamVelocityFvPatchVectorField::updateCoeffs(), and freestreamVelocityFvPatchVectorField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 93 of file freestreamVelocityFvPatchVectorField.C.

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

Referenced by freestreamVelocityFvPatchVectorField::freestreamValue().

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

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 123 of file freestreamVelocityFvPatchVectorField.C.

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

Referenced by freestreamVelocityFvPatchVectorField::freestreamValue().

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