API Documentation

Docstrings for Arrhenius.jl interface members can be accessed through Julia's built-in documentation system or in the list below.

You can use name(Arrhenius) to print a full list of exported namespace by Arrhenius.jl, and then copy the list below.

Missing docstring.

Missing docstring for :Arrhenius. Check Documenter's build log for details.

Arrhenius.C2X — Function

get mole fraction (X) from concentration (C)

Arrhenius.CreateSolution — Function

CreateSolution(mech)

Reaction mechanism is interepreted here. Part of the infomation are read in from the yaml file, pary of them are from the pre-processed .npz file from ReacTorch and Cantera test for math enviroment

Arrhenius.H_mass_func — Function

get enthaphy (H) per mass

Missing docstring.

Missing docstring for :R. Check Documenter's build log for details.

Missing docstring.

Missing docstring for :S_mass_func. Check Documenter's build log for details.

Arrhenius.U_mass_func — Function

get enthaphy (U) per mass

Arrhenius.X2C — Function

get concentration (C) from mole fraction (X)

Arrhenius.X2Y — Function

get mass fraction (Y) from mole fraction (X)

Arrhenius.Y2C — Function

get concentration (C) from mass fraction (Y)

Arrhenius.Y2X — Function

get mole fraction (X) from mass fraction (Y)

Arrhenius.get_H — Function

get enthaphy (H) per mole

Arrhenius.get_S — Function

get entropy (S)

Arrhenius.get_U — Function

get enthaphy (U) per mole

Arrhenius.get_cp — Function

get specific of heat capacity

Arrhenius.get_cv — Function

get specific of heat capacity

Missing docstring.

Missing docstring for :one_atm. Check Documenter's build log for details.

Arrhenius.set_states — Function

"mainly for testing code, will be removed in the future" "please customize such functions following this example"

Arrhenius.species_index — Function

Get species index of a species

Example

    species_index(gas, "O2")

Arrhenius.wdot_func — Function

compute reaction source term dC/dt