Public Member Functions | Protected Member Functions | List of all members
spherical Class Reference

Spherical ignition kernel flame-wrinkling correction model. More...

Inheritance diagram for spherical:
Inheritance graph
[legend]
Collaboration diagram for spherical:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("spherical")
 Runtime type information. More...
 
 spherical (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 spherical (const spherical &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~spherical ()
 Destructor. More...
 
virtual dimensionedScalar Ak (const dimensionedScalar &Vk) const
 Return the area of the ignition kernel. More...
 
void operator= (const spherical &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from XiCorrModel
 TypeName ("XiCorrModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, XiCorrModel, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
 
 XiCorrModel (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 XiCorrModel (const XiCorrModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~XiCorrModel ()
 Destructor. More...
 
virtual void XiCorr (volScalarField &Xi, const volScalarField &b, const volScalarField &mgb) const
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 
bool read (const dictionary &XiProperties)
 Update properties from the given XiProperties dictionary. More...
 
void operator= (const XiCorrModel &)=delete
 Disallow default bitwise assignment. More...
 

Protected Member Functions

virtual bool readCoeffs (const dictionary &dict)
 Update coefficients from given dictionary. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from XiCorrModel
static autoPtr< XiCorrModel > New (const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected XiCorrModel model. More...
 

Detailed Description

Spherical ignition kernel flame-wrinkling correction model.

Usage
Example usage: 
XiCorr
{
    type            spherical;
    cellZone        all;
    sphereFraction  1;
}

Where:

Property Description Required Default value
cellZone Correction cellZone yes
sphereFraction Kernel sphere fraction no 1
bMin Min b below which no correction no 0.01
Source files

Definition at line 90 of file sphericalXiCorr.H.

Constructor & Destructor Documentation

◆ spherical() [1/2]

spherical ( const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from mesh and dictionary.

Definition at line 53 of file sphericalXiCorr.C.

References dict, and spherical::readCoeffs().

Here is the call graph for this function:

◆ spherical() [2/2]

spherical ( const spherical &  )
delete

Disallow default bitwise copy construction.

◆ ~spherical()

~spherical ( )
virtual

Destructor.

Definition at line 68 of file sphericalXiCorr.C.

Member Function Documentation

◆ readCoeffs()

bool readCoeffs ( const dictionary &  dict)
protectedvirtual

Update coefficients from given dictionary.

Reimplemented from XiCorrModel.

Definition at line 43 of file sphericalXiCorr.C.

References dict, XiCorrModel::readCoeffs(), and dimensioned< Type >::readIfPresent().

Referenced by spherical::spherical().

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

◆ TypeName()

TypeName ( "spherical"  )

Runtime type information.

◆ Ak()

Foam::dimensionedScalar Ak ( const dimensionedScalar &  Vk) const
virtual

Return the area of the ignition kernel.

calculated from the given kernel volume

Implements XiCorrModel.

Definition at line 74 of file sphericalXiCorr.C.

References Foam::constant::mathematical::pi(), Foam::pow(), and Foam::sqr().

Here is the call graph for this function:

◆ operator=()

void operator= ( const spherical &  )
delete

Disallow default bitwise assignment.

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