Changeset 26195

Timestamp:

04/16/21 10:24:43 (4 years ago)

Author:

Mathieu Morlighem

Message:

CHG: added cycle through forcing field, not implemented in C++ yet

Location:

issm/trunk-jpl/src/m/classes

Files:

• timestepping.js (modified) (5 diffs)
• timestepping.m (modified) (6 diffs)
• timestepping.py (modified) (5 diffs)
• timesteppingadaptive.js (modified) (5 diffs)
• timesteppingadaptive.m (modified) (6 diffs)
• timesteppingadaptive.py (modified) (6 diffs)

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

@@ -15 +15 @@
                 //should we interpolate forcings between timesteps?
                 this.interp_forcings=1;
+                this.cycle_forcing=0;
         }// }}}
         this.disp= function(){// {{{
@@ -25 +26 @@
                 fielddisplay(this,'time_step','length of time steps [' +unit+ ']');
                 fielddisplay(this,'interp_forcings','interpolate in time between requested forcing values ? (0 or 1)');
+                fielddisplay(this,'cycle_forcing','cycle through forcing ? (0 or 1)');
                 fielddisplay(this,'coupling_time','length of coupling time steps with ocean model [' +unit+ ']');
 
@@ -38 +40 @@
                 checkfield(md,'fieldname','timestepping.time_step','numel',[1],'>=',0,'NaN',1,'Inf',1);
                 checkfield(md,'fieldname','timestepping.interp_forcings','numel',[1],'values',[0,1]);
+                checkfield(md,'fieldname','timestepping.cycle_forcing','numel',[1],'values',[0,1]);
                 checkfield(md,'fieldname','timestepping.coupling_time','numel',[1],'>=',0,'NaN',1,'Inf',1);
                 if (this.final_time-this.start_time<0){
@@ -53 +56 @@
                 WriteData(fid,prefix,'object',this,'fieldname','time_step','format','Double','scale',scale);
                 WriteData(fid,prefix,'object',this,'fieldname','interp_forcings','format','Boolean');
+                WriteData(fid,prefix,'object',this,'fieldname','cycle_forcing','format','Boolean');
                 WriteData(fid,prefix,'object',this,'fieldname','coupling_time','format','Double','scale',scale);
 
@@ -64 +68 @@
         this.time_step       = 0.;
         this.interp_forcings = 1;
+        this.cycle_forcing   = 0;
         this.coupling_time   = 0.;
 

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

@@ -10 +10 @@
                 time_step       = 0.;
                 interp_forcings = 1;
+                cycle_forcing   = 0;
                 coupling_time   = 0.;
         end
@@ -33 +34 @@
                         %should we interpolate forcings between timesteps?
                         self.interp_forcings=1;
+                        self.cycle_forcing=0;
                 end % }}}
                 function md = checkconsistency(self,md,solution,analyses) % {{{
@@ -40 +42 @@
                         md = checkfield(md,'fieldname','timestepping.time_step','numel',[1],'>=',0,'NaN',1,'Inf',1);
                         md = checkfield(md,'fieldname','timestepping.interp_forcings','numel',[1],'values',[0 1]);
+                        md = checkfield(md,'fieldname','timestepping.cycle_forcing','numel',[1],'values',[0 1]);
                         if self.final_time-self.start_time<0,
                                 md = checkmessage(md,'timestepping.final_time should be larger than timestepping.start_time');
@@ -56 +59 @@
                         fielddisplay(self,'time_step',['length of time steps [' unit ']']);
                         fielddisplay(self,'interp_forcings','interpolate in time between requested forcing values ? (0 or 1)');
+                        fielddisplay(self,'cycle_forcing','cycle through forcing ? (0 or 1)');
                         fielddisplay(self,'coupling_time',['length of coupling time step with ocean model  [' unit ']']);
 
@@ -67 +71 @@
                         WriteData(fid,prefix,'object',self,'fieldname','time_step','format','Double','scale',scale);
                         WriteData(fid,prefix,'object',self,'fieldname','interp_forcings','format','Boolean');
+                        WriteData(fid,prefix,'object',self,'fieldname','cycle_forcing','format','Boolean');
                         WriteData(fid,prefix,'object',self,'fieldname','coupling_time','format','Double','scale',scale);
                 end % }}}
@@ -75 +80 @@
                         writejsdouble(fid,[modelname '.timestepping.time_step'],self.time_step);
                         writejsdouble(fid,[modelname '.timestepping.interp_forcings'],self.interp_forcings);
+                        writejsdouble(fid,[modelname '.timestepping.cycle_forcing'],self.cycle_forcing);
 
                 end % }}}

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

@@ -17 +17 @@
         self.time_step = 0.
         self.interp_forcings = 1
+        self.cycle_forcing = 0
         self.coupling_time = 0.
 
@@ -30 +31 @@
         string = "%s\n%s" % (string, fielddisplay(self, "time_step", "length of time steps [yr]"))
         string = "%s\n%s" % (string, fielddisplay(self, "interp_forcings", "interpolate in time between requested forcing values ? (0 or 1)"))
+        string = "%s\n%s" % (string, fielddisplay(self, "cycle_forcing", "cycle through forcing ? (0 or 1)"))
         string = "%s\n%s" % (string, fielddisplay(self, "coupling_time", "length of coupling time steps with ocean model [yr]"))
         return string
@@ -41 +43 @@
         #should we interpolate forcings between timesteps?
         self.interp_forcings = 1
+        self.cycle_forcing = 0
 
         return self
@@ -54 +57 @@
             md = checkfield(md, 'fieldname', 'timestepping.coupling_time', 'numel', [1], '>=', 0, 'NaN', 1, 'Inf', 1)
         md = checkfield(md, 'fieldname', 'timestepping.interp_forcings', 'numel', [1], 'values', [0, 1])
+        md = checkfield(md, 'fieldname', 'timestepping.cycle_forcing', 'numel', [1], 'values', [0, 1])
 
         return md
@@ -66 +70 @@
         WriteData(fid, prefix, 'object', self, 'fieldname', 'time_step', 'format', 'Double', 'scale', yts)
         WriteData(fid, prefix, 'object', self, 'fieldname', 'interp_forcings', 'format', 'Boolean')
+        WriteData(fid, prefix, 'object', self, 'fieldname', 'cycle_forcing', 'format', 'Boolean')
         WriteData(fid, prefix, 'object', self, 'fieldname', 'coupling_time', 'format', 'Double', 'scale', yts)
     # }}}

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

@@ -19 +19 @@
                 //should we interpolate forcings between timesteps?
                 this.interp_forcings=1;
+                this.cycle_forcing=0;
         }// }}}
         this.disp= function(){// {{{
@@ -31 +32 @@
                 fielddisplay(this,'cfl_coefficient','coefficient applied to cfl condition');
                 fielddisplay(this,'interp_forcings','interpolate in time between requested forcing values ? (0 or 1)');
+                fielddisplay(this,'cycle_forcing','cycle through forcing ? (0 or 1)');
                 fielddisplay(this,'coupling_time','coupling time steps with ocean model [' +unit+ ']');
 
@@ -46 +48 @@
                 checkfield(md,'fieldname','timestepping.cfl_coefficient','numel',[1],'>',0,'<=',1);
                 checkfield(md,'fieldname','timestepping.interp_forcings','numel',[1],'values',[0,1]);
+                checkfield(md,'fieldname','timestepping.cycle_forcing','numel',[1],'values',[0,1]);
                 if (this.final_time-this.start_time<0){
                         md.checkmessage('timestepping.final_time should be larger than timestepping.start_time');
@@ -63 +66 @@
                 WriteData(fid,prefix,'object',this,'class','timestepping','fieldname','cfl_coefficient','format','Double');
                 WriteData(fid,prefix,'object',this,'class','timestepping','fieldname','interp_forcings','format','Boolean');
+                WriteData(fid,prefix,'object',this,'class','timestepping','fieldname','cycle_forcing','format','Boolean');
                 WriteData(fid,prefix,'object',this,'class','timestepping','fieldname','coupling_time','format','Double','scale',scale);
 
@@ -76 +80 @@
         this.cfl_coefficient = 0.;
         this.interp_forcings = 1;
+        this.cycle_forcing   = 0;
         this.coupling_time   = 0.;
 

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

@@ -12 +12 @@
                 cfl_coefficient = 0.;
                 interp_forcings = 1;
+                cycle_forcing = 1;
                 coupling_time   = 0.;
         end
@@ -39 +40 @@
                         %should we interpolate forcings between timesteps?
                         self.interp_forcings=1;
+                        self.cycle_forcing=0;
                 end % }}}
                 function md = checkconsistency(self,md,solution,analyses) % {{{
@@ -48 +50 @@
                         md = checkfield(md,'fieldname','timestepping.cfl_coefficient','numel',[1],'>',0,'<=',1);
                         md = checkfield(md,'fieldname','timestepping.interp_forcings','numel',[1],'values',[0 1]);
+                        md = checkfield(md,'fieldname','timestepping.cycle_forcing','numel',[1],'values',[0 1]);
                         md = checkfield(md,'fieldname','timestepping.coupling_time','numel',[1],'>=',md.timestepping.coupling_time,'NaN',1,'Inf',1);
                         if self.final_time-self.start_time<0,
@@ -63 +66 @@
                         fielddisplay(self,'cfl_coefficient','coefficient applied to cfl condition');
                         fielddisplay(self,'interp_forcings','interpolate in time between requested forcing values ? (0 or 1)');
+                        fielddisplay(self,'cycle_forcing','cycle through forcing ? (0 or 1)');
                         fielddisplay(self,'coupling_time',['coupling time step with ocean model [' unit ']']);
 
@@ -76 +80 @@
                         WriteData(fid,prefix,'object',self,'class','timestepping','fieldname','cfl_coefficient','format','Double');
                         WriteData(fid,prefix,'object',self,'class','timestepping','fieldname','interp_forcings','format','Boolean');
+                        WriteData(fid,prefix,'object',self,'class','timestepping','fieldname','cycle_forcing','format','Boolean');
                         WriteData(fid,prefix,'object',self,'class','timestepping','fieldname','coupling_time','format','Double','scale',scale);
                 end % }}}
@@ -86 +91 @@
                         writejsdouble(fid,[modelname '.timesteppingadaptive.cfl_coefficient'],self.cfl_coefficient);
                         writejsdouble(fid,[modelname '.timesteppingadaptive.interp_forcings'],self.interp_forcings);
+                        writejsdouble(fid,[modelname '.timesteppingadaptive.cycle_forcing'],self.cycle_forcing);
                         writejsdouble(fid,[modelname '.timesteppingadaptive.coupling_time'],self.time_step_max);
 

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

@@ -20 +20 @@
             self.cfl_coefficient = 0.
             self.interp_forcings = 1
+            self.cycle_forcing = 0
             self.coupling_time = 0.
 
@@ -32 +33 @@
             self.final_time = old.final_time
             self.interp_forcings = old.interp_forcings
+            self.cycle_forcing = old.cycle_forcing
             self.coupling_time = old.coupling_time
 
@@ -46 +48 @@
         string = "%s\n%s" % (string, fielddisplay(self, "cfl_coefficient", "coefficient applied to cfl condition"))
         string = "%s\n%s" % (string, fielddisplay(self, "interp_forcings", "interpolate in time between requested forcing values ? (0 or 1)"))
+        string = "%s\n%s" % (string, fielddisplay(self, "cycle_forcing", "cycle through forcing ? (0 or 1)"))
         string = "%s\n%s" % (string, fielddisplay(self, "coupling_time", "coupling time steps with ocean model [yr]"))
         return string
@@ -60 +63 @@
         #should we interpolate forcings between timesteps?
         self.interp_forcings = 1
+        self.cycle_forcing   = 0
         return self
     #}}}
@@ -72 +76 @@
             md.checkmessage("timestepping.final_time should be larger than timestepping.start_time")
         md = checkfield(md, 'fieldname', 'timestepping.interp_forcings', 'numel', [1], 'values', [0, 1])
+        md = checkfield(md, 'fieldname', 'timestepping.cycle_forcing', 'numel', [1], 'values', [0, 1])
         md = checkfield(md, 'fieldname', 'timestepping.coupling_time', 'numel', [1], '>=', 0, 'NaN', 1, 'Inf', 1)
 
@@ -86 +91 @@
         WriteData(fid, prefix, 'object', self, 'class', 'timestepping', 'fieldname', 'cfl_coefficient', 'format', 'Double')
         WriteData(fid, prefix, 'object', self, 'class', 'timestepping', 'fieldname', 'interp_forcings', 'format', 'Boolean')
+        WriteData(fid, prefix, 'object', self, 'class', 'timestepping', 'fieldname', 'cycle_forcing', 'format', 'Boolean')
         WriteData(fid, prefix, 'object', self, 'class', 'timestepping', 'fieldname', 'coupling_time', 'format', 'Double', 'scale', yts)
     # }}}