pmutt.cantera.phase.IdealGas

class pmutt.cantera.phase.IdealGas(name, species=None, initial_state=None, kinetics=None, reactions=None, transport=None, options=None, note=None)

Bases: Phase

Expresses ideal gas as Cantera CTI file. Inherits from Phase.

name

Name of the phase

Type:: str

species

Species present in Phase

Type:: list of _ModelBase objects

reactions

Source of reactions. If any reactions in CTI file occur in this phase, specify ‘all’. Default is None.

Type:: str, optional

note

Comment field for users. Default is None.

Type:: str, optional

initial_state

Currently not supported. Gives ability to set initial temperature, pressure or other operating variables of the phase. Default is None.

Type:: None, optional

kinetics

Currently not supported. Gives ability to specify reaction kinetics to use for phase. Default is None.

Type:: None, optional

transport

Currently not supported. Gives ability to specify transport model to use for phase. Default is None.

Type:: None, optional

options

Currently not supported. Specify special options to the phase. Default is None.

Type:: None, optional

__init__(name, species=None, initial_state=None, kinetics=None, reactions=None, transport=None, options=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, delimiter])	Writes the object in Cantera's CTI format.
`to_omkm_yaml`()	Writes the object in Cantera's CTI 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, delimiter='_')

Writes the object in Cantera’s CTI format.

Parameters:

max_line_len (int, optional) – Maximum number of characters in the line. Default is 80.
delimiter (str, optional) – Delimiter to use when specifying ranges for reactions. Default is ‘_’.

Returns:

CTI_str – Object represented as a CTI string.

Return type:

str

to_omkm_yaml()

Writes the object in Cantera’s CTI format.

Returns:: Dictionary compatible with Cantera’s YAML format
Return type:: yaml_dict