Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
XiProfile Class Referenceabstract

Base class for flame wrinkling profiles. More...

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

Public Member Functions

 TypeName ("XiProfile")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, XiProfile, dictionary,(const dictionary &dict, const volScalarField &b),(dict, b))
 
 XiProfile (const volScalarField &b)
 Construct from components. More...
 
 XiProfile (const XiProfile &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~XiProfile ()
 Destructor. More...
 
virtual tmp< volScalarField > profile () const =0
 Return the flame-wrinkling profile. More...
 
bool read (const dictionary &XiProperties)
 Update properties from the given XiProperties dictionary. More...
 
void operator= (const XiProfile &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< XiProfile > New (const dictionary &XiProperties, const volScalarField &b)
 Return a reference to the selected XiEq model. More...
 

Protected Member Functions

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

Protected Attributes

const volScalarField & b_
 

Detailed Description

Base class for flame wrinkling profiles.

Source files

Definition at line 49 of file XiProfile.H.

Constructor & Destructor Documentation

◆ XiProfile() [1/2]

XiProfile ( const volScalarField &  b)

Construct from components.

Definition at line 47 of file XiProfile.C.

◆ XiProfile() [2/2]

XiProfile ( const XiProfile &  )
delete

Disallow default bitwise copy construction.

◆ ~XiProfile()

~XiProfile ( )
virtual

Destructor.

Definition at line 55 of file XiProfile.C.

Member Function Documentation

◆ readCoeffs()

bool readCoeffs ( const dictionary &  dict)
protectedpure virtual

Update coefficients from given dictionary.

Implemented in uniform, linear, and cubic.

Definition at line 39 of file XiProfile.C.

Referenced by cubic::readCoeffs(), linear::readCoeffs(), and uniform::readCoeffs().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "XiProfile"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
XiProfile  ,
dictionary  ,
(const dictionary &dict, const volScalarField &b)  ,
(dict, b)   
)

◆ New()

Foam::autoPtr< Foam::XiProfile > New ( const dictionary &  XiProperties,
const volScalarField &  b 
)
static

Return a reference to the selected XiEq model.

Definition at line 30 of file XiProfileNew.C.

References b, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, dictionary::lookup(), Foam::nl, dictionary::optionalSubDict(), and dictionary::subDict().

Here is the call graph for this function:

◆ profile()

virtual tmp<volScalarField> profile ( ) const
pure virtual

Return the flame-wrinkling profile.

Implemented in uniform, linear, and cubic.

◆ read()

bool read ( const dictionary &  XiProperties)

Update properties from the given XiProperties dictionary.

Definition at line 61 of file XiProfile.C.

References dictionary::optionalSubDict(), dictionary::subDict(), and Foam::type().

Here is the call graph for this function:

◆ operator=()

void operator= ( const XiProfile &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ b_

const volScalarField& b_
protected

Definition at line 56 of file XiProfile.H.

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