This boundary condition is designed to be used in conjunction with surface film and pyrolysis modelling. It provides a temperature 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...

#include <filmPyrolysisTemperatureCoupledFvPatchScalarField.H>

Inheritance diagram for filmPyrolysisTemperatureCoupledFvPatchScalarField:

[legend]

Collaboration diagram for filmPyrolysisTemperatureCoupledFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("filmPyrolysisTemperatureCoupled")
	Runtime type information.
	filmPyrolysisTemperatureCoupledFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	filmPyrolysisTemperatureCoupledFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	filmPyrolysisTemperatureCoupledFvPatchScalarField (const filmPyrolysisTemperatureCoupledFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given.
	filmPyrolysisTemperatureCoupledFvPatchScalarField (const filmPyrolysisTemperatureCoupledFvPatchScalarField &)
	Construct as copy.
	filmPyrolysisTemperatureCoupledFvPatchScalarField (const filmPyrolysisTemperatureCoupledFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, 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 temperature 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 temperature is set using the film temperature
otherwise, it is set using pyrolysis temperature

Example of the boundary condition specification:

<patchName>
{
    type            filmPyrolysisTemperatureCoupled;
    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   300; // initial temperature / [K]
}

Source files

Definition at line 64 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [1/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF )

Construct from patch and internal field.

Definition at line 30 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References p.

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

Here is the caller graph for this function:

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [2/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict )

Construct from patch, internal field and dictionary.

Definition at line 62 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References dict, and p.

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [3/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField	(	const filmPyrolysisTemperatureCoupledFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper )

Construct by mapping given.

filmPyrolysisTemperatureCoupledFvPatchScalarField onto a new patch

Definition at line 45 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References filmPyrolysisTemperatureCoupledFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [4/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField ( const filmPyrolysisTemperatureCoupledFvPatchScalarField & fptpsf )

Construct as copy.

Definition at line 84 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [5/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField	(	const filmPyrolysisTemperatureCoupledFvPatchScalarField &	fptpsf,
		const DimensionedField< scalar, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 98 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "filmPyrolysisTemperatureCoupled" )

Runtime type information.

References filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Definition at line 153 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 161 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.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 177 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ phiName() [2/2]

word & phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 185 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [1/2]

const word & rhoName ( ) const

inline

Return the name of rho.

Definition at line 193 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [2/2]

word & rhoName ( )

inline

Return reference to the name of rho to allow adjustment.

Definition at line 201 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 115 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References objectRegistry::findObject(), UPstream::incrMsgType(), UPstream::msgType(), and regionModel::time().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 175 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.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/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.H
src/regionModels/regionCoupling/derivedFvPatchFields/filmPyrolysisTemperatureCoupled/filmPyrolysisTemperatureCoupledFvPatchScalarField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [1/5]

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [2/5]

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [3/5]

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [4/5]

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [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()