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

Inheritance diagram for filmPyrolysisVelocityCoupledFvPatchVectorField:

[legend]

Collaboration diagram for filmPyrolysisVelocityCoupledFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("filmPyrolysisVelocityCoupled")
	Runtime type information. More...

	filmPyrolysisVelocityCoupledFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field. More...

	filmPyrolysisVelocityCoupledFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &)
	Construct as copy. More...

virtual tmp< fvPatchVectorField >	clone () const
	Construct and return a clone. More...

	filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy 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...

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

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Private Attributes
word	filmRegionName_
	Name of film region. More...

word	pyrolysisRegionName_
	Name of pyrolysis region. More...

word	phiName_
	Name of flux field. More...

word	rhoName_
	Name of density field. More...

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:

    myPatch
    {
        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 66 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 36 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::clone().

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 68 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References dict, p, and vectorField().

Here is the call graph for this function:

◆ 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 51 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [4/5]

filmPyrolysisVelocityCoupledFvPatchVectorField ( const filmPyrolysisVelocityCoupledFvPatchVectorField & fpvpvf )

Construct as copy.

Definition at line 92 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

◆ filmPyrolysisVelocityCoupledFvPatchVectorField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 106 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "filmPyrolysisVelocityCoupled" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchVectorField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 125 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

◆ 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 142 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

◆ phiName() [1/2]

const word& phiName ( ) const

inline

Return the name of phi.

Definition at line 158 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::phiName_.

◆ phiName() [2/2]

word& phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 164 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::phiName_.

◆ rhoName() [1/2]

const word& rhoName ( ) const

inline

Return the name of rho.

Definition at line 170 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::rhoName_.

◆ rhoName() [2/2]

word& rhoName ( )

inline

Return reference to the name of rho to allow adjustment.

Definition at line 176 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

References filmPyrolysisVelocityCoupledFvPatchVectorField::rhoName_.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 121 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References Foam::dimArea, Foam::dimDensity, dimensionedInternalField(), Foam::dimVelocity, Foam::exit(), Foam::FatalError, FatalErrorInFunction, filmPyrolysisVelocityCoupledFvPatchVectorField::filmRegionName_, UPstream::msgType(), Foam::nl, phi, filmPyrolysisVelocityCoupledFvPatchVectorField::phiName_, filmPyrolysisVelocityCoupledFvPatchVectorField::pyrolysisRegionName_, and filmPyrolysisVelocityCoupledFvPatchVectorField::rhoName_.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 212 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References fvPatchField::write().

Here is the call graph for this function:

Field Documentation

◆ filmRegionName_

word filmRegionName_

private

Name of film region.

Definition at line 73 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs().

◆ pyrolysisRegionName_

word pyrolysisRegionName_

private

Name of pyrolysis region.

Definition at line 76 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs().

◆ phiName_

word phiName_

private

Name of flux field.

Definition at line 79 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::phiName(), and filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs().

◆ rhoName_

word rhoName_

private

Name of density field.

Definition at line 82 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::rhoName(), and filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs().

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

Private Attributes

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()

Field Documentation

◆ filmRegionName_

◆ pyrolysisRegionName_

◆ phiName_

◆ rhoName_