Stream

class ansys.chemkin.core.inlet.Stream(chem, label: str | None = None)

Bases: ansys.chemkin.core.mixture.Mixture

Generic inlet stream object for Chemkin open reactor models.

Overview

Methods

convert_to_mass_flowrate	Convert different types of flow rate value to mass flow rate.
convert_to_vol_flowrate	Convert different types of flow rate value to volumetric flow rate.
convert_to_sccm	Convert different types of flow rate value to SCCM.
check_flow_rate_mode	Get the type of flow rate is provided to this inlet.
notify_inlet_profile	Display warning that flow rate profile is specified.
profile_out_of_range	Report value out of the profile data range.
set_mass_flowrate_profile	Specify inlet mass flow rate profile.
get_mass_flowrate_profile_data	Get the mass flow rate at the given time from the profile data.

Properties

flowarea	Get inlet flow area.
mass_flowrate	Get inlet mass flow rate.
vol_flowrate	Get inlet volumetric flow rate.
sccm	Get inlet SCCM volumetric flow rate.
velocity	Get inlet gas velocity.
velocity_gradient	Get inlet gas axial velocity gradient.
label	Get the label of the Stream.

Attributes

flow_rate_profile_keys
flowrate_profile

Import detail

from ansys.chemkin.core.inlet import Stream

Property detail

property Stream.flowarea: float

Get inlet flow area.

property Stream.mass_flowrate: float

Get inlet mass flow rate.

property Stream.vol_flowrate: float

Get inlet volumetric flow rate.

property Stream.sccm: float

Get inlet SCCM volumetric flow rate.

property Stream.velocity: float

Get inlet gas velocity.

property Stream.velocity_gradient: float

Get inlet gas axial velocity gradient.

property Stream.label: str

Get the label of the Stream.

Attribute detail

Stream.flow_rate_profile_keys: dict[int, str]

Stream.flowrate_profile: dict[str, tuple[numpy.typing.NDArray[numpy.double], numpy.typing.NDArray[numpy.double]]]

Method detail

Stream.convert_to_mass_flowrate() → float

Convert different types of flow rate value to mass flow rate.

Stream.convert_to_vol_flowrate() → float

Convert different types of flow rate value to volumetric flow rate.

Stream.convert_to_sccm() → float

Convert different types of flow rate value to SCCM.

Stream.check_flow_rate_mode() → int

Get the type of flow rate is provided to this inlet.

Stream.notify_inlet_profile(mode: str)

Display warning that flow rate profile is specified.

Stream.profile_out_of_range(time: float, max: float, min: float)

Report value out of the profile data range.

Stream.set_mass_flowrate_profile(x: numpy.typing.NDArray[numpy.double], flow_rate: numpy.typing.NDArray[numpy.double])

Specify inlet mass flow rate profile.

Stream.get_mass_flowrate_profile_data(time: float = 0.0) → float

Get the mass flow rate at the given time from the profile data.