This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelling. More...

#include <filmPyrolysisVelocityCoupledFvPatchVectorField.H>

Inheritance diagram for filmPyrolysisVelocityCoupledFvPatchVectorField:

Collaboration diagram for filmPyrolysisVelocityCoupledFvPatchVectorField:

Public Member Functions
	TypeName ("filmPyrolysisVelocityCoupled")
	Runtime type information.
	filmPyrolysisVelocityCoupledFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field.
	filmPyrolysisVelocityCoupledFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &)
	Construct as copy.
	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference.
const word &	phiName () const
	Return the name of phi.
word &	phiName ()
	Return reference to the name of phi to allow adjustment.
const word &	rhoName () const
	Return the name of rho.
word &	rhoName ()
	Return reference to the name of rho to allow adjustment.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual void	write (Ostream &) const
	Write.

Detailed Description

This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelling.

It provides a velocity boundary condition for patches on the primary region based on whether the patch is seen to be 'wet', retrieved from the film alpha field.

if the patch is wet, the velocity is set using the film velocity
otherwise, it is set using pyrolysis out-gassing velocity

Example of the boundary condition specification:

<patchName>
{
    type            filmPyrolysisVelocityCoupled;
    phi             phi;      // name of flux field (default = phi)
    rho             rho;      // name of density field (default = rho)
    deltaWet        1e-4;     // threshold height for 'wet' film
    value           uniform   (0 0 0); // initial velocity / [m/s]
}

Source files

Definition at line 65 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [1/5]

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

Construct from patch and internal field.

Definition at line 30 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References p.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField(), filmPyrolysisVelocityCoupledFvPatchVectorField(), filmPyrolysisVelocityCoupledFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 62 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References dict, and p.

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [3/5]

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

Construct by mapping given.

filmPyrolysisVelocityCoupledFvPatchVectorField onto a new patch

Definition at line 45 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField(), and p.

Here is the call graph for this function:

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [4/5]

filmPyrolysisVelocityCoupledFvPatchVectorField ( const filmPyrolysisVelocityCoupledFvPatchVectorField & fpvpvf )

Construct as copy.

Definition at line 84 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [5/5]

filmPyrolysisVelocityCoupledFvPatchVectorField	(	const filmPyrolysisVelocityCoupledFvPatchVectorField &	fpvpvf,
		const DimensionedField< vector, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 98 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "filmPyrolysisVelocityCoupled" )

Runtime type information.

References filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Definition at line 154 of file filmPyrolysisVelocityCoupledFvPatchVectorField.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 162 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ phiName() [1/2]

const word & phiName ( ) const

inline

Return the name of phi.

Definition at line 178 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

◆ phiName() [2/2]

word & phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 186 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

◆ rhoName() [1/2]

const word & rhoName ( ) const

inline

Return the name of rho.

Definition at line 194 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

◆ rhoName() [2/2]

word & rhoName ( )

inline

Return reference to the name of rho to allow adjustment.

Definition at line 202 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 115 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References Foam::dimMass, Foam::dimTime, Foam::dimVolume, Foam::exit(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), UPstream::incrMsgType(), UPstream::msgType(), Foam::nl, phi, and regionModel::time().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 200 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

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

Here is the call graph for this function:

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

src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.H
src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisVelocityCoupled/filmPyrolysisVelocityCoupledFvPatchVectorField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [1/5]

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [2/5]

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [3/5]

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [4/5]

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ phiName() [1/2]

◆ phiName() [2/2]

◆ rhoName() [1/2]

◆ rhoName() [2/2]

◆ updateCoeffs()

◆ write()