aquakin.StateTranslator#

class aquakin.StateTranslator(*args, **kwargs)[source]#

Bases: Protocol

Maps a concentration vector from one model’s species ordering to another’s. Must be AD-clean (used inside the plant RHS).

Variables:

  • source_model (CompiledModel) – The kinetic model whose species ordering the input concentration vector follows.

  • target_model (CompiledModel) – The kinetic model the output concentration vector is expressed in.

__init__(*args, **kwargs)#

Methods

__init__(*args, **kwargs)

translate(C_source[, digester_pH])

Map C_source to the target model's species ordering.

Attributes

source_model

target_model

translate(C_source, digester_pH=None)[source]#

Map C_source to the target model’s species ordering.

digester_pH optionally supplies the digester’s instantaneous, state-derived pH for a translator whose mapping has a pH-dependent (charge-balance) term; a translator without one ignores it. The plant supplies it when the translator declares needs_dest_pH.

Parameters:

C_source (Array)

Return type:

Array