Public Member Functions | List of all members
filmPyrolysisTemperatureCoupledFvPatchScalarField Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for filmPyrolysisTemperatureCoupledFvPatchScalarField:
Collaboration graph
[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< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 filmPyrolysisTemperatureCoupledFvPatchScalarField (const filmPyrolysisTemperatureCoupledFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const wordphiName () const
 Return the name of phi. More...
 
wordphiName ()
 Return reference to the name of phi to allow adjustment. More...
 
const wordrhoName () const
 Return the name of rho. More...
 
wordrhoName ()
 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

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 66 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [1/5]

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

References filmPyrolysisTemperatureCoupledFvPatchScalarField::filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [3/5]

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 90 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References filmPyrolysisTemperatureCoupledFvPatchScalarField::filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

◆ filmPyrolysisTemperatureCoupledFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

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

References filmPyrolysisTemperatureCoupledFvPatchScalarField::filmPyrolysisTemperatureCoupledFvPatchScalarField().

Here is the call graph for this function:

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

References filmPyrolysisTemperatureCoupledFvPatchScalarField::filmPyrolysisTemperatureCoupledFvPatchScalarField().

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

◆ phiName() [2/2]

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 164 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [1/2]

const word& rhoName ( ) const
inline

Return the name of rho.

Definition at line 170 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

◆ rhoName() [2/2]

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 176 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.H.

References filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), and filmPyrolysisTemperatureCoupledFvPatchScalarField::write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 119 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References UPstream::msgType(), patchi, Field< Type >::T(), and filmPyrolysisTemperatureCoupledFvPatchScalarField::write().

Referenced by filmPyrolysisTemperatureCoupledFvPatchScalarField::rhoName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 184 of file filmPyrolysisTemperatureCoupledFvPatchScalarField.C.

References Foam::makePatchTypeField(), and fvPatchField< Type >::write().

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

Here is the call graph for this function:
Here is the caller graph for this function:

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