Public Member Functions | List of all members
filmSurfaceVelocityFvPatchVectorField Class Reference

Film surface velocity boundary condition. More...

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

Public Member Functions

 TypeName ("filmSurfaceVelocity")
 Runtime type information. More...
 
 filmSurfaceVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 filmSurfaceVelocityFvPatchVectorField (const filmSurfaceVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 filmSurfaceVelocityFvPatchVectorField (const filmSurfaceVelocityFvPatchVectorField &)=delete
 Disallow copy without setting internal field reference. More...
 
 filmSurfaceVelocityFvPatchVectorField (const filmSurfaceVelocityFvPatchVectorField &, 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...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

Film surface velocity boundary condition.

Evaluates the surface velocity from the shear imposed by the neighbouring fluid velocity using either a simple drag model based on the difference between the fluid and film velocities multiplied by the coefficient Cs or if Cs is not specified or set to 0 the fluid viscous shear stress.

The simple model might be used in preference to the fluid viscous shear stress model in order to provide some means to include the drag enhancing effect of surface ripples, rivulets etc. in the film surface.

Usage
Property Description Required Default value
Cs Fluid-film drag coefficient no 0

Example of the boundary condition specification using the simple drag model: 

    <patchName>
    {
        type            filmSurfaceVelocity;
        Cs              0.005;
        value           $internalField;
    }

Example of the boundary condition specification using the fluid stress: 

    <patchName>
    {
        type            filmSurfaceVelocity;
        value           $internalField;
    }
See also
Foam::mixedFvPatchField
Source files

Definition at line 94 of file filmSurfaceVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ filmSurfaceVelocityFvPatchVectorField() [1/4]

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

Construct from patch, internal field and dictionary.

Definition at line 33 of file filmSurfaceVelocityFvPatchVectorField.C.

References dict, fvPatchField< Type >::operator, fvPatchField< Type >::operator=(), p, and Foam::Zero.

Here is the call graph for this function:

◆ filmSurfaceVelocityFvPatchVectorField() [2/4]

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

Construct by mapping given.

filmSurfaceVelocityFvPatchVectorField onto a new patch

Definition at line 63 of file filmSurfaceVelocityFvPatchVectorField.C.

◆ filmSurfaceVelocityFvPatchVectorField() [3/4]

filmSurfaceVelocityFvPatchVectorField ( const filmSurfaceVelocityFvPatchVectorField &  )
delete

Disallow copy without setting internal field reference.

◆ filmSurfaceVelocityFvPatchVectorField() [4/4]

filmSurfaceVelocityFvPatchVectorField ( const filmSurfaceVelocityFvPatchVectorField &  ptf,
const DimensionedField< vector, volMesh > &  iF 
)

Copy constructor setting internal field reference.

Definition at line 77 of file filmSurfaceVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "filmSurfaceVelocity"  )

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 145 of file filmSurfaceVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 91 of file filmSurfaceVelocityFvPatchVectorField.C.

References fvPatch::deltaCoeffs(), mappedPatchBase::fromNeighbour(), mappedPatchBase::getMap(), patchIdentifier::index(), fvPatch::lookupPatchField(), objectRegistry::lookupType(), Foam::mag(), UPstream::msgType(), n, mappedPatchBase::nbrMesh(), mappedPatchBase::nbrPolyPatch(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 183 of file filmSurfaceVelocityFvPatchVectorField.C.

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

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