planar Class Reference

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

Inheritance diagram for planar:
Collaboration diagram for planar:

Public Member Functions

 TypeName ("planar")
 Runtime type information. More...
 
 planar (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 planar (const planar &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~planar ()
 Destructor. More...
 
virtual dimensionedScalar Ak (const dimensionedScalar &Vk) const
 Return the area of the ignition kernel. More...
 
void operator= (const planar &)=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...
 

Additional Inherited Members

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

Detailed Description

Planar ignition kernel flame-wrinkling correction model.

Usage
Example usage:
XiCorr
{
    type            planar;
    cellZone        all;
    area            1e-4;
}

Where:

Property Description Required Default value
cellZone Correction cellZone yes
area Cross-sectional area of the 1D mesh yes
bMin Min b below which no correction no 0.01
Source files

Definition at line 90 of file planarXiCorr.H.

Constructor & Destructor Documentation

◆ planar() [1/2]

planar ( const fvMesh mesh,
const dictionary dict 
)

Construct from mesh and dictionary.

Definition at line 53 of file planarXiCorr.C.

References dict.

◆ planar() [2/2]

planar ( const planar )
delete

Disallow default bitwise copy construction.

◆ ~planar()

~planar ( )
virtual

Destructor.

Definition at line 67 of file planarXiCorr.C.

Member Function Documentation

◆ TypeName()

TypeName ( "planar"  )

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 73 of file planarXiCorr.C.

◆ operator=()

void operator= ( const planar )
delete

Disallow default bitwise assignment.


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