Reaction Path Diagrams#

ReactionPathDiagram(gas::Solution, element::AbstractString)

Reaction-path diagram tracing the flow of a chemical element (e.g. "C", "H", "O", "N") through the reaction network of gas at its current state.

Set options (see set_threshold!, set_flow_type!, …), then call build! and retrieve the result with get_dot (Graphviz), get_data or get_log.

gas = Solution("gri30.yaml")
set_TPX!(gas, 2000.0, one_atm, "CH4:1, O2:2, N2:7.52")
d = ReactionPathDiagram(gas, "C")
set_threshold!(d, 0.01)
set_flow_type!(d, "NetFlow")
build!(d)
print(get_dot(d))
build!(d::ReactionPathDiagram)

Build (or rebuild) the diagram from the current state of the owning Solution. Call after setting options and before retrieving output.

get_dot(d::ReactionPathDiagram)

Graphviz dot description of the diagram (call build! first).

get_data(d::ReactionPathDiagram)

Raw flow data underlying the diagram (call build! first).

get_log(d::ReactionPathDiagram)

Diagnostic log accumulated while building the diagram.

normal_threshold(d::ReactionPathDiagram)

Maximum relative flux for dashed lines.

arrow_width(d::ReactionPathDiagram)

Arrow width; if negative, arrows scale with the flux value instead.

scale(d::ReactionPathDiagram)

Scaling factor for the fluxes; -1 normalizes by the maximum net flux.

threshold(d::ReactionPathDiagram)

Minimum relative flux value that will be plotted.

label_threshold(d::ReactionPathDiagram)

Minimum relative flux for labels.

bold_threshold(d::ReactionPathDiagram)

Minimum relative flux for bold lines.

set_scale!(d::ReactionPathDiagram, v::Real)

Set scale.

set_threshold!(d::ReactionPathDiagram, v::Real)

Set threshold.

set_label_threshold!(d::ReactionPathDiagram, v::Real)

Set label_threshold.

set_bold_threshold!(d::ReactionPathDiagram, v::Real)

Set bold_threshold.

set_normal_threshold!(d::ReactionPathDiagram, v::Real)

Set normal_threshold.

set_arrow_width!(d::ReactionPathDiagram, v::Real)

Set arrow_width.

font(d::ReactionPathDiagram)

Font used for the diagram.

dot_options(d::ReactionPathDiagram)

Options passed through to the dot program.

flow_type(d::ReactionPathDiagram)

Way flows are drawn: "NetFlow" or "OneWayFlow".

bold_color(d::ReactionPathDiagram)

Color for bold lines.

normal_color(d::ReactionPathDiagram)

Color for normal-weight lines.

dashed_color(d::ReactionPathDiagram)

Color for dashed lines.

title(d::ReactionPathDiagram)

Reaction path diagram title.

set_title!(d::ReactionPathDiagram, v::AbstractString)

Set title.

set_bold_color!(d::ReactionPathDiagram, v::AbstractString)

Set bold_color.

set_dot_options!(d::ReactionPathDiagram, v::AbstractString)

Set dot_options.

set_flow_type!(d::ReactionPathDiagram, v::AbstractString)

Set flow_type.

set_font!(d::ReactionPathDiagram, v::AbstractString)

Set font.

set_normal_color!(d::ReactionPathDiagram, v::AbstractString)

Set normal_color.

set_dashed_color!(d::ReactionPathDiagram, v::AbstractString)

Set dashed_color.

show_details(d::ReactionPathDiagram)

Whether reaction details are shown as edge labels.

set_show_details!(d::ReactionPathDiagram, v::Bool)

Enable or disable showing reaction details as edge labels.

display_only!(d::ReactionPathDiagram, species_index)

Restrict the diagram to flows into/out of a single species (1-based index), or pass :all (or a negative index) to show all species again.

Show Source