Base class for ignition kernel flame wrinkling Xi correction. More...

Inheritance diagram for kernelShape:

[legend]

Public Member Functions
	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...

virtual dimensionedScalar	Dcorr () const =0
	Return ignition kernel dimensionality correction to 3D. More...

virtual dimensionedScalar	Ak (const dimensionedScalar &Vk) const =0
	Return the area of the ignition kernel. More...

bool	read (const dictionary &XiProperties)
	Update properties from the given XiProperties dictionary. More...

void	operator= (const kernelShape &)=delete
	Disallow default bitwise assignment. More...

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

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

Detailed Description

Base class for ignition kernel flame wrinkling Xi correction.

Usage

Example usage:

kernelShape
{
    type            <type>;
}

Source files

Definition at line 59 of file kernelShape.H.

Constructor & Destructor Documentation

◆ kernelShape() [1/2]

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

Construct from mesh and dictionary.

Definition at line 47 of file kernelShape.C.

References dict.

◆ kernelShape() [2/2]

kernelShape ( const kernelShape & )

delete

Disallow default bitwise copy construction.

◆ ~kernelShape()

~kernelShape ( )

virtual

Destructor.

Definition at line 59 of file kernelShape.C.

Member Function Documentation

◆ readCoeffs()

bool readCoeffs ( const dictionary & dict )

protectedvirtual

Update coefficients from given dictionary.

Reimplemented in spherical, and cylindrical.

Definition at line 39 of file kernelShape.C.

Referenced by cylindrical::readCoeffs(), and spherical::readCoeffs().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "kernelShape" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		kernelShape	,
		dictionary	,
		(const fvMesh &mesh, const dictionary &dict)	,
		(mesh, dict)
	)

◆ New()

Foam::autoPtr< Foam::kernelShape > New	(	const fvMesh &	mesh,
		const dictionary &	dict
	)

static

Return a reference to the selected kernelShape model.

Definition at line 30 of file kernelShapeNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::indentOrNl(), Foam::Info, dictionary::lookup(), mesh, Foam::nl, dictionary::optionalTypeDict(), and Foam::type().

Here is the call graph for this function:

◆ Dcorr()

virtual dimensionedScalar Dcorr ( ) const

pure virtual

Return ignition kernel dimensionality correction to 3D.

Implemented in spherical, planar, and cylindrical.

◆ Ak()

virtual dimensionedScalar Ak ( const dimensionedScalar & Vk ) const

pure virtual

Return the area of the ignition kernel.

calculated from the given kernel volume

Implemented in spherical, planar, and cylindrical.

◆ read()

bool read ( const dictionary & XiProperties )

Update properties from the given XiProperties dictionary.

Definition at line 65 of file kernelShape.C.

References dict, dictionary::optionalTypeDict(), dictionary::subDict(), and Foam::type().

Here is the call graph for this function:

◆ operator=()

void operator= ( const kernelShape & )