Library Reference
DiagrammaticEquations.DiagrammaticEquations — ModuleSome description of ths package
Catlab.WiringDiagrams.WiringDiagramAlgebras.oapply — Methodfunction oapply(relation::RelationDiagram, podes::Vector{D}) where {D<:OpenSummationDecapode}Compose a list of Decapodes as specified by the given relation diagram.
The Decapodes must be given in the same order as they were specified in the relation.
State variables (such as the (C,V) given in the head of the following @relation) do not affect the result of a composition.
Examples
julia> compose_diff_adv = @relation (C,V) begin
+Library Reference · DE.jl Library Reference
DiagrammaticEquations.DiagrammaticEquations — ModuleSome description of ths package
sourceCatlab.WiringDiagrams.WiringDiagramAlgebras.oapply — Methodfunction oapply(relation::RelationDiagram, podes::Vector{D}) where {D<:OpenSummationDecapode}
Compose a list of Decapodes as specified by the given relation diagram.
The Decapodes must be given in the same order as they were specified in the relation.
State variables (such as the (C,V) given in the head of the following @relation) do not affect the result of a composition.
Examples
julia> compose_diff_adv = @relation (C,V) begin
diffusion(C, ϕ₁)
advection(C, ϕ₂, V)
superposition(ϕ₁, ϕ₂, ϕ, C)
end;
julia> oapply(compose_diff_adv, [(Diffusion, [:C, :ϕ]),
- (Advection, [:C, :ϕ, :V]), (Superposition, [:ϕ₁, :ϕ₂, :ϕ, :C])]);
sourceDiagrammaticEquations.Open — MethodOpen(d::SummationDecapode{T,U,V}, names::AbstractVector{Symbol}) where {T,U,V}
creates an OpenSummationDecapode based on named variables rather than variable indices. See AlgebraicPetri.jl's Open for the analogous verion for LabelledReactionNetworks.
sourceDiagrammaticEquations.average_rewrite — Methodfunction average_rewrite(deca_source::SummationDecapode)
Compute each quantitity in the given Decapode by the average of all computation paths leading to that node.
sourceDiagrammaticEquations.collate — Methodfunction collate(equations, boundaries, uwd, symbols)
Create a collage of two Decapodes that simulates with boundary conditions. ```
sourceDiagrammaticEquations.contract_operators — Methodfunction contract_operators(d::SummationDecapode)
Find chains of Op1s in the given Decapode, and replace them with a single Op1 with a vector of function names. After this process, all Vars that are not a part of any computation are removed.
sourceDiagrammaticEquations.dot_rename! — Methoddot_rename!(d::AbstractNamedDecapode)
Rename tangent variables by their depending variable appended with a dot. e.g. If D == ∂ₜ(C), then rename D to Ċ.
If a tangent variable updates multiple vars, choose one arbitrarily. e.g. If D == ∂ₜ(C) and D == ∂ₜ(B), then rename D to either Ċ or B ̇.
sourceDiagrammaticEquations.expand_operators — Methodfunction expand_operators(d::SummationDecapode)
Find operations that are compositions, and expand them with intermediate variables.
sourceDiagrammaticEquations.fill_names! — Methodfill_names!(d::AbstractNamedDecapode)
Provide a variable name to all the variables that don't have names.
sourceDiagrammaticEquations.find_dep_and_order — Methodfind_dep_and_order(d::AbstractNamedDecapode)
Find the order of each tangent variable in the Decapode, and the index of the variable that it is dependent on. Returns a tuple of (dep, order), both of which respecting the order in which incident(d, :∂ₜ, :op1) returns Vars.
sourceDiagrammaticEquations.infer_types! — Methodfunction infer_types!(d::SummationDecapode, op1_rules::Vector{NamedTuple{(:src_type, :tgt_type, :replacement_type, :op), NTuple{4, Symbol}}})
Infer types of Vars given rules wherein one type is known and the other not.
sourceDiagrammaticEquations.remove_neighborless_vars! — Methodfunction remove_neighborless_vars!(d::SummationDecapode)
Remove all Vars from the given Decapode that are not part of any computation.
sourceDiagrammaticEquations.resolve_overloads! — Methodfunction resolve_overloads!(d::SummationDecapode, op1_rules::Vector{NamedTuple{(:src_type, :tgt_type, :resolved_name, :op), NTuple{4, Symbol}}})
Resolve function overloads based on types of src and tgt.
sourceDiagrammaticEquations.type_check_Decapodes_composition — Methodfunction type_check_Decapodes_composition(relation::RelationDiagram, decs::Vector{OpenSummationDecapode})
Check that the types of all Vars connected by the same junction match.
This function only throws an error on the first type mismatch found.
sourceDiagrammaticEquations.unique_by! — Methodfunction unique_by!(acset, column_names::Vector{Symbol})
Given column names from the same table, remove duplicate rows.
WARNING: This function does not check if other tables index into the one given. Removal of rows is performed with prejudice.
See also: unique_by.
Examples
julia> unique_by!(parallel_arrows(Graph, 123), :E, [:src,:tgt]) == parallel_arrows(Graph, 1)
-true
sourceDiagrammaticEquations.unique_by — Methodfunction unique_by(acset, column_names::Vector{Symbol})
Given column names from the same table, return a copy of the acset with duplicate rows removed. Removal of rows is performed with prejudice.
WARNING: This function does not check if other tables index into the one given. Removal of rows is performed with prejudice.
See also: unique_by!.
Examples
julia> unique_by(parallel_arrows(Graph, 123), :E, [:src,:tgt]) == parallel_arrows(Graph, 1)
-true
sourceDiagrammaticEquations.@decapode — Macromacro Decapode(e)
Construct a Decapode.
sourceDiagrammaticEquations.Deca.op1_inf_rules_1D — ConstantThese are the default rules used to do type inference in the 1D exterior calculus.
sourceDiagrammaticEquations.Deca.op1_inf_rules_2D — ConstantThese are the default rules used to do type inference in the 2D exterior calculus.
sourceDiagrammaticEquations.Deca.op1_res_rules_1D — ConstantThese are the default rules used to do function resolution in the 1D exterior calculus.
sourceDiagrammaticEquations.Deca.op1_res_rules_2D — ConstantThese are the default rules used to do function resolution in the 2D exterior calculus.
sourceCatlab.Graphics.GraphvizGraphs.to_graphviz — MethodGraphics.to_graphviz(F::AbstractDecapode; directed = true, kw...)
Visualize the given Decapode through Graphviz. Ensure that you have called using Catlab.Graphics before-hand, and have a way of visualizing SVG files in your current environment.
sourceDiagrammaticEquations.Deca.recursive_delete_parents — Methodfunction recursive_delete_parents!(d::SummationDecapode, to_delete::Vector{Int64})
Delete the given nodes and their parents in the Decapode, recursively.
sourceDiagrammaticEquations.Deca.unicode! — Methodfunction unicode!(d::SummationDecapode)
Replace ASCII operators with their Unicode equivalents.
sourceDiagrammaticEquations.Deca.vec_to_dec! — Methodfunction vec_to_dec!(d::SummationDecapode)
Replace Vector Calculus operators with Discrete Exterior Calculus equivalents.
sourceDiagrammaticEquations.resolve_overloads! — Methodfunction resolve_overloads!(d::SummationDecapode)
Resolve function overloads based on types of src and tgt.
sourceSettings
This document was generated with Documenter.jl version 1.2.1 on Wednesday 20 December 2023. Using Julia version 1.9.4.
DiagrammaticEquations.Open — MethodOpen(d::SummationDecapode{T,U,V}, names::AbstractVector{Symbol}) where {T,U,V}creates an OpenSummationDecapode based on named variables rather than variable indices. See AlgebraicPetri.jl's Open for the analogous verion for LabelledReactionNetworks.
DiagrammaticEquations.average_rewrite — Methodfunction average_rewrite(deca_source::SummationDecapode)Compute each quantitity in the given Decapode by the average of all computation paths leading to that node.
DiagrammaticEquations.collate — Methodfunction collate(equations, boundaries, uwd, symbols)Create a collage of two Decapodes that simulates with boundary conditions. ```
DiagrammaticEquations.contract_operators — Methodfunction contract_operators(d::SummationDecapode)Find chains of Op1s in the given Decapode, and replace them with a single Op1 with a vector of function names. After this process, all Vars that are not a part of any computation are removed.
DiagrammaticEquations.dot_rename! — Methoddot_rename!(d::AbstractNamedDecapode)Rename tangent variables by their depending variable appended with a dot. e.g. If D == ∂ₜ(C), then rename D to Ċ.
If a tangent variable updates multiple vars, choose one arbitrarily. e.g. If D == ∂ₜ(C) and D == ∂ₜ(B), then rename D to either Ċ or B ̇.
DiagrammaticEquations.expand_operators — Methodfunction expand_operators(d::SummationDecapode)Find operations that are compositions, and expand them with intermediate variables.
DiagrammaticEquations.fill_names! — Methodfill_names!(d::AbstractNamedDecapode)Provide a variable name to all the variables that don't have names.
DiagrammaticEquations.find_dep_and_order — Methodfind_dep_and_order(d::AbstractNamedDecapode)Find the order of each tangent variable in the Decapode, and the index of the variable that it is dependent on. Returns a tuple of (dep, order), both of which respecting the order in which incident(d, :∂ₜ, :op1) returns Vars.
DiagrammaticEquations.infer_types! — Methodfunction infer_types!(d::SummationDecapode, op1_rules::Vector{NamedTuple{(:src_type, :tgt_type, :replacement_type, :op), NTuple{4, Symbol}}})Infer types of Vars given rules wherein one type is known and the other not.
DiagrammaticEquations.remove_neighborless_vars! — Methodfunction remove_neighborless_vars!(d::SummationDecapode)Remove all Vars from the given Decapode that are not part of any computation.
DiagrammaticEquations.resolve_overloads! — Methodfunction resolve_overloads!(d::SummationDecapode, op1_rules::Vector{NamedTuple{(:src_type, :tgt_type, :resolved_name, :op), NTuple{4, Symbol}}})Resolve function overloads based on types of src and tgt.
DiagrammaticEquations.type_check_Decapodes_composition — Methodfunction type_check_Decapodes_composition(relation::RelationDiagram, decs::Vector{OpenSummationDecapode})Check that the types of all Vars connected by the same junction match.
This function only throws an error on the first type mismatch found.
DiagrammaticEquations.unique_by! — Methodfunction unique_by!(acset, column_names::Vector{Symbol})Given column names from the same table, remove duplicate rows.
WARNING: This function does not check if other tables index into the one given. Removal of rows is performed with prejudice.
See also: unique_by.
Examples
julia> unique_by!(parallel_arrows(Graph, 123), :E, [:src,:tgt]) == parallel_arrows(Graph, 1)
+trueDiagrammaticEquations.unique_by — Methodfunction unique_by(acset, column_names::Vector{Symbol})Given column names from the same table, return a copy of the acset with duplicate rows removed. Removal of rows is performed with prejudice.
WARNING: This function does not check if other tables index into the one given. Removal of rows is performed with prejudice.
See also: unique_by!.
Examples
julia> unique_by(parallel_arrows(Graph, 123), :E, [:src,:tgt]) == parallel_arrows(Graph, 1)
+trueDiagrammaticEquations.@decapode — Macromacro Decapode(e)Construct a Decapode.
DiagrammaticEquations.Deca.op1_inf_rules_1D — ConstantThese are the default rules used to do type inference in the 1D exterior calculus.
DiagrammaticEquations.Deca.op1_inf_rules_2D — ConstantThese are the default rules used to do type inference in the 2D exterior calculus.
DiagrammaticEquations.Deca.op1_res_rules_1D — ConstantThese are the default rules used to do function resolution in the 1D exterior calculus.
DiagrammaticEquations.Deca.op1_res_rules_2D — ConstantThese are the default rules used to do function resolution in the 2D exterior calculus.
Catlab.Graphics.GraphvizGraphs.to_graphviz — MethodGraphics.to_graphviz(F::AbstractDecapode; directed = true, kw...)Visualize the given Decapode through Graphviz. Ensure that you have called using Catlab.Graphics before-hand, and have a way of visualizing SVG files in your current environment.
DiagrammaticEquations.Deca.recursive_delete_parents — Methodfunction recursive_delete_parents!(d::SummationDecapode, to_delete::Vector{Int64})Delete the given nodes and their parents in the Decapode, recursively.
DiagrammaticEquations.Deca.unicode! — Methodfunction unicode!(d::SummationDecapode)Replace ASCII operators with their Unicode equivalents.
DiagrammaticEquations.Deca.vec_to_dec! — Methodfunction vec_to_dec!(d::SummationDecapode)Replace Vector Calculus operators with Discrete Exterior Calculus equivalents.
DiagrammaticEquations.resolve_overloads! — Methodfunction resolve_overloads!(d::SummationDecapode)Resolve function overloads based on types of src and tgt.