libICEpost.src.thermophysicalModels.thermoModels.CombustionModel

@author: <N. Surname> <e-mail> Last update: DD/MM/YYYY

Combustion models

Content of the package:

CombustionModel (class)

#TODO

StoichiometricCombustion (class)

#TODO

Submodules

• libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.CombustionModel
• libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.NoCombustion
• libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.PremixedCombustion

Classes

CombustionModel	Class handling combustion
PremixedCombustion	Premixted combustion model
NoCombustion	No combustion (inhert)

Package Contents

class libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.CombustionModel(/, *, reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture, reactionModel: str = 'Stoichiometry', state: libICEpost.src.thermophysicalModels.thermoModels.ThermoState.ThermoState = ThermoState(), **kwargs)

Bases: libICEpost.src.base.BaseClass.BaseClass

Class handling combustion

---

air

ThermoMixture The thermodynamic mixture of air

_freshMixture: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The mixture of reactants

_combustionProducts: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The mixture of combustion products

_mixture: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The current mixture

_reactionModel: libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.ReactionModel.ReactionModel

The reaction model

property freshMixture: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The current fresh (unburnt) mixture

Returns:

Mixture

property combustionProducts: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The combustion products

Returns:

Mixture

property mixture: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture

The mixture at current state

Returns:

Mixture

property reactionModel: libICEpost.src.thermophysicalModels.specie.reactions.ReactionModel.ReactionModel.ReactionModel

The reaction model

Returns:

ReactionModel

abstractmethod update(*, reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture = None, state: libICEpost.src.thermophysicalModels.thermoModels.ThermoState.ThermoState = None, **kwargs) → bool

Update the state of the system. To be overwritten in child classes.

Parameters:

• reactants (Mixture, optional) – update reactants composition. Defaults to None.

• state (ThermoState, optional) – the state variables of the system (needed to update the combustion model - e.g. equilibrium)

Returns:

if something changed

Return type:

bool

class libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.PremixedCombustion(/, *, xb: float = 0.0, **kwargs)

Bases: libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.CombustionModel.CombustionModel

Premixted combustion model

---

Attributes:

_xb: float

classmethod fromDictionary(dictionary: dict | libICEpost.src.base.dataStructures.Dictionary.Dictionary)

Create from dictionary.

Parameters:

dictionary (dict) –

The dictionary from which constructing, containing: reactants (Mixture): The reactants composition xb (float, optional): The initial progress variable. Defaults to 0.0. reactionModel (str, optional): Model handling reactions. defaults to “Stoichiometry”. <reactionModel>Dict (dict, optional): the dictionary for construction of the specific ReactionModel. state (ThermoState, optional): Giving current state to manage state-dependend

reaction models(e.g. equilibrium). Defaults to empty state ThermoState().

update(xb: float = None, *args, **kwargs) → bool

Update mixture composition based on progress variable, fuel, and reactants composition.

Parameters:

• xb (float, None) – the burned mass fraction. Defaults to None (no update).

• reactants (Mixture, optional) – update reactants composition. Defaults to None.

• state (ThermoState, optional) – Giving current state to manage state-dependend reaction models(e.g. equilibrium). Defaults to None.

Returns:

if something changed

Return type:

bool

class libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.NoCombustion(/, *, reactants: libICEpost.src.thermophysicalModels.specie.specie.Mixture.Mixture, **kwargs)

Bases: libICEpost.src.thermophysicalModels.thermoModels.CombustionModel.CombustionModel.CombustionModel

No combustion (inhert)

---

Attributes:

classmethod fromDictionary(dictionary: dict | libICEpost.src.base.dataStructures.Dictionary.Dictionary)

Create from dictionary.

Parameters:

dictionary (dict) – The dictionary from which constructing, containing: reactants (Mixture): The reactants composition

update(*args, **kwargs) → bool

Update mixture composition

Parameters:

reactants (Mixture, optional) – update reactants composition. Defaults to None.

Returns:

if something changed

Return type:

bool