Generation of Flamelet Data#

Important

DOCUMENTATION IN PROGRESS

This page provides the documentation on the methods used for generating flamelet data with SU2 DataMiner.

Flamelet Calculations#

ComputeFlamelets(self)#

Generate and store all flamelet data for the current settings.

ComputeFlameletData(Config: Config_FGM, run_parallel: bool = False, N_processors: int = 2, loglevel: int = 0, free_flame_refine: dict = None, burner_flame_refine: dict = None)#

Generate flamelet data according to Config_FGM settings either in serial or parallel.

Parameters:

  • Config (Config_FGM) – Config_FGM class containing manifold and flamelet generation settings.

  • run_parallel (bool, optional) – Generate flamelet data in parallel, defaults to False

  • N_processors (int, optional) – Number of parallel jobs when generating flamelet data in parallel, defaults to 0

  • loglevel (int, optional) – Cantera solver verbosity level (0=silent), defaults to 0

  • free_flame_refine (dict, optional) – Cantera free-flame refinement criteria dict with keys ratio, slope, curve, prune. If None, the DataGenerator_Cantera defaults are used.

  • burner_flame_refine (dict, optional) – Cantera burner-flame refinement criteria dict with keys ratio, slope, curve, prune. If None, the DataGenerator_Cantera defaults are used.

Raises:

Exception – If number of processors is set to zero when running in parallel.

ComputeBoundaryData(Config: Config_FGM, run_parallel: bool = False, N_processors: int = 2)#

Overwiting Configuration Settings#

SetOutputDir(self, output_dir_new: str)#

Define the flamelet data output directory manually.

Parameters:

output_dir_new (str) – Flamelet data output directory.

Raises:

Exception – If provided directory doesn’t exist.

SetTransportModel(self, transport_model: str)#

Overwrite the transport mechanism from the loaded configuration.

Parameters:

transport_model (str) – Cantera transport model.

SetReactionMechanism(self, reaction_mechanism: str)#

Define the reaction mechanism manually.

Parameters:

reaction_mechanism (str) – name of the reaction mechanism.

RunFreeFlames(self, input: bool = True)#

Include adiabatic free-flame data in the manifold.

Parameters:

input (bool) – Generate adiabatic free-flame data.

RunBurnerFlames(self, input: bool = True)#

Include burner-stabilized flame data in the manifold.

Parameters:

input (bool) – Generate burner-stabilized flamelet data.

RunEquilibrium(self, input: bool = True)#

Include chemical equilibrium data in the manifold.

Parameters:

input (bool) – Generate chemical equilibrium data.

RunMixtureFraction(self)#

Define the mixture status as mixture fraction instead of equivalence ratio.

RunEquivalenceRatio(self)#

Define the mixture status as equivalence ratio instead of mixture fraction.

SetFuelDefinition(self, fuel_species: list[str], fuel_weights: list[float])#

Manually define the fuel composition

Parameters:

  • fuel_species (list[str]) – list of fuel species names.

  • fuel_weights (list[float]) – list of fuel molar fraction weights.

Raises:

  • Exception – if no fuel species are provided.

  • Exception – if the number of species does not correspond to the number of weights.

SetOxidizerDefinition(self, oxidizer_species: list[str], oxidizer_weights: list[float])#

Manually define the oxidizer composition

Parameters:

  • oxidizer_species (list[str]) – list of oxidizer species names.

  • oxidizer_weights (list[float]) – list of oxidizer molar fraction weights.

Raises:

  • Exception – if no oxidizer species are provided.

  • Exception – if the number of species does not correspond to the number of weights.