Public Member Functions | List of all members
filmHeightInletVelocityFvPatchVectorField Class Reference

This boundary condition is designed to be used in conjunction with surface film modelling. It provides a velocity inlet boundary condition for patches where the film height is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces using: More...

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

Public Member Functions

 TypeName ("filmHeightInletVelocity")
 Runtime type information. More...
 
 filmHeightInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 filmHeightInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given filmHeightInletVelocityFvPatchVectorField. More...
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &)
 Construct as copy. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
const wordrhoName () const
 Return the name of rho. More...
 
wordrhoName ()
 Return reference to the name of rho to allow adjustment. More...
 
const worddeltafName () const
 Return the name of deltaf. More...
 
worddeltafName ()
 Return reference to the name of df to allow adjustment. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const fvPatchField< vector > &pvf)
 

Detailed Description

This boundary condition is designed to be used in conjunction with surface film modelling. It provides a velocity inlet boundary condition for patches where the film height is specified. The inflow velocity is obtained from the flux with a direction normal to the patch faces using:

\[ U_p = \frac{n \phi}{\rho |Sf| \delta} \]

where

$ U_p $ = patch velocity [m/s]
$ n $ = patch normal vector
$ \phi $ = mass flux [kg/s]
$ \rho $ = density [kg/m3]
$ Sf $ = patch face area vectors [m2]
$ \delta $ = film height [m]


Patch usage

Property Description Required Default value
phi Flux field name no phi
rho density field name no rho
deltaf height field name no deltaf

Example of the boundary condition specification:

    myPatch
    {
        type            filmHeightInletVelocity;
        phi             phi;
        rho             rho;
        deltaf          deltaf;
        value           uniform (0 0 0); // initial velocity / [m/s]
    }
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 137 of file filmHeightInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

Construct from patch and internal field.

Definition at line 35 of file filmHeightInletVelocityFvPatchVectorField.C.

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

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 65 of file filmHeightInletVelocityFvPatchVectorField.C.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField(), fvPatch::size(), and vectorField().

Here is the call graph for this function:

Construct by mapping given filmHeightInletVelocityFvPatchVectorField.

onto a new patch

Definition at line 49 of file filmHeightInletVelocityFvPatchVectorField.C.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy.

Definition at line 82 of file filmHeightInletVelocityFvPatchVectorField.C.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 95 of file filmHeightInletVelocityFvPatchVectorField.C.

Member Function Documentation

TypeName ( "filmHeightInletVelocity"  )

Runtime type information.

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 193 of file filmHeightInletVelocityFvPatchVectorField.H.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

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

Construct and return a clone setting internal field reference.

Definition at line 210 of file filmHeightInletVelocityFvPatchVectorField.H.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 226 of file filmHeightInletVelocityFvPatchVectorField.H.

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 232 of file filmHeightInletVelocityFvPatchVectorField.H.

const word& rhoName ( ) const
inline

Return the name of rho.

Definition at line 238 of file filmHeightInletVelocityFvPatchVectorField.H.

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 244 of file filmHeightInletVelocityFvPatchVectorField.H.

const word& deltafName ( ) const
inline

Return the name of deltaf.

Definition at line 250 of file filmHeightInletVelocityFvPatchVectorField.H.

word& deltafName ( )
inline

Return reference to the name of df to allow adjustment.

Definition at line 256 of file filmHeightInletVelocityFvPatchVectorField.H.

References filmHeightInletVelocityFvPatchVectorField::operator=(), filmHeightInletVelocityFvPatchVectorField::updateCoeffs(), and filmHeightInletVelocityFvPatchVectorField::write().

Here is the call graph for this function:

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 109 of file filmHeightInletVelocityFvPatchVectorField.C.

References n, and Foam::operator==().

Referenced by filmHeightInletVelocityFvPatchVectorField::deltafName().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Write.

Definition at line 134 of file filmHeightInletVelocityFvPatchVectorField.C.

References fvPatchField< Type >::write().

Referenced by filmHeightInletVelocityFvPatchVectorField::deltafName().

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const fvPatchField< vector > &  pvf)
virtual

Definition at line 147 of file filmHeightInletVelocityFvPatchVectorField.C.

References Foam::makePatchTypeField(), and fvPatchField< Type >::operator=().

Referenced by filmHeightInletVelocityFvPatchVectorField::deltafName().

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: