pmutt.omkm.phase.InteractingInterface

class pmutt.omkm.phase.InteractingInterface(name, species=[], site_density=None, phases=None, initial_state=None, kinetics=None, reactions=None, transport=None, interactions=None, use_motz_wise=False, options=None, note=None)

Bases: Phase

OpenMKM implementation of interacting interface. Inherits from Phase.

name

Name of the phase

Type:: str

species

Species present in Phase

Type:: list of _ModelBase objects

site_density

Site density in mol/cm2. Default is None

Type:: float, optional

phases

Phases associated with this interface

Type:: list of Phase objects or str

interactions

Source of lateral interactions. If any lateral interactions 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

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=[], site_density=None, phases=None, initial_state=None, kinetics=None, reactions=None, transport=None, interactions=None, use_motz_wise=False, options=None, note=None)

Methods

`__init__`(name[, species, site_density, ...])
`append_species`(val)
`clear_species`()
`copy_species`()
`extend_species`(val)
`index_species`(name)
`pop_species`(i)
`remove_species`(name)
`to_cti`([max_line_len, quantity_unit, ...])	Writes the object in Cantera's CTI format.
`to_omkm_yaml`([T, P, quantity_unit, ...])	Writes the object in Cantera's YAML format.

Attributes

`beps`
`elements`
`species`
`species_names`

append_species(val)

property beps

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, quantity_unit='molec', length_unit='cm', units=None, 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.
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.
delimiter (str, optional) – Delimiter used to separate header from footer of reaction and lateral interaction IDs. Default is ‘_’.

Returns:

CTI_str – Object represented as a CTI string.

Return type:

str

to_omkm_yaml(T=300.0, P=1.0, quantity_unit='molec', length_unit='cm', 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