deploy: 4cc59c8

previews/PR517/developments/julia_structs.html

@@ -277,16 +277,21 @@ <h1 class="title">Julia structures</h1>
 <section id="model" class="level2">
 <h2 class="anchored" data-anchor-id="model">Model</h2>
 <p>Below the composite type that represents all different aspects of a <code>Wflow.Model</code>, such as the network, parameters, clock, model type, configuration and input and output.</p>
-<div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">struct</span> Model{L,V,R,W,T}</span>
-<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>    config<span class="op">::</span><span class="dt">Config   </span><span class="co"># all configuration options</span></span>
-<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a>    network<span class="op">::</span><span class="dt">Network </span><span class="co"># connectivity information, directed graph</span></span>
-<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a>    lateral<span class="op">::</span><span class="dt">L       </span><span class="co"># lateral model that holds lateral state, moves along network</span></span>
-<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a>    vertical<span class="op">::</span><span class="dt">V      </span><span class="co"># vertical model that holds vertical state, independent of each other</span></span>
-<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a>    clock<span class="op">::</span><span class="dt">Clock     </span><span class="co"># to keep track of simulation time</span></span>
-<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a>    reader<span class="op">::</span><span class="dt">R        </span><span class="co"># provides the model with dynamic input</span></span>
-<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a>    writer<span class="op">::</span><span class="dt">W        </span><span class="co"># writes model output</span></span>
-<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a>    <span class="kw">type</span><span class="op">::</span><span class="dt">T          </span><span class="co"># model type</span></span>
-<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a><span class="kw">end</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
+<div class="sourceCode" id="cb1"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">struct</span> Model{</span>
+<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a>    L <span class="op">&lt;:</span><span class="dt"> Lateral</span>,</span>
+<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a>    V <span class="op">&lt;:</span><span class="dt"> AbstractLandSurface</span>,</span>
+<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a>    R <span class="op">&lt;:</span><span class="dt"> NCReader</span>,</span>
+<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a>    T <span class="op">&lt;:</span><span class="dt"> AbstractModelType</span>,</span>
+<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a>} <span class="op">&lt;:</span><span class="dt"> AbstractModel{T}</span></span>
+<span id="cb1-7"><a href="#cb1-7" aria-hidden="true" tabindex="-1"></a>    config<span class="op">::</span><span class="dt">Config    </span><span class="co"># all configuration options</span></span>
+<span id="cb1-8"><a href="#cb1-8" aria-hidden="true" tabindex="-1"></a>    network<span class="op">::</span><span class="dt">Network  </span><span class="co"># connectivity information, directed graph</span></span>
+<span id="cb1-9"><a href="#cb1-9" aria-hidden="true" tabindex="-1"></a>    lateral<span class="op">::</span><span class="dt">L        </span><span class="co"># lateral model that holds lateral state, moves along network</span></span>
+<span id="cb1-10"><a href="#cb1-10" aria-hidden="true" tabindex="-1"></a>    vertical<span class="op">::</span><span class="dt">V       </span><span class="co"># vertical model that holds vertical state, independent of each other</span></span>
+<span id="cb1-11"><a href="#cb1-11" aria-hidden="true" tabindex="-1"></a>    clock<span class="op">::</span><span class="dt">Clock      </span><span class="co"># to keep track of simulation time</span></span>
+<span id="cb1-12"><a href="#cb1-12" aria-hidden="true" tabindex="-1"></a>    reader<span class="op">::</span><span class="dt">R         </span><span class="co"># provides the model with dynamic input</span></span>
+<span id="cb1-13"><a href="#cb1-13" aria-hidden="true" tabindex="-1"></a>    writer<span class="op">::</span><span class="dt">Writer    </span><span class="co"># writes model output</span></span>
+<span id="cb1-14"><a href="#cb1-14" aria-hidden="true" tabindex="-1"></a>    <span class="kw">type</span><span class="op">::</span><span class="dt">T           </span><span class="co"># model type</span></span>
+<span id="cb1-15"><a href="#cb1-15" aria-hidden="true" tabindex="-1"></a><span class="kw">end</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
 <p>The <code>lateral</code> field of the <code>struct Model</code> can contain different lateral concepts. For each wflow model these different lateral concepts are mapped through the use of a <code>NamedTuple</code>. The <code>vertical</code> field of the <code>struct Model</code> always contains one vertical concept, for example the SBM vertical concept.</p>
 <p>Below an example how lateral concepts are mapped for the SBM model through a <code>NamedTuple</code>:</p>
 <div class="sourceCode" id="cb2"><pre class="sourceCode julia code-with-copy"><code class="sourceCode julia"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>(subsurface <span class="op">=</span> ssf, land <span class="op">=</span> olf, river <span class="op">=</span> rf)</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>

previews/PR517/search.json

@@ -719,7 +719,7 @@
     "href": "developments/julia_structs.html",
     "title": "Julia structures",
     "section": "",
-    "text": "Below the composite type that represents all different aspects of a Wflow.Model, such as the network, parameters, clock, model type, configuration and input and output.\nstruct Model{L,V,R,W,T}\n    config::Config   # all configuration options\n    network::Network # connectivity information, directed graph\n    lateral::L       # lateral model that holds lateral state, moves along network\n    vertical::V      # vertical model that holds vertical state, independent of each other\n    clock::Clock     # to keep track of simulation time\n    reader::R        # provides the model with dynamic input\n    writer::W        # writes model output\n    type::T          # model type\nend\nThe lateral field of the struct Model can contain different lateral concepts. For each wflow model these different lateral concepts are mapped through the use of a NamedTuple. The vertical field of the struct Model always contains one vertical concept, for example the SBM vertical concept.\nBelow an example how lateral concepts are mapped for the SBM model through a NamedTuple:\n(subsurface = ssf, land = olf, river = rf)\nThe subsurface part is mapped to the lateral subsurface flow kinematic wave concept, the land part is mapped the overland flow kinematic wave concept and the river part is mapped to the river flow kinematic wave concept. Knowledge of this specific mapping is required to understand and correctly set input, output and state variables in the TOML configuration file, see also Config and TOML. This mapping is described in more detail for each model in the section Models. Also the struct of each mapped concept is provided, so one can check the internal variables in the code. These structs are defined as a parametric composite type, with type parameters between curly braces after the struct name. See also the next paragraph Vertical and lateral models for a more detailed description.",
+    "text": "Below the composite type that represents all different aspects of a Wflow.Model, such as the network, parameters, clock, model type, configuration and input and output.\nstruct Model{\n    L <: Lateral,\n    V <: AbstractLandSurface,\n    R <: NCReader,\n    T <: AbstractModelType,\n} <: AbstractModel{T}\n    config::Config    # all configuration options\n    network::Network  # connectivity information, directed graph\n    lateral::L        # lateral model that holds lateral state, moves along network\n    vertical::V       # vertical model that holds vertical state, independent of each other\n    clock::Clock      # to keep track of simulation time\n    reader::R         # provides the model with dynamic input\n    writer::Writer    # writes model output\n    type::T           # model type\nend\nThe lateral field of the struct Model can contain different lateral concepts. For each wflow model these different lateral concepts are mapped through the use of a NamedTuple. The vertical field of the struct Model always contains one vertical concept, for example the SBM vertical concept.\nBelow an example how lateral concepts are mapped for the SBM model through a NamedTuple:\n(subsurface = ssf, land = olf, river = rf)\nThe subsurface part is mapped to the lateral subsurface flow kinematic wave concept, the land part is mapped the overland flow kinematic wave concept and the river part is mapped to the river flow kinematic wave concept. Knowledge of this specific mapping is required to understand and correctly set input, output and state variables in the TOML configuration file, see also Config and TOML. This mapping is described in more detail for each model in the section Models. Also the struct of each mapped concept is provided, so one can check the internal variables in the code. These structs are defined as a parametric composite type, with type parameters between curly braces after the struct name. See also the next paragraph Vertical and lateral models for a more detailed description.",
     "crumbs": [
       "Developments",
       "Julia structures"
@@ -730,7 +730,7 @@
     "href": "developments/julia_structs.html#model",
     "title": "Julia structures",
     "section": "",
-    "text": "Below the composite type that represents all different aspects of a Wflow.Model, such as the network, parameters, clock, model type, configuration and input and output.\nstruct Model{L,V,R,W,T}\n    config::Config   # all configuration options\n    network::Network # connectivity information, directed graph\n    lateral::L       # lateral model that holds lateral state, moves along network\n    vertical::V      # vertical model that holds vertical state, independent of each other\n    clock::Clock     # to keep track of simulation time\n    reader::R        # provides the model with dynamic input\n    writer::W        # writes model output\n    type::T          # model type\nend\nThe lateral field of the struct Model can contain different lateral concepts. For each wflow model these different lateral concepts are mapped through the use of a NamedTuple. The vertical field of the struct Model always contains one vertical concept, for example the SBM vertical concept.\nBelow an example how lateral concepts are mapped for the SBM model through a NamedTuple:\n(subsurface = ssf, land = olf, river = rf)\nThe subsurface part is mapped to the lateral subsurface flow kinematic wave concept, the land part is mapped the overland flow kinematic wave concept and the river part is mapped to the river flow kinematic wave concept. Knowledge of this specific mapping is required to understand and correctly set input, output and state variables in the TOML configuration file, see also Config and TOML. This mapping is described in more detail for each model in the section Models. Also the struct of each mapped concept is provided, so one can check the internal variables in the code. These structs are defined as a parametric composite type, with type parameters between curly braces after the struct name. See also the next paragraph Vertical and lateral models for a more detailed description.",
+    "text": "Below the composite type that represents all different aspects of a Wflow.Model, such as the network, parameters, clock, model type, configuration and input and output.\nstruct Model{\n    L <: Lateral,\n    V <: AbstractLandSurface,\n    R <: NCReader,\n    T <: AbstractModelType,\n} <: AbstractModel{T}\n    config::Config    # all configuration options\n    network::Network  # connectivity information, directed graph\n    lateral::L        # lateral model that holds lateral state, moves along network\n    vertical::V       # vertical model that holds vertical state, independent of each other\n    clock::Clock      # to keep track of simulation time\n    reader::R         # provides the model with dynamic input\n    writer::Writer    # writes model output\n    type::T           # model type\nend\nThe lateral field of the struct Model can contain different lateral concepts. For each wflow model these different lateral concepts are mapped through the use of a NamedTuple. The vertical field of the struct Model always contains one vertical concept, for example the SBM vertical concept.\nBelow an example how lateral concepts are mapped for the SBM model through a NamedTuple:\n(subsurface = ssf, land = olf, river = rf)\nThe subsurface part is mapped to the lateral subsurface flow kinematic wave concept, the land part is mapped the overland flow kinematic wave concept and the river part is mapped to the river flow kinematic wave concept. Knowledge of this specific mapping is required to understand and correctly set input, output and state variables in the TOML configuration file, see also Config and TOML. This mapping is described in more detail for each model in the section Models. Also the struct of each mapped concept is provided, so one can check the internal variables in the code. These structs are defined as a parametric composite type, with type parameters between curly braces after the struct name. See also the next paragraph Vertical and lateral models for a more detailed description.",
     "crumbs": [
       "Developments",
       "Julia structures"