pmutt.omkm.phase.StoichSolid

class pmutt.omkm.phase.StoichSolid(name, species=None, initial_state=None, transport=None, reactions=None, options=None, density=None, note=None)

Bases: StoichSolid

OpenMKM implementation of the stoichiometric solid phase. Currently there are no differences between this class and StoichSolid but one could add changes here in the future if necessary.

__init__(name, species=None, initial_state=None, transport=None, reactions=None, options=None, density=None, note=None)

Methods

__init__(name[, species, initial_state, ...])

append_species(val)

clear_species()

copy_species()

extend_species(val)

index_species(name)

pop_species(i)

remove_species(name)

to_cti([max_line_len, mass_unit, ...])

Writes the object in Cantera's CTI format.

to_omkm_yaml([T, P, pressure_unit, units])

Writes the object in Cantera's YAML format.

Attributes

elements

species

species_names

append_species(val)
clear_species()
copy_species()
property elements
extend_species(val)
index_species(name)
pop_species(i)
remove_species(name)
property species
property species_names
to_cti(max_line_len=80, mass_unit='g', length_unit='cm', units=None)

Writes the object in Cantera’s CTI format.

Parameters:
  • max_line_len (int, optional) – Maximum number of characters in the line. Default is 80.

  • mass_unit (str, optional) – Mass unit for density. Default is ‘g’

  • length_unit (str, optional) – Length unit for density. Default is ‘cm’

  • units (Units object, optional) – If specified, mass_unit and length_unit are overwritten. Default is None.

Returns:

CTI_str – Object represented as a CTI string.

Return type:

str

to_omkm_yaml(T=300.0, P=1.0, pressure_unit='atm', units=None)

Writes the object in Cantera’s YAML format.

Parameters:
  • T (float, optional) – Temperature in K. Default is 300 K

  • P (float, optional) – Pressure in atm. Default is 1 atm

  • quantity_unit (str, optional) – Quantity unit to use to calculate A. Default is ‘molec’

  • length_unit (str, optional) – Length unit to use to calculate A. Default is ‘cm’

  • units (Units object) – If specified, quantity_unit and length_unit are overwritten. Default is None.

Returns:

Dictionary compatible with Cantera’s YAML format

Return type:

yaml_dict