Skip to content

Commit

Permalink
Update model struct in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SouthEndMusic committed Dec 10, 2024
1 parent 3d14d21 commit c8805f1
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions docs/developments/julia_structs.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,20 @@ Below the composite type that represents all different aspects of a `Wflow.Model
network, parameters, clock, model type, configuration and input and output.

```julia
struct Model{L,V,R,W,T}
config::Config # all configuration options
network::Network # connectivity information, directed graph
lateral::L # lateral model that holds lateral state, moves along network
vertical::V # vertical model that holds vertical state, independent of each other
clock::Clock # to keep track of simulation time
reader::R # provides the model with dynamic input
writer::W # writes model output
type::T # model type
struct Model{
L <: Lateral,
V <: AbstractLandSurface,
R <: NCReader,
T <: AbstractModelType,
} <: AbstractModel{T}
config::Config # all configuration options
network::Network # connectivity information, directed graph
lateral::L # lateral model that holds lateral state, moves along network
vertical::V # vertical model that holds vertical state, independent of each other
clock::Clock # to keep track of simulation time
reader::R # provides the model with dynamic input
writer::Writer # writes model output
type::T # model type
end
```

Expand Down

0 comments on commit c8805f1

Please sign in to comment.