Recommended improvements for section 'Reference' at Ribasim.org #2793
Description
Overview_nodes_links_Ribasim.xlsx
- Reference - Usage: In the code it says 'flow boundary = block. #optional, default block, can otherwise be linear'. However, lower down under Interpolation settings, it says lineair is the default. So which is the default? Change accordingly to make consistent.
- Reference - Usage: Under 3. Node > What happens if the ID of the nodes is not unique? Will it not run, or will it still run, but then the results are flawed? Perhaps add sentence on this. Same for subnetwork > What happens if there are double id's?
- Reference - Usage: Under 4.Link it says 'Control links should always point away from the control or demand node'. Do you mean with point away that it should always be downstream of these nodes? I don't fully understand with point away what is meant. EDIT: not downstream, because there is no flow over control links
- Reference - Results: In section 5.2 it says: 'The convergence is the scaled residual of the solver, giving an indication of which nodes converge the worst (are hardest to solve).'. Does a higher value then indicate a harder solve? And what kind of values can you expect here? EDIT: yes
- Reference - Results: What do control state and truth state mean? What does a value here mean then? I have no image of this… EDIT: add link to DiscreteControl reference docs
- Reference - Results: Under 5.7 and 5.8 it both says: 'When an allocation optimization problem turns out to be infeasible, a ... analysis is performed'. So these are both performed then? But then under 5.8 it says again: 'For details on the infeasibility analysis see here.' Is here the scaling feasibility meant? EDIT: these are two separate analyses, make this clear in the docs
- Reference - Nodes Basin: Section describes: ''While the term “Basin” may traditionally suggest a watershed, in this context, it serves as a wide range of water bodies and control volumes, including those that may not conform to the typical geographical definition of a basin.'' Could you include several examples here of those that do not conform typically, such as e.g. reservoirs, canals.
- Reference - Nodes Basin: For all tables it would be convenient to know whether they are mandatory to be filled in, or whether they can be left empty. Or do they all need to be filled in, but with empty values? Nowhere specified I believe. EDIT: for optional columns under restriction it says (optional), check if these are up to date with the schemas everywhere.
- Reference - Nodes Pump: PID controlled > What is PID? Give meaning.
- Reference - Nodes FlowDemand: Is flowdemand node used also for minimal environmental flow? Otherwise state this function here as well. EDIT: yes
- Reference - Nodes General: In general, start with giving an overview table of all the nodes available, explanation, downstream information.
- Reference - General structure: Restructuring is needed here I think to ensure all information related to nodes and links is bundled and well organized. See issue Recommended improvements for current Section 'Overview' at ribasim.org #2788 .
- Reference - General: Improvements for small text mistakes:
- Under 3.2. Subnetwork ID (add Y)> Nodes can only be controlled by allocation if theY have a subnetwork_id.
- Under 4. Link (N needs to go) > The only thing that defines aN link.
- Under Nodes-TabulatedRatingCurve (remove for) > 'Now this tabulated rating curve node has a flow rate of 8.0 for for all levels 13.0 or higher'. Also here (remove d) > 'you can use and Outlet with a control node to set flow rates.'
- Under Nodes-FlowBoundary (remove n) > 'We require that an link connected to a FlowBoundary is always outgoing'.
- Reference - general: The node section would benefit I believe from two additions still for understanding:
- To have a short section on possibilities how to model a reservoir with the presented nodes; present the multiple options to do so
- to know which nodes are 'interchangeable'. So what I mean and not sure if I am fully correct here: Outlet and pump are alternatives for each other; LinearResistance and ManningResistance are too; DiscreteControl and ContiniousControl are too.