Public Member Functions | List of all members
filmHeightInletVelocityFvPatchVectorField Class Reference
Boundary conditions » Region boundary conditions » Surface film boundary conditions

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")
 
 filmHeightInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 
 filmHeightInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &)
 
virtual tmp< fvPatchVectorField > clone () const
 
 filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 
virtual tmp< fvPatchVectorField > clone (const DimensionedField< vector, volMesh > &iF) const
 
virtual bool assignable () const
 
const word & phiName () const
 
word & phiName ()
 
const word & rhoName () const
 
word & rhoName ()
 
const word & deltafName () const
 
word & deltafName ()
 
virtual void updateCoeffs ()
 
virtual void write (Ostream &) const
 
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]
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: 

    <patchName>
    {
        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 134 of file filmHeightInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ filmHeightInletVelocityFvPatchVectorField() [1/5]

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

Definition at line 31 of file filmHeightInletVelocityFvPatchVectorField.C.

Referenced by filmHeightInletVelocityFvPatchVectorField::clone().

Here is the caller graph for this function:

◆ filmHeightInletVelocityFvPatchVectorField() [2/5]

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

Definition at line 61 of file filmHeightInletVelocityFvPatchVectorField.C.

◆ filmHeightInletVelocityFvPatchVectorField() [3/5]

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

Definition at line 45 of file filmHeightInletVelocityFvPatchVectorField.C.

◆ filmHeightInletVelocityFvPatchVectorField() [4/5]

filmHeightInletVelocityFvPatchVectorField ( const filmHeightInletVelocityFvPatchVectorField &  fhivpvf)

Definition at line 76 of file filmHeightInletVelocityFvPatchVectorField.C.

◆ filmHeightInletVelocityFvPatchVectorField() [5/5]

filmHeightInletVelocityFvPatchVectorField ( const filmHeightInletVelocityFvPatchVectorField &  fhivpvf,
const DimensionedField< vector, volMesh > &  iF 
)

Definition at line 89 of file filmHeightInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "filmHeightInletVelocity"  )

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const
inlinevirtual

Definition at line 190 of file filmHeightInletVelocityFvPatchVectorField.H.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [2/2]

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

Definition at line 207 of file filmHeightInletVelocityFvPatchVectorField.H.

References filmHeightInletVelocityFvPatchVectorField::filmHeightInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Definition at line 223 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const
inline

Definition at line 232 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )
inline

Definition at line 238 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inline

Definition at line 244 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ rhoName() [2/2]

word& rhoName ( )
inline

Definition at line 250 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ deltafName() [1/2]

const word& deltafName ( ) const
inline

Definition at line 256 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ deltafName() [2/2]

word& deltafName ( )
inline

Definition at line 262 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Definition at line 103 of file filmHeightInletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Definition at line 128 of file filmHeightInletVelocityFvPatchVectorField.C.

References os(), fvPatchField::write(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

◆ operator=()

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

Definition at line 141 of file filmHeightInletVelocityFvPatchVectorField.C.

References fvPatchField::operator=(), and Foam::foamVersion::patch.

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17