Public Member Functions | List of all members
BilgerMixtureFraction Class Reference
FunctionObjects » Thermophysical function objects

Calculates the Bilger mixture-fraction field (i.e. $f_{\mathrm{Bilger}}$) based on the elemental composition of the mixture. Elements C, H, S and O are considered. More...

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

Public Member Functions

 TypeName ("BilgerMixtureFraction")
 
 BilgerMixtureFraction (const word &name, const Time &runTime, const dictionary &dict)
 
 BilgerMixtureFraction (const BilgerMixtureFraction &)=delete
 
void operator= (const BilgerMixtureFraction &)=delete
 
virtual ~BilgerMixtureFraction ()=default
 
virtual bool read (const dictionary &)
 
virtual bool execute ()
 
virtual bool clear ()
 
virtual bool write ()
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~fvMeshFunctionObject ()=default
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~regionFunctionObject ()=default
 
template<class ObjectType >
const ObjectType * lookupObjectPtr (const word &fieldName) const
 
template<class ObjectType >
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 
- Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 
virtual ~stateFunctionObject ()=default
 
dictionary & propertyDict ()
 
bool foundProperty (const word &entryName) const
 
void clearTrigger ()
 
label getTrigger () const
 
bool setTrigger (const label triggeri, bool increaseOnly=true)
 
bool getDict (const word &entryName, dictionary &dict) const
 
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 
template<class Type >
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getProperty (const word &entryName, Type &value) const
 
template<class Type >
void setProperty (const word &entryName, const Type &value)
 
template<class Type >
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 
template<class Type >
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
void setResult (const word &entryName, const Type &value)
 
template<class Type >
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 
word resultType (const word &entryName) const
 
word objectResultType (const word &objectName, const word &entryName) const
 
wordList objectResultEntries () const
 
wordList objectResultEntries (const word &objectName) const
 
void writeResultEntries (Ostream &os) const
 
void writeResultEntries (const word &objectName, Ostream &os) const
 
void writeAllResultEntries (Ostream &os) const
 
- Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 
virtual ~timeFunctionObject ()=default
 
const Time & time () const
 
objectRegistry & storedObjects ()
 
const objectRegistry & storedObjects () const
 
- Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 
autoPtr< functionObject > clone () const
 
virtual ~functionObject ()=default
 
virtual const word & type () const =0
 
const word & name () const noexcept
 
bool useNamePrefix () const noexcept
 
bool useNamePrefix (bool on) noexcept
 
virtual bool execute (const label subIndex)
 
virtual bool end ()
 
virtual bool adjustTimeStep ()
 
virtual bool filesModified () const
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &mesh)
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObject > New (const word &name, const Time &runTime, const dictionary &dict)
 
- Public Attributes inherited from functionObject
bool log
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 
- Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 
void operator= (const fvMeshFunctionObject &)=delete
 
- Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry & obr () const
 
template<class ObjectType >
bool foundObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * cfindObject (const word &fieldName) const
 
template<class ObjectType >
const ObjectType * findObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType * findObject (const word &fieldName)
 
template<class ObjectType >
ObjectType * getObjectPtr (const word &fieldName) const
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName) const
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 
template<class ObjectType >
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 
bool writeObject (const word &fieldName)
 
bool clearObject (const word &fieldName)
 
void clearObjects (const wordList &objNames)
 
 regionFunctionObject (const regionFunctionObject &)=delete
 
void operator= (const regionFunctionObject &)=delete
 
- Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties & stateDict () const
 
functionObjects::properties & stateDict ()
 
 stateFunctionObject (const stateFunctionObject &)=delete
 
void operator= (const stateFunctionObject &)=delete
 
- Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 
 timeFunctionObject (const timeFunctionObject &)=delete
 
void operator= (const timeFunctionObject &)=delete
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMesh & mesh_
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 
const objectRegistry & obr_
 
const objectRegistry * obrPtr_
 
- Protected Attributes inherited from timeFunctionObject
const Time & time_
 

Detailed Description

Calculates the Bilger mixture-fraction field (i.e. $f_{\mathrm{Bilger}}$) based on the elemental composition of the mixture. Elements C, H, S and O are considered.

$f_{\mathrm{Bilger}}$ is the mass mixing ratio of fuel and oxidiser in [kg fuel / kg mixture], and is invariant to the reaction progress of the mixture (e.g. the same for unburnt and burnt mixtures).

$f_{\mathrm{Bilger}}$ equals to the unity for pure fuel and to zero for pure oxidiser.

The Bilger mixture-fraction field is computed based on the following:

\[ f_{\mathrm{Bilger}} = \frac{\beta - \beta_{\mathrm{ox}}}{\beta_{\mathrm{fuel}} - \beta_{\mathrm{ox}}} \]

with

\[ \beta = 2\frac{Y_C}{W_C} + 2\frac{Y_S}{W_S} + \frac{1}{2}\frac{Y_H}{W_H} - \frac{Y_O}{W_O} \]

where

$ \beta $ = Coupling function [kmol/kg]
$ Y_e $ = Elemental mass fraction of element, e
$ W_e $ = Atomic weight of element, e
$ {.}_{\mathrm{ox}} $ = Subscript to denote oxidiser composition
$ {.}_{\mathrm{fuel}} $ = Subscript to denote fuel composition

Operands:

Operand Type Location
input - -
output file - -
output field volScalarField $FOAM_CASE/<time>/<outField>

References: 

        Original method:
            Bilger, R. W. (1979).
            Turbulent jet diffusion flames.
            Energy and Combustion Science, p. 109-131.
            DOI:10.1016/B978-0-08-024780-9.50011-3

        Implementation:
            Zirwes, T., Zhang, F., Habisreuther, P., Hansinger, M.,
            Bockhorn, H., Pfitzner, M., & Trimis, D. (2019).
            Quasi-DNS dataset of a piloted flame
            with inhomogeneous inlet conditions.
            Flow, Turbulence and Combustion, vol 104, p. 997-1027.
            DOI:10.1007/s10494-019-00081-5
Usage
Minimal example by using system/controlDict.functions: 
BilgerMixtureFraction1
{
    // Mandatory entries (unmodifiable)
    type                 BilgerMixtureFraction;
    libs                 (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    fuel
    {
        // Optional entries (runtime modifiable)
        fractionBasis    mass;

        // Conditional mandatory entries (runtime modifiable)
        CH4              1;
    }

    oxidiser
    {
        // Optional entries (runtime modifiable)
        fractionBasis    mole;

        // Conditional mandatory entries (runtime modifiable)
        O2               0.23;
        N2               0.77;
    }

    // Optional entries (runtime modifiable)
    phase                <phaseName>;
    result               <resultName>;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: BilgerMixtureFraction word yes -
libs Library name: fieldFunctionObjects word yes -
fuel Dictionary for fuel composition dict yes -
oxidiser Dictionary for oxidiser composition dict yes -
phase Name of phase (e.g. "gas") word no ""
result Name of resulting field word no f_Bilger
fractionBasis Species-fraction interpretation method word no mass

Options for the fractionBasis entry: 

      mass   | Interpret species fractions as mass fractions
      mole   | Interpret species fractions as mole fractions

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Note
  • The mole or mass fractions are automatically normalized to the unity.
See also
Source files

Definition at line 266 of file BilgerMixtureFraction.H.

Constructor & Destructor Documentation

◆ BilgerMixtureFraction() [1/2]

BilgerMixtureFraction ( const word &  name,
const Time &  runTime,
const dictionary &  dict 
)

Definition at line 197 of file BilgerMixtureFraction.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ BilgerMixtureFraction() [2/2]

BilgerMixtureFraction ( const BilgerMixtureFraction &  )
delete

◆ ~BilgerMixtureFraction()

virtual ~BilgerMixtureFraction ( )
virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "BilgerMixtureFraction"  )

◆ operator=()

void operator= ( const BilgerMixtureFraction &  )
delete

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from regionFunctionObject.

Definition at line 238 of file BilgerMixtureFraction.C.

References dict, Foam::constant::electromagnetic::e, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::groupName(), Foam::Info, Foam::mag(), Foam::name(), Foam::nl, word::null, regionFunctionObject::read(), autoPtr::reset(), Foam::sum(), Foam::type(), and Y.

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 379 of file BilgerMixtureFraction.C.

◆ clear()

bool clear ( )
virtual

Definition at line 387 of file BilgerMixtureFraction.C.

◆ write()

bool write ( )
virtual

Implements functionObject.

Definition at line 393 of file BilgerMixtureFraction.C.

References Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:
The documentation for this class was generated from the following files:

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17