Public Member Functions | List of all members
filmPyrolysisVelocityCoupledFvPatchVectorField Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for filmPyrolysisVelocityCoupledFvPatchVectorField:
Collaboration graph
[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< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 filmPyrolysisVelocityCoupledFvPatchVectorField (const filmPyrolysisVelocityCoupledFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, 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 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.

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

Construct from patch and internal field.

Definition at line 36 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::clone(), and filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the caller graph for this function:

Construct from patch, internal field and dictionary.

Definition at line 68 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField(), fvPatch::size(), and vectorField().

Here is the call graph for this function:

Construct by mapping given.

filmPyrolysisVelocityCoupledFvPatchVectorField onto a new patch

Definition at line 51 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

Construct as copy.

Definition at line 92 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

References filmPyrolysisVelocityCoupledFvPatchVectorField::filmPyrolysisVelocityCoupledFvPatchVectorField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 106 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

Member Function Documentation

TypeName ( "filmPyrolysisVelocityCoupled"  )

Runtime type information.

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:

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:

const word& phiName ( ) const
inline

Return the name of phi.

Definition at line 158 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

word& phiName ( )
inline

Return reference to the name of phi to allow adjustment.

Definition at line 164 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

const word& rhoName ( ) const
inline

Return the name of rho.

Definition at line 170 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

word& rhoName ( )
inline

Return reference to the name of rho to allow adjustment.

Definition at line 176 of file filmPyrolysisVelocityCoupledFvPatchVectorField.H.

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

Here is the call graph for this function:

void updateCoeffs ( )
virtual
void write ( Ostream os) const
virtual

Write.

Definition at line 214 of file filmPyrolysisVelocityCoupledFvPatchVectorField.C.

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

Referenced by filmPyrolysisVelocityCoupledFvPatchVectorField::rhoName(), and filmPyrolysisVelocityCoupledFvPatchVectorField::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: