linny-r 1.9.3 → 2.0.2

package/static/scripts/linny-r-gui-file-manager.js

@@ -11,7 +11,7 @@ functionality for the Linny-R File Manager.
 */
 
 /*
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -49,6 +49,14 @@ class GUIFileManager {
   getRemoteData(dataset, url) {
     // Gets data from a URL, or from a file on the local host 
     if(url === '') return;
+    if(url.indexOf('%') >= 0) {
+      // Expand %i, %j and %k if used in the URL.
+      const letters = ['i', 'j', 'k'];
+      for(let i = 0; i < letters.length; i++) {
+        const l = letters[i];
+        url = url.replaceAll('%' + l, valueOfIndexVariable(l));
+      }
+    }
     // NOTE: add this dataset to the "loading" list...
     addDistinct(dataset, MODEL.loading_datasets);
     // ... and allow for 3 more seconds (6 times 500 ms) to complete
@@ -63,19 +71,29 @@ class GUIFileManager {
         })
       .then((data) => {
           if(data !== '' && UI.postResponseOK(data)) {
-            // Server must return either semicolon-separated or
-            // newline-separated string of numbers
-            if(data.indexOf(';') < 0) {
-              // If no semicolon found, replace newlines by semicolons
-              data = data.trim().split('\n').join(';');
-            }
-            // Remove all white space
-            data = data.replace(/\s+/g, '');
-            // Show data in text area when the SERIES dialog is visible
-            if(!UI.hidden('series-modal')) {
-              DATASET_MANAGER.series_data.value = data.split(';').join('\n');
+            if(dataset instanceof BoundLine) {
+              // Server must return semicolon-separated list of white-
+              // space-separated list of numbers.
+              dataset.unpackPointDataString(data);
+              // Show data in boundline data modal when it is visible.
+              if(!UI.hidden('boundline-data-modal')) {
+                CONSTRAINT_EDITOR.stopEditing(false);
+              }
             } else {
-              dataset.unpackDataString(data);
+              // Server must return either semicolon-separated or
+              // newline-separated string of numbers
+              if(data.indexOf(';') < 0) {
+                // If no semicolon found, replace newlines by semicolons
+                data = data.trim().split('\n').join(';');
+              }
+              // Remove all white space
+              data = data.replace(/\s+/g, '');
+              // Show data in text area when the SERIES dialog is visible
+              if(!UI.hidden('series-modal')) {
+                DATASET_MANAGER.series_data.value = data.split(';').join('\n');
+              } else {
+                dataset.unpackDataString(data);
+              }
             }
             // NOTE: remove dataset from the "loading" list
             const i = MODEL.loading_datasets.indexOf(dataset);
@@ -235,7 +253,12 @@ class GUIFileManager {
     code.focus();
   }
   
-  saveModel() {
+  saveModel(ws=false) {
+    // Save the current model either as a download (directly from the browser),
+    // or in the user workspace (via the server) when the Save button is
+    // Shift-clicked.
+    // NOTE: The File manager keeps track of which option to use.
+    this.save_to_workspace = ws;
     MODEL.clearSelection();
     if(MODEL.encrypt) {
       const md = UI.modals.password;
@@ -252,7 +275,17 @@ class GUIFileManager {
   }
   
   pushModelToBrowser(xml) {
+    // Save model as .lnr file.
     UI.setMessage('Model file size: ' + UI.sizeInBytes(xml.length));
+    // NOTE: Since version 2.0.2, Shift-click on the Save button means
+    // that the model should be saved in the user workspace.
+    if(this.save_to_workspace) {
+      // Immediately reset the flag...
+      this.save_to_workspace = false;
+      // ... but pass is on to the auto-save routine.
+      this.storeAutoSavedModel(true);
+      return;
+    }
     const el = document.getElementById('xml-saver');
     el.href = 'data:attachment/text,' + encodeURI(xml);
     console.log('Encoded file size:', el.href.length);
@@ -263,6 +296,9 @@ class GUIFileManager {
           'If it does not download, store it in a repository');
     }
     el.click();
+    // Clear the HREF after 3 seconds or it may use a lot of memory.
+    setTimeout(
+        () => { document.getElementById('xml-saver').href = ''; }, 3000);
     UI.normalCursor();
   }
   
@@ -271,7 +307,7 @@ class GUIFileManager {
         md = UI.modals.password,
         code = md.element('code'),
         pwd = code.value;
-    // NOTE: immediately clear password field
+    // NOTE: Immediately clear password field.
     code.value = '';
     md.hide();
     if(pwd !== md.encryption_code) {
@@ -280,7 +316,7 @@ class GUIFileManager {
     }
     UI.setMessage('Encrypting...');
     UI.waitingCursor();
-    // Wait for key (NOTE: asynchronous functions defined in linny-r.js)
+    // Wait for key (NOTE: asynchronous functions defined in linny-r.js).
     encryptionKey(pwd)
       .then((key) => encryptMessage(MODEL.asXML.replace(/#/g, '%23'), key)
           .then((enc) => this.pushModelToBrowser(MODEL.asEncryptedXML(enc)))
@@ -311,8 +347,12 @@ class GUIFileManager {
       .catch((err) => UI.warn(UI.WARNING.NO_CONNECTION, err));
   }
 
-  storeAutoSavedModel() {
-    // Stores the current model in the local auto-save directory
+  storeAutoSavedModel(workspace=false) {
+    // Store the current model in the local auto-save directory, or in
+    // the local models directory when `workspace` = TRUE.
+    // NOTE: Always reset the "save to workspace" flag, because it may
+    // have not been cleared when the user canceled encryption.
+    this.save_to_workspace = false;
     const bcl = document.getElementById('autosave-btn').classList;
     if(MODEL.running_experiment) {
       console.log('No autosaving while running an experiment');
@@ -324,7 +364,8 @@ class GUIFileManager {
           file: REPOSITORY_BROWSER.asFileName(
               (MODEL.name || 'no-name') + '_by_' +
                   (MODEL.author || 'no-author')),
-          xml: MODEL.asXML
+          xml: MODEL.asXML,
+          wsd: workspace
         }))
       .then((response) => {
           if(!response.ok) {
@@ -338,6 +379,9 @@ class GUIFileManager {
             AUTO_SAVE.interval = 0;
             AUTO_SAVE.not_implemented = true;
             console.log('Auto-save disabled');
+          } else if(workspace) {
+            // Notify user where the model file has been stored.
+            UI.notify(data);
           }
           bcl.remove('stay-activ');
         })

package/static/scripts/linny-r-gui-finder.js

@@ -13,7 +13,7 @@ model.
 */
 
 /*
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/static/scripts/linny-r-gui-model-autosaver.js

@@ -12,7 +12,7 @@ dialogs, the main drawing canvas, and event handler functions.
 */
 
 /*
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/static/scripts/linny-r-gui-monitor.js

@@ -11,7 +11,7 @@ for the Linny-R Monitor dialog.
 */
 
 /*
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/static/scripts/linny-r-gui-paper.js

@@ -11,7 +11,7 @@ functionality for the Linny-R model editor.
 */
 
 /*
-Copyright (c) 2017-2023 Delft University of Technology
+Copyright (c) 2017-2024 Delft University of Technology
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -998,7 +998,7 @@ class Paper {
     let cnb, proc, prod, fnx, fny, fnw, fnh, tnx, tny, tnw, tnh,
         cp, rr, aa, bb, dd, nn, af, l, s, w, tw, th, bpx, bpy, epx, epy,
         sda, stroke_color, stroke_width, arrow_start, arrow_end,
-        font_color, font_weight, luc = null;
+        font_color, font_weight, luc = null, grid = null;
     // Get the main arrow attributes
     const
         from_nb = arrw.from_node,
@@ -1243,9 +1243,12 @@ class Paper {
         prod = luc.from_node;
       }
       // NOTE: `luc` may also be a constraint!
-      if(luc instanceof Link && luc.is_feedback) {
-        sda = UI.sda.long_dash_dot;
-        arrow_end = this.feedback_triangle;
+      if(luc instanceof Link) {
+        grid = proc.grid;
+        if(luc.is_feedback) {
+          sda = UI.sda.long_dash_dot;
+          arrow_end = this.feedback_triangle;
+        }
       }
       // Data link => dotted line
       if(luc.dataOnly) {
@@ -1474,11 +1477,27 @@ class Paper {
         epy = arrw.from_y + (shift + bi) * dy / l;
         font_color = this.palette.produced;
       }
-      // Draw the rate in a semi-transparent white roundbox.
-      arrw.shape.addRect(epx, epy, tw, th,
-          {fill: 'white', opacity: 0.8, rx: 2, ry: 2});
-      arrw.shape.addNumber(epx, epy, s, {fill: font_color, 'font-style': rrfs});
-
+      let with_rate = true;
+      if(grid) {
+        // For power links, only draw the rate when the model has been run
+        // and the actual flow is less than the process level (so the rate
+        // then reflects the loss).
+        const
+            absf = Math.abs(af),
+            apl = Math.abs(proc.actualLevel(MODEL.t));
+        with_rate = MODEL.solved && apl - absf > VM.SIG_DIF_FROM_ZERO;
+        font_color = 'gray';
+        s = VM.sig4Dig(absf / apl);
+        bb = this.numberSize(s);
+        th = bb.height;
+        tw = Math.max(th, bb.width);
+      }
+      if(with_rate) {
+        // Draw the rate in a semi-transparent white roundbox.
+        arrw.shape.addRect(epx, epy, tw, th,
+            {fill: 'white', opacity: 0.8, rx: 2, ry: 2});
+        arrw.shape.addNumber(epx, epy, s, {fill: font_color, 'font-style': rrfs});
+      }
       // Draw the share of cost (only if relevant and > 0) behind the rate
       // in a pale yellow filled box.
       if(MODEL.infer_cost_prices && luc.share_of_cost > 0) {
@@ -1514,11 +1533,13 @@ class Paper {
     }
     
     // Draw the actual flow
-    if(l > 0 && af < VM.UNDEFINED && Math.abs(af) > VM.SIG_DIF_FROM_ZERO) {
+    const absf = Math.abs(af);
+    if(l > 0 && af < VM.UNDEFINED && absf > VM.SIG_DIF_FROM_ZERO) {
       const ffill = {fill:'white', opacity:0.8};
       if(luc || mf[0] == 1) {
-        // Draw flow data halfway the arrow only if calculated and non-zero
-        s = VM.sig4Dig(af); 
+        // Draw flow data halfway the arrow only if calculated and non-zero.
+        // NOTE: Power flows are always absolute flows.
+        s = VM.sig4Dig(grid ? absf : af); 
         bb = this.numberSize(s, 10, 700);
         tw = bb.width/2;
         th = bb.height/2;
@@ -1861,11 +1882,14 @@ class Paper {
       const
           bl = c.bound_lines[i],
           // Draw thumbnail in shades of the arrow color, but use black
-          // for regular color or the filled areas turn out too light
+          // for regular color or the filled areas turn out too light.
           clr = (stroke_color === this.palette.node_rim ? 'black' : stroke_color);
+      // Set the boundline point coordinates (TRUE indicates: also compute
+      // the thumbnail SVG).
+      bl.setDynamicPoints(MODEL.t, true);
       el = this.newSVGElement('path');
       if(bl.type === VM.EQ) {
-        // For EQ bound lines, draw crisp line on silver background
+        // For EQ bound lines, draw crisp line on silver background.
         this.addSVGAttributes(el,
             {d: bl.contour_path, fill: 'none', stroke: clr, 'stroke-width': 30});
       } else {
@@ -1875,7 +1899,7 @@ class Paper {
       svg.appendChild(el);
     }
     // Draw the share of cost (only if relevant and non-zero) near tail
-    // (or head if Y->X) of arrow in a pale yellow filled box
+    // (or head if Y->X) of arrow in a pale yellow filled box.
     if(MODEL.infer_cost_prices && c.share_of_cost) {
       let s = VM.sig4Dig(c.share_of_cost * 100) + '%',
           bb = this.numberSize(s, 7),
@@ -2017,7 +2041,11 @@ class Paper {
         // Negative level => more reddish stroke and font
         font_color = this.palette.compound_flow;
         stroke_color = font_color;
-        if(lb < -VM.NEAR_ZERO) bar_ratio = l / lb;
+        if(proc.grid) {
+          bar_ratio = l / -ub;
+        } else if(lb < -VM.NEAR_ZERO) {
+          bar_ratio = l / lb;
+        }
         stroke_width = 1.25;
       } else {
         font_color = this.palette.active_process;
@@ -2027,7 +2055,9 @@ class Paper {
       }
       // For options, set longer-dashed rim if committed at time <= t
       const fcn = (is_fc_option ? proc : fc_option_node);
-      if(fcn && fcn.start_ups.length > 0 && MODEL.t >= fcn.start_ups[0]) {
+      // NOTE: When initial level > 0, option is already committed at t=0.
+      if(fcn && (fcn.actualLevel(0) > 0 ||
+         (fcn.start_ups.length > 0 && MODEL.t >= fcn.start_ups[0]))) {
         sda = UI.sda.longer_dash;
       }
     } else if(il) {
@@ -2052,7 +2082,7 @@ class Paper {
       hw = proc.width / 2;
       hh = proc.height / 2;
     }
-    // Draw frame using colors as defined above
+    // Draw frame using colors as defined above.
     proc.shape.addRect(x, y, 2 * hw, 2 * hh,
         {fill: fill_color, stroke: stroke_color, 'stroke-width': stroke_width,
             'stroke-dasharray': sda, 'stroke-linecap': 'round'});
@@ -2062,10 +2092,19 @@ class Paper {
       const
           hsw = stroke_width / 2,
           hbl = hh * bar_ratio - hsw;
-      // NOTE: when level < 0, bar drops down from top
-      proc.shape.addRect(x + hw - 4 - hsw,
-          (l < 0 ? y - hh + hbl + hsw : y + hh - hbl - hsw),
-          8, 2 * hbl, {fill: bar_color, stroke: 'none'});
+      // Collapesed grid processes display a "wire" instead of a bar.
+      if(proc.grid && proc.collapsed) {
+        proc.shape.addPath(
+            ['M', x - hw + 0.5, ',', y - hh/2, 'L', x + hw - 0.5, ',', y - hh/2],
+            // NOTE: Use *squared* bar ratio to reflect quadratic losses.
+            {fill: 'none', stroke: proc.grid.color,
+                'stroke-width': hh * bar_ratio * bar_ratio});
+      } else {
+        // NOTE: when level < 0, bar drops down from top
+        proc.shape.addRect(x + hw - 4 - hsw,
+            (l < 0 ? y - hh + hbl + hsw : y + hh - hbl - hsw),
+            8, 2 * hbl, {fill: bar_color, stroke: 'none'});
+      }
     }
     // If semi-continuous, add a double rim 2 px above the bottom line
     if(proc.level_to_zero) {
@@ -2073,6 +2112,42 @@ class Paper {
       proc.shape.addPath(['M', x - hw, ',', bly, 'L', x + hw, ',', bly],
           {'fill': 'none', stroke: stroke_color, 'stroke-width': 0.6});
     }
+    // If grid element, add colored strip at bottom.
+    if(proc.grid) {
+      proc.shape.addRect(x, y + hh - 3.3, 2*hw - 1.5, 6,
+          {'fill': proc.grid.color, stroke: 'none'});
+      // If grid enforces Kirchhoff's voltage law and/or losses, length
+      // matters, so draw a white horizontal line through the strip that
+      // is proportional to the length property of the process.
+      if(MODEL.solved &&
+          (proc.grid.kirchhoff || proc.grid.loss_approximation)) {
+        const
+            maxl = Math.max(1, POWER_GRID_MANAGER.max_length),
+            w = (2 * hw - 8) * proc.length_in_km / maxl,
+            bly = y + hh - 3.3;
+        proc.shape.addPath(
+            ['M', x - w/2, ',', bly, 'L', x + w/2, ',', bly],
+            {'fill': 'none', stroke: 'white', 'stroke-width': 1.5,
+                'stroke-linecap': 'round'});        
+      }
+      // If process has no capacity, cross it out.
+      if(ub <= VM.NEAR_ZERO) {
+        proc.shape.addPath(
+            ['M', x - hw + 0.8, ',', y - hh + 0.5,
+             'L', x + hw - 0.5, ',', y + hh - 0.5,
+             'M', x - hw + 0.8, ',', y + hh - 0.5,
+             'L', x + hw - 0.5, ',', y - hh + 0.5],
+            {fill: 'none', stroke: 'white', 'stroke-width': 2,
+                'stroke-linecap': 'round'});
+        proc.shape.addPath(
+            ['M', x - hw + 0.8, ',', y - hh + 0.5,
+             'L', x + hw - 0.5, ',', y + hh - 0.5,
+             'M', x - hw + 0.8, ',', y + hh - 0.5,
+             'L', x + hw - 0.5, ',', y - hh + 0.5],
+            {fill: 'none', stroke: proc.grid.color, 'stroke-width': 1,
+                'stroke-linecap': 'round'});
+      }
+    }
     if(!proc.collapsed) {
       // If model has been computed or initial level is non-zero, draw
       // production level in upper right corner
@@ -2102,6 +2177,10 @@ class Paper {
           proc.shape.addNumber(cx, cy, s,
               {'font-size': 9, 'fill': font_color, 'font-weight': 700});
         }
+        if(proc.grid && POWER_GRID_MANAGER.inCycle(proc)) {
+          proc.shape.addText(x + hw - 2, y - hh + bh + 3, '\u27F3',
+            {'font-size': 9, fill: 'black', 'text-anchor':'end'});
+        }
       }
       // Draw boundaries in upper left corner
       // NOTE: their expressions should have been computed
@@ -2118,11 +2197,11 @@ class Paper {
       } else {
         const ubs = (ub >= VM.PLUS_INFINITY && !proc.upper_bound.defined ?
             '\u221E' : VM.sig4Dig(ub));
-        if(Math.abs(lb) > VM.NEAR_ZERO) {
+        if(Math.abs(lb) > VM.NEAR_ZERO && !proc.grid) {
           // If lb <> 0 then lb...ub (with ellipsis).
           s += '\u2026' + ubs;
         } else {
-          // If lb = 0 show only the upper bound.
+          // If gid process or lb = 0, show only the upper bound.
           s = ubs;
           lbw = 0;
         }
@@ -2137,6 +2216,10 @@ class Paper {
           ty = y - hh + sh/2 + 1;
       proc.shape.addNumber(tx + btw/2, ty, s,
           {fill: 'black', 'font-style': bfs});
+      if(proc.grid) {
+        proc.shape.addText(tx + 1, ty + 8, proc.grid.power_unit,
+          {'font-size': 6, fill: 'black', 'text-anchor':'start'});
+      }
       // Show start/stop-related status right of the process boundaries.
       // NOTE: lb must be > 0 for start/stop to work.
       if(proc.level_to_zero && lbw) {