Skip to content

Commit

Permalink
allow default_processes_eqs
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Jul 14, 2024
1 parent 61381cc commit 77a24ea
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ProcessBasedModelling"
uuid = "ca969041-2cf3-4b10-bc21-86f4417093eb"
authors = ["Datseris <datseris.george@gmail.com>"]
version = "1.2.3"
version = "1.2.4"

[deps]
ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
Expand Down
1 change: 1 addition & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ when developing a field-specific library.
processes_to_mtkmodel
register_default_process!
default_processes
default_processes_eqs
```

## [Predefined `Process` subtypes](@id predefined_processes)
Expand Down
16 changes: 15 additions & 1 deletion src/default.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export register_default_process!, default_processes
export register_default_process!, default_processes, default_processes_eqs

const _DEFAULT_PROCESSES = Dict{Module, Dict}()

Expand Down Expand Up @@ -50,10 +50,24 @@ end
default_processes(m::Module)
Return the dictionary of default processes tracked by the given module.
See also [`default_processes_eqs`](@ref).
"""
function default_processes(m::Module)
if !haskey(_DEFAULT_PROCESSES, m)
_DEFAULT_PROCESSES[m] = Dict{Num}{Any}()
end
return _DEFAULT_PROCESSES[m]
end

"""
default_processes_eqs(m::Module)
Same as [`default_processes`](@ref), but return the equations
of all processes in a vector format, which is rendered as LaTeX
in Markdown to HTML processing by e.g., Documenter.jl.
"""
function default_processes_eqs(m::Module)
d = default_processes(m)
eqs = [lhs(proc) ~ rhs(proc) for proc in values(d)]
return eqs
end

0 comments on commit 77a24ea

Please sign in to comment.