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

Inheritance diagram for filmPyrolysisTemperatureCoupledFvPatchScalarField:

[legend]

Collaboration diagram for filmPyrolysisTemperatureCoupledFvPatchScalarField:

[legend]

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

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

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

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

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

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

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

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, 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...

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

◆ 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 69 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

◆ 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 52 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [4/5]

filmPyrolysisTemperatureCoupledFvPatchScalarField ( const filmPyrolysisTemperatureCoupledFvPatchScalarField & fptpsf )

Construct as copy.

Definition at line 91 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 105 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "filmPyrolysisTemperatureCoupled" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 127 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 143 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ phiName() [1/2]

const word & phiName ( ) const

inline

Return the name of phi.

Definition at line 160 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ phiName() [2/2]

word & phiName ( )

inline

Return reference to the name of phi to allow adjustment.

Definition at line 166 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [1/2]

const word & rhoName ( ) const

inline

Return the name of rho.

Definition at line 172 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [2/2]

word & rhoName ( )

inline

Return reference to the name of rho to allow adjustment.

Definition at line 178 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 122 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References objectRegistry::findObject(), UPstream::msgType(), Field< Type >::T(), and regionModel::time().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 185 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References os(), ObukhovLength::write(), and Ostream::writeEntryIfDifferent().

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