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	Dcorr () const
	Return ignition kernel dimensionality correction to 3D. 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 kernelShape
	TypeName ("kernelShape")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, kernelShape, dictionary,(const fvMesh &mesh, const dictionary &dict),(mesh, dict))
	kernelShape (const fvMesh &mesh, const dictionary &dict)
	Construct from mesh and dictionary. More...
	kernelShape (const kernelShape &)=delete
	Disallow default bitwise copy construction. More...
virtual	~kernelShape ()
	Destructor. More...
bool	read (const dictionary &XiProperties)
	Update properties from the given XiProperties dictionary. More...
void	operator= (const kernelShape &)=delete
	Disallow default bitwise assignment. More...

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

Detailed Description

Planar ignition kernel flame-wrinkling correction model.

Usage

Example usage:

kernelShape
{
    type            planar;
    area            1e-4;
}

Where:

Property	Description	Required	Default value
area	Cross-sectional area of the 1D mesh	yes

Source files

• planarKernelShape.H
• planar.C

Definition at line 77 of file planarKernelShape.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 planarKernelShape.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 planarKernelShape.C.

Member Function Documentation

TypeName()

TypeName

(

"planar"

)

Runtime type information.

Dcorr()

Foam::dimensionedScalar Dcorr ( ) const

virtual

Return ignition kernel dimensionality correction to 3D.

Implements kernelShape.

Definition at line 73 of file planarKernelShape.C.

Ak()

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

virtual

Return the area of the ignition kernel.

calculated from the given kernel volume

Implements kernelShape.

Definition at line 79 of file planarKernelShape.C.

operator=()

void operator= ( const planar &  )

delete

Disallow default bitwise assignment.

---

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

• applications/modules/XiFluid/fvModels/ignition/kernelShapes/planar/planarKernelShape.H
• applications/modules/XiFluid/fvModels/ignition/kernelShapes/planar/planarKernelShape.C