Skip to content

get_flux_expression

get_flux_expression(idx=0, rate_variable="k", species_variable="y", brackets="[]", idx_prefix="")

Returns a string for the flux expression:

\[ \text{k} \times \prod_{i=0}^{N} n_i \]

where \(k\) is the rate coefficient and \(n_i\) are the concentration of the reactants

Parameters

idx : int, optional
Rate coefficient array index offset. Default 0.
rate_variable : str, optional
Name of the rate coefficient array. Default "k".
species_variable : str, optional
Name of the species density array. Default "y".
brackets : str, optional
Two-character bracket string, e.g. "[]" or "()". Default "[]".
idx_prefix : str, optional
Prefix for species index names. Default "".

Returns

str
e.g. "k[0] * y[idx_h] * y[idx_o]".