Changeset 27775

Timestamp:

05/23/23 05:41:44 (22 months ago)

Author:

Mathieu Morlighem

Message:

CHG: better description of output_frequency

Location:

issm/trunk-jpl/src/m/classes

Files:

• issmsettings.js (modified) (2 diffs)
• issmsettings.m (modified) (1 diff)
• issmsettings.py (modified) (1 diff)

issm/trunk-jpl/src/m/classes/issmsettings.js

@@ -6 +6 @@
 function issmsettings (){
     //methods
-    this.setdefaultparameters = function(){// {{{
-        //are we short in memory ? (0 faster but requires more memory)
-        this.lowmem=0;
+        this.setdefaultparameters = function(){// {{{
+                //are we short in memory ? (0 faster but requires more memory)
+                this.lowmem=0;
 
-        //i/o:
-        this.io_gather=1;
+                //i/o:
+                this.io_gather=1;
 
-        //results frequency by default every step
-        this.output_frequency=1;
+                //results frequency by default every step
+                this.output_frequency=1;
 
-        //coupling frequency of the stress balance solver by default every step
-        this.sb_coupling_frequency=1;
+                //coupling frequency of the stress balance solver by default every step
+                this.sb_coupling_frequency=1;
 
-        //checkpoints frequency, by default never:
-        this.checkpoint_frequency=0;
+                //checkpoints frequency, by default never:
+                this.checkpoint_frequency=0;
 
-        //this option can be activated to load automatically the results
-        //onto the model after a parallel run by waiting for the lock file
-        //N minutes that is generated once the solution has converged
-        //0 to deactivate
-        this.waitonlock=Infinity;
+                //this option can be activated to load automatically the results
+                //onto the model after a parallel run by waiting for the lock file
+                //N minutes that is generated once the solution has converged
+                //0 to deactivate
+                this.waitonlock=Infinity;
 
-        //upload options:
-        this.upload_port         = 0;
+                //upload options:
+                this.upload_port         = 0;
 
-        //throw an error if solver residue exceeds this value
-        this.solver_residue_threshold=1e-6;
+                //throw an error if solver residue exceeds this value
+                this.solver_residue_threshold=1e-6;
 
-    }// }}}
-    this.disp= function(){// {{{
-        console.log(sprintf('   issmsettings class echo:'));
+        }// }}}
+        this.disp= function(){// {{{
+                console.log(sprintf('   issmsettings class echo:'));
 
-        fielddisplay(this,'results_on_nodes','results are output for all the nodes of each element');
-        fielddisplay(this,'io_gather','I/O gathering strategy for result outputs (default 1)');
-        fielddisplay(this,'lowmem','is the memory limited ? (0 or 1)');
-        fielddisplay(this,'output_frequency','frequency at which results are saved in all solutions with multiple time_steps');
-        fielddisplay(this,'checkpoint_frequency','frequency at which the runs are being recorded, allowing for a restart');
-        fielddisplay(this,'waitonlock','maximum number of minutes to wait for batch results (NaN to deactivate)');
-        fielddisplay(this,'upload_server','server hostname where model should be uploaded');
-        fielddisplay(this,'upload_path','path on server where model should be uploaded');
-        fielddisplay(this,'upload_login','server login');
-        fielddisplay(this,'upload_port','port login (default is 0)');
-        fielddisplay(this,'upload_filename','unique id generated when uploading the file to server');
-        fielddisplay(this,'solver_residue_threshold','throw an error if solver residue exceeds this value');
+                fielddisplay(this,'results_on_nodes','results are output for all the nodes of each element');
+                fielddisplay(this,'io_gather','I/O gathering strategy for result outputs (default 1)');
+                fielddisplay(this,'lowmem','is the memory limited ? (0 or 1)');
+                fielddisplay(this,'output_frequency','number of time steps between two saves (e.g., 5 means that results are only saved every 5 time steps)');
+                fielddisplay(this,'checkpoint_frequency','frequency at which the runs are being recorded, allowing for a restart');
+                fielddisplay(this,'waitonlock','maximum number of minutes to wait for batch results (NaN to deactivate)');
+                fielddisplay(this,'upload_server','server hostname where model should be uploaded');
+                fielddisplay(this,'upload_path','path on server where model should be uploaded');
+                fielddisplay(this,'upload_login','server login');
+                fielddisplay(this,'upload_port','port login (default is 0)');
+                fielddisplay(this,'upload_filename','unique id generated when uploading the file to server');
+                fielddisplay(this,'solver_residue_threshold','throw an error if solver residue exceeds this value');
 
 
-    }// }}}
-    this.classname= function(){// {{{
-        return "issmsettings";
+        }// }}}
+        this.classname= function(){// {{{
+                return "issmsettings";
 
-    }// }}}
+        }// }}}
         this.checkconsistency = function(md,solution,analyses) { // {{{
 
@@ -81 +81 @@
         }//}}}
         //properties
-    // {{{
-    this.results_on_nodes        = '';
-    this.io_gather               = 0;
-    this.lowmem                  = 0;
-    this.output_frequency        = 0;
-    this.sb_coupling_frequency   = 0;
-    this.checkpoint_frequency    = 0;
-    this.waitonlock              = 0;
-    this.upload_server           = '';
-    this.upload_path             = '';
-    this.upload_login            = '';
-    this.upload_port             = 0;
-    this.upload_filename         = '';
-    this.solver_residue_threshold = 0;
-    this.setdefaultparameters();
-    //}}}
+        // {{{
+        this.results_on_nodes        = '';
+        this.io_gather               = 0;
+        this.lowmem                  = 0;
+        this.output_frequency        = 0;
+        this.sb_coupling_frequency   = 0;
+        this.checkpoint_frequency    = 0;
+        this.waitonlock              = 0;
+        this.upload_server           = '';
+        this.upload_path             = '';
+        this.upload_login            = '';
+        this.upload_port             = 0;
+        this.upload_filename         = '';
+        this.solver_residue_threshold = 0;
+        this.setdefaultparameters();
+        //}}}
 }

issm/trunk-jpl/src/m/classes/issmsettings.m

@@ -92 +92 @@
                         fielddisplay(self,'io_gather','I/O gathering strategy for result outputs (default 1)');
                         fielddisplay(self,'lowmem','is the memory limited ? (0 or 1)');
-                        fielddisplay(self,'output_frequency','frequency at which results are saved in all solutions with multiple time_steps');
+                        fielddisplay(self,'output_frequency','number of time steps between two saves (e.g., 5 means that results are only saved every 5 time steps)');
                         fielddisplay(self,'sb_coupling_frequency','frequency at which StressBalance solver is coupled (default 1)');
                         fielddisplay(self,'checkpoint_frequency','frequency at which the runs are being recorded, allowing for a restart');

issm/trunk-jpl/src/m/classes/issmsettings.py

@@ -30 +30 @@
         s += '{}\n'.format(fielddisplay(self, "io_gather", "I / O gathering strategy for result outputs (default 1)"))
         s += '{}\n'.format(fielddisplay(self, "lowmem", "is the memory limited ? (0 or 1)"))
-        s += '{}\n'.format(fielddisplay(self, "output_frequency", "frequency at which results are saved in all solutions with multiple time_steps"))
+        s += '{}\n'.format(fielddisplay(self, "output_frequency", "number of time steps between two saves (e.g., 5 means that results are only saved every 5 time steps)"))
         s += '{}\n'.format(fielddisplay(self, "sb_coupling_frequency", "frequency at which StressBalance solver is coupled (default 1)"))
         s += '{}\n'.format(fielddisplay(self, "checkpoint_frequency", "frequency at which the runs are being recorded, allowing for a restart"))