feedtwin.props.species.SpeciesSpec Class Reference

Static Public Attributes
tuple	aliases = ()
tuple	roles = ()
tuple	chain = DEFAULT_CHAIN
dict	options = field(default_factory=dict)

Static Protected Attributes
dict	_SPECIES = {}
dict	_ALIASES = {}

Detailed Description

One declared fluid.

Attributes:
    name: Canonical lowercase identifier, e.g. ``"nitrogen"``.
    backend_fluid: What the equation-of-state library calls it, e.g.
        ``"Nitrogen"``. Separate from ``name`` because the library's
        spelling is its business, not ours.
    aliases: Other names that resolve here -- ``"lox"`` for oxygen, ``"gn2"``
        for nitrogen. Matched case-insensitively.
    roles: What the fluid is used as: ``oxidizer``, ``fuel``, ``pressurant``.
        Advisory metadata for UIs and validation, not physics.
    chain: Backends to try in order. Defaults to :data:`DEFAULT_CHAIN`.
    options: Free-form settings passed through to backends, so a backend can
        carry per-species configuration without this class growing a field
        for every backend that ever exists.

Definition at line 43 of file species.py.

Member Data Documentation

_ALIASES

dict feedtwin.props.species.SpeciesSpec._ALIASES = {}

staticprotected

Definition at line 70 of file species.py.

_SPECIES

dict feedtwin.props.species.SpeciesSpec._SPECIES = {}

staticprotected

Definition at line 69 of file species.py.

aliases

tuple feedtwin.props.species.SpeciesSpec.aliases = ()

static

Definition at line 63 of file species.py.

Referenced by feedtwin.session.hookup.Hookup.names(), and feedtwin.session.hookup.Hookup.to_dict().

chain

tuple feedtwin.props.species.SpeciesSpec.chain = DEFAULT_CHAIN

static

Definition at line 65 of file species.py.

options

dict feedtwin.props.species.SpeciesSpec.options = field(default_factory=dict)

static

Definition at line 66 of file species.py.

roles

tuple feedtwin.props.species.SpeciesSpec.roles = ()

static

Definition at line 64 of file species.py.

---

The documentation for this class was generated from the following file:

• lib/feedtwin/feedtwin/props/species.py