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...

	filmHeightInletVelocityFvPatchVectorField (const filmHeightInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone. More...

virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference. More...

virtual bool	assignable () const
	True: this patch field is altered by assignment. More...

const word &	phiName () const
	Return the name of phi. More...

word &	phiName ()
	Return reference to the name of phi to allow adjustment. More...

const word &	rhoName () const
	Return the name of rho. More...

word &	rhoName ()
	Return reference to the name of rho to allow adjustment. More...

const word &	deltafName () const
	Return the name of deltaf. More...

word &	deltafName ()
	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

	=	patch velocity [m/s]
	=	patch normal vector
$\phi$	=	mass flux [kg/s]
$\rho$	=	density [kg/m3]
	=	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
	)

Construct from patch and internal field.

Definition at line 31 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 61 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 45 of file filmHeightInletVelocityFvPatchVectorField.C.

◆ filmHeightInletVelocityFvPatchVectorField() [4/5]

filmHeightInletVelocityFvPatchVectorField ( const filmHeightInletVelocityFvPatchVectorField & fhivpvf )

Construct as copy.

Definition at line 76 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 89 of file filmHeightInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "filmHeightInletVelocity" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchField<vector> > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 218 of file filmHeightInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 227 of file filmHeightInletVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ assignable()

virtual bool assignable ( ) const

inlinevirtual

True: this patch field is altered by assignment.

Definition at line 240 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ phiName() [1/2]

const word& phiName ( ) const

inline

Return the name of phi.

Definition at line 248 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ phiName() [2/2]

word& phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 256 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const

inline

Return the name of rho.

Definition at line 264 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ rhoName() [2/2]

word& rhoName ( )

inline

Return reference to the name of rho to allow adjustment.

Definition at line 272 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ deltafName() [1/2]

const word& deltafName ( ) const

inline

Return the name of deltaf.

Definition at line 280 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ deltafName() [2/2]

word& deltafName ( )

inline

Return reference to the name of df to allow adjustment.

Definition at line 288 of file filmHeightInletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

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

Write.

Definition at line 123 of file filmHeightInletVelocityFvPatchVectorField.C.

References os(), fvPatchField< Type >::write(), Ostream::writeEntryIfDifferent(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

◆ operator=()

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

virtual

Definition at line 136 of file filmHeightInletVelocityFvPatchVectorField.C.

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

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.H
src/regionModels/surfaceFilmModels/derivedFvPatchFields/filmHeightInletVelocity/filmHeightInletVelocityFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ filmHeightInletVelocityFvPatchVectorField() [1/5]

◆ filmHeightInletVelocityFvPatchVectorField() [2/5]

◆ filmHeightInletVelocityFvPatchVectorField() [3/5]

◆ filmHeightInletVelocityFvPatchVectorField() [4/5]

◆ filmHeightInletVelocityFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ assignable()

◆ phiName() [1/2]

◆ phiName() [2/2]

◆ rhoName() [1/2]

◆ rhoName() [2/2]

◆ deltafName() [1/2]

◆ deltafName() [2/2]

◆ updateCoeffs()

◆ write()

◆ operator=()