The open source CFD toolbox
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:
[legend]
Collaboration diagram for filmHeightInletVelocityFvPatchVectorField:
[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...

virtual bool assignable () const
Return true: this patch field is altered by assignment. 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]
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]
}
Foam::fixedValueFvPatchField
Source files

Definition at line 138 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ filmHeightInletVelocityFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 36 of file filmHeightInletVelocityFvPatchVectorField.C.

## ◆ filmHeightInletVelocityFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 66 of file filmHeightInletVelocityFvPatchVectorField.C.

## ◆ filmHeightInletVelocityFvPatchVectorField() [3/5]

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

Construct by mapping given filmHeightInletVelocityFvPatchVectorField.

onto a new patch

Definition at line 50 of file filmHeightInletVelocityFvPatchVectorField.C.

## ◆ filmHeightInletVelocityFvPatchVectorField() [4/5]

 filmHeightInletVelocityFvPatchVectorField ( const filmHeightInletVelocityFvPatchVectorField & fhivpvf )

Construct as copy.

Definition at line 81 of file filmHeightInletVelocityFvPatchVectorField.C.

## ◆ filmHeightInletVelocityFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 94 of file filmHeightInletVelocityFvPatchVectorField.C.

## ◆ TypeName()

 TypeName ( "filmHeightInletVelocity" )

Runtime type information.

## ◆ clone() [1/2]

 virtual tmp< fvPatchVectorField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 194 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ clone() [2/2]

 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.

## ◆ assignable()

 virtual bool assignable ( ) const
inlinevirtual

Return true: this patch field is altered by assignment.

Definition at line 227 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ phiName() [1/2]

 const word & phiName ( ) const
inline

Return the name of phi.

Definition at line 236 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ phiName() [2/2]

 word & phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 242 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ rhoName() [1/2]

 const word & rhoName ( ) const
inline

Return the name of rho.

Definition at line 248 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ rhoName() [2/2]

 word & rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 254 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ deltafName() [1/2]

 const word & deltafName ( ) const
inline

Return the name of deltaf.

Definition at line 260 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ deltafName() [2/2]

 word & deltafName ( )
inline

Return reference to the name of df to allow adjustment.

Definition at line 266 of file filmHeightInletVelocityFvPatchVectorField.H.

## ◆ updateCoeffs()

 void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 110 of file filmHeightInletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

## ◆ write()

 void write ( Ostream & os ) const
virtual

Write.

Definition at line 135 of file filmHeightInletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

## ◆ operator=()

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

Definition at line 147 of file filmHeightInletVelocityFvPatchVectorField.C.

References fvPatchField< Type >::operator=().

Here is the call graph for this function:

The documentation for this class was generated from the following files:
{"extraction_info": {"found_math": true, "script_math_tex": 0, "script_math_asciimath": 0, "math_annotations": 0, "math_alttext": 0, "mathml": 0, "mathjax_tag": 0, "mathjax_inline_tex": 1, "mathjax_display_tex": 1, "mathjax_asciimath": 1, "img_math": 0, "codecogs_latex": 0, "wp_latex": 0, "mimetex.cgi": 0, "/images/math/codecogs": 0, "mathtex.cgi": 0, "katex": 0, "math-container": 0, "wp-katex-eq": 0, "align": 0, "equation": 0, "x-ck12": 0, "texerror": 0, "math_score": 0.1625353991985321, "perplexity": 28493.83815995334}, "config": {"markdown_headings": true, "markdown_code": true, "boilerplate_config": {"ratio_threshold": 0.18, "absolute_threshold": 10, "end_threshold": 15, "enable": true}, "remove_buttons": true, "remove_image_figures": true, "remove_link_clusters": true, "table_config": {"min_rows": 2, "min_cols": 3, "format": "plain"}, "remove_chinese": true, "remove_edit_buttons": true, "extract_latex": true}, "warc_path": "s3://commoncrawl/crawl-data/CC-MAIN-2022-40/segments/1664030337244.17/warc/CC-MAIN-20221002021540-20221002051540-00595.warc.gz"}