source: issm/trunk-jpl/src/m/classes/SMBsemic.m@ 28025

Last change on this file since 28025 was 28025, checked in by inwoo, 16 months ago

CHG: fix bug in classes/SMBsemic.py and synchronize classes/SMBsemic for python and matlab.

File size: 18.5 KB
RevLine 
[23540]1%SMBsemic Class definition
2%
3% Usage:
4% SMBsemic=SMBsemic();
5
6classdef SMBsemic
[24240]7 properties (SetAccess=public)
[23540]8 dailysnowfall = NaN;
9 dailyrainfall = NaN;
10 dailydsradiation = NaN;
11 dailydlradiation = NaN;
12 dailywindspeed = NaN;
13 dailypressure = NaN;
[28025]14 dailyairdensity = NaN;
[23540]15 dailyairhumidity = NaN;
16 dailytemperature = NaN;
[28025]17
[27498]18 Tamp = NaN;
19 mask = NaN;
20 hice = NaN;
21 hsnow = NaN;
[27647]22 qmr = NaN;
[23540]23 desfac = 0;
[27498]24 desfacElevation = 0;
[27453]25 rlaps = 0;
[23540]26 rdl = 0;
[27453]27 s0gcm = NaN;
28 steps_per_step = 1;
29 averaging = 0;
30 requested_outputs = {};
[27498]31
32 hcrit = 0;
33 rcrit = 0;
34
35 % albedo
[27513]36 albedo = 0; % required for first energy balance calculation of SEMIC
37 albedo_snow = 0; % required for ISBA method
[27511]38 albedo_scheme = 0;
[27498]39 alb_smax = NaN;
40 alb_smin = NaN;
41 albi = NaN;
42 albl = NaN;
43
[27511]44 % albedo parameters depending on albedo_scheme
45 % for slater
46 tmin = NaN;
47 tmax = NaN;
48
49 % for isba & denby method
50 mcrit = NaN;
51
52 % for isba
53 tau_a = NaN;
54 tau_f = NaN;
55 wcrit = NaN;
56
57 % for alex
58 tmid = NaN;
59 afac = NaN;
60
[27498]61 % method
[27511]62 ismethod = 0;
[23540]63 end
64 methods
65 function self = SMBsemic(varargin) % {{{
66 switch nargin
67 case 0
68 self=setdefaultparameters(self);
69 otherwise
70 error('constructor not supported');
71 end
72 end % }}}
73 function self = extrude(self,md) % {{{
74 self.dailysnowfall=project3d(md,'vector',self.dailysnowfall,'type','node');
75 self.dailyrainfall=project3d(md,'vector',self.dailyrainfall,'type','node');
76 self.dailydsradiation=project3d(md,'vector',self.dailydsradiation,'type','node');
77 self.dailydlradiation=project3d(md,'vector',self.dailydlradiation,'type','node');
78 self.dailywindspeed=project3d(md,'vector',self.dailywindspeed,'type','node');
79 self.dailypressure=project3d(md,'vector',self.dailypressure,'type','node');
80 self.dailyairdensity=project3d(md,'vector',self.dailyairdensity,'type','node');
81 self.dailyairhumidity=project3d(md,'vector',self.dailyairhumidity,'type','node');
82 self.dailytemperature=project3d(md,'vector',self.dailytemperature,'type','node');
83 self.s0gcm=project3d(md,'vector',self.s0gcm,'type','node');
84
85 end % }}}
86 function list = defaultoutputs(self,md) % {{{
[27403]87 list = {'SmbMassBalance'};
[23540]88 end % }}}
[27511]89 function list = outputlists(self,md) % {{{
90 if self.ismethod == 1
[27826]91 list = {'default','SmbMassBalance','SmbMassBalanceSnow','SmbMassBalanceIce',...
[27773]92 'SmbMassBalanceSemic','SmbMelt','SmbRefreeze','SmbAccumulation',...
[27652]93 'SmbHIce','SmbHSnow','SmbAlbedo','SmbAlbedoSnow','TemperatureSEMIC',...
[27829]94 'SmbSemicQmr','TotalSmb','TotalSmbMelt','TotalSmbRefreeze'};
[27511]95 else
[27826]96 list = {'default','SmbMassBalance'};
[27511]97 end
98 end % }}}
[23540]99 function self = initialize(self,md) % {{{
[27583]100 % Explain
101 % initialize SEMIC smb values, such as s0gcm(surface elevation), albedo,
102 % albedo_snow, hice, hsnow, Tamp... values.
103 %
104 %
105 % Usage
106 % md.smb = initialize(md.smb,md);
[23540]107
[27778]108 if isnan(self.s0gcm)
[27583]109 if ~isnan(md.geometry.surface) & (numel(md.geometry.surface) == md.mesh.numberofvertices)
110 self.s0gcm=md.geometry.surface;
111 disp(' no SMBsemic.s0gcm specified: values from md.geometry.surface');
112 else
113 self.s0gcm=zeros(md.mesh.numberofvertices,1);
114 disp(' no SMBsemic.s0gcm specified: values set as zero');
115 end
[23540]116 end
[27778]117 if isnan(self.mask)
[27583]118 self.mask = 2*ones(md.mesh.numberofvertices,1);
119 disp(' no SMBsemic.mask specified: values set as 2 for ice');
120 end
121
122 % update each values.
[27778]123 if isnan(self.Tamp)
[27583]124 self.Tamp= 3*ones(md.mesh.numberofvertices,1);
125 disp(' no SMBsemic.Tamp specified: values set as 3.0');
126 end
127 self.albedo = 0.8*ones(md.mesh.numberofvertices,1);
128 self.albedo_snow= 0.5*ones(md.mesh.numberofvertices,1);
129 self.hice = 10*ones(md.mesh.numberofvertices,1);
[27498]130 self.hsnow = 5*ones(md.mesh.numberofvertices,1);
[27647]131 self.qmr = zeros(md.mesh.numberofvertices,1);
[23540]132 end % }}}
133 function self = setdefaultparameters(self) % {{{
134
[27511]135 % albedo parameters
[27498]136 self.albedo_scheme = 0;
137 self.alb_smax = 0.79;
138 self.alb_smin = 0.6;
139 self.albi = 0.41;
140 self.albl = 0.07;
141
[27511]142 % albedo parameters for?
143 % for slater
144 self.tmin = 263.15;
145 self.tmax = 273.15;
146 % for isba & denby
147 self.mcrit = 6e-8;
148 % for isba
149 self.tau_a = 0.008;
150 self.tau_f = 0.24;
151 self.wcrit = 15.0;
152 % for alex
153 self.tmid = 273.35;
154 self.afac = -0.18;
155
[27498]156 self.hcrit = 0.028;% from Krapp et al. (2017)
157 self.rcrit = 0.85; % from Krapp et al. (2017)
158
159 self.desfac = -log(2.0)/1000;
160 self.desfacElevation = 2000;
161 self.rlaps = 7.4;
162 self.rdl = 0.29;
163
164 self.ismethod = 0;
[27409]165 self.requested_outputs={'default'};
[27513]166 end % }}}
[23540]167 function md = checkconsistency(self,md,solution,analyses) % {{{
168
[27778]169 if ismember('MasstransportAnalysis',analyses)
[23540]170 md = checkfield(md,'fieldname','smb.desfac','<=',1,'numel',1);
171 md = checkfield(md,'fieldname','smb.s0gcm','>=',0,'NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
172 md = checkfield(md,'fieldname','smb.rlaps','>=',0,'numel',1);
173 md = checkfield(md,'fieldname','smb.rdl','>=',0,'numel',1);
174 md = checkfield(md,'fieldname','smb.dailysnowfall','timeseries',1,'NaN',1,'Inf',1);
175 md = checkfield(md,'fieldname','smb.dailyrainfall','timeseries',1,'NaN',1,'Inf',1);
176 md = checkfield(md,'fieldname','smb.dailydsradiation','timeseries',1,'NaN',1,'Inf',1);
177 md = checkfield(md,'fieldname','smb.dailydlradiation','timeseries',1,'NaN',1,'Inf',1);
178 md = checkfield(md,'fieldname','smb.dailywindspeed','timeseries',1,'NaN',1,'Inf',1);
179 md = checkfield(md,'fieldname','smb.dailypressure','timeseries',1,'NaN',1,'Inf',1);
180 md = checkfield(md,'fieldname','smb.dailyairdensity','timeseries',1,'NaN',1,'Inf',1);
181 md = checkfield(md,'fieldname','smb.dailyairhumidity','timeseries',1,'NaN',1,'Inf',1);
182 md = checkfield(md,'fieldname','smb.dailytemperature','timeseries',1,'NaN',1,'Inf',1);
[27498]183
184 % TODO: transient model should be merged with SEMIC developed by Ruckamp et al. (2018)
185
186 md = checkfield(md,'fieldname','smb.ismethod','numel',1,'values',[0,1]);
[27513]187 if self.ismethod == 1 % transient mode
[27498]188 md = checkfield(md,'fieldname','smb.desfacElevation','>=',0,'numel',1);
189
190 md = checkfield(md,'fieldname','smb.albedo_scheme','NaN',1,'Inf',1,'numel',1,'values',[0,1,2,3,4]);
191 md = checkfield(md,'fieldname','smb.alb_smax','>=',0,'NaN',1,'Inf',1,'numel',1);
192 md = checkfield(md,'fieldname','smb.mask','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1],'values',[0,1,2]);
193
194 % initial values
195 md = checkfield(md,'fieldname','smb.albedo','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1]);
196 md = checkfield(md,'fieldname','smb.albedo_snow','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1]);
197 md = checkfield(md,'fieldname','smb.alb_smax','>=',0,'<=',1,'NaN',1,'Inf',1,'numel',1);
[27647]198 md = checkfield(md,'fieldname','smb.alb_smin','<=',1,'NaN',1,'Inf',1,'numel',1);
[27498]199 md = checkfield(md,'fieldname','smb.albi','>=',0,'<=',1,'NaN',1,'Inf',1,'numel',1);
200 md = checkfield(md,'fieldname','smb.albl','>=',0,'<=',1,'NaN',1,'Inf',1,'numel',1);
201 md = checkfield(md,'fieldname','smb.hice','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1]);
202 md = checkfield(md,'fieldname','smb.hsnow','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1]);
[27647]203 md = checkfield(md,'fieldname','smb.qmr','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices, 1]);
[27498]204 end
[23540]205 end
[24240]206 md = checkfield(md,'fieldname','smb.steps_per_step','>=',1,'numel',[1]);
[24800]207 md = checkfield(md,'fieldname','smb.averaging','numel',[1],'values',[0 1 2]);
[23540]208 md = checkfield(md,'fieldname','smb.requested_outputs','stringrow',1);
[27652]209 % check requested_outputs
210 if self.ismethod==1
211 for i = 1:length(self.requested_outputs)
212 if ~any(strcmpi(self.requested_outputs{i},self.outputlists))
213 error(sprintf('ERROR: %s requested_output is not available',self.requested_outputs{i}));
214 end
215 end
216 end
[23540]217 end % }}}
218 function disp(self) % {{{
219 disp(sprintf(' surface forcings parameters:'));
[24240]220
[23540]221 disp(sprintf(' Interface for coupling GCM data to the energy balance model SEMIC (Krapp et al (2017) https://doi.org/10.5194/tc-11-1519-2017).'));
[24240]222 disp(sprintf(' The implemented coupling uses daily mean GCM input to calculate yearly mean smb, accumulation, ablation, and surface temperature.'));
[23540]223 disp(sprintf(' smb and temperatures are updated every year'));
224 disp(sprintf('\n SEMIC parameters:'));
[24240]225 fielddisplay(self,'dailysnowfall','daily surface dailysnowfall [m/s]');
[23540]226 fielddisplay(self,'dailyrainfall','daily surface dailyrainfall [m/s]');
227 fielddisplay(self,'dailydsradiation','daily downwelling shortwave radiation [W/m2]');
228 fielddisplay(self,'dailydlradiation','daily downwelling longwave radiation [W/m2]');
[24240]229 fielddisplay(self,'dailywindspeed','daily surface wind speed [m/s]');
[23540]230 fielddisplay(self,'dailypressure','daily surface pressure [Pa]');
[24240]231 fielddisplay(self,'dailyairdensity','daily air density [kg/m3]');
[23540]232 fielddisplay(self,'dailyairhumidity','daily air specific humidity [kg/kg]');
233 fielddisplay(self,'dailytemperature','daily surface air temperature [K]');
[27454]234 fielddisplay(self,'rlaps','present day lapse rate (default is 7.4 [degree/km]; Erokhina et al. 2017)');
[23540]235 fielddisplay(self,'desfac','desertification elevation factor (default is -log(2.0)/1000 [1/km]; Vizcaino et al. 2010)');
236 fielddisplay(self,'rdl','longwave downward radiation decrease (default is 0.29 [W/m^2/km]; Marty et al. 2002)');
237 fielddisplay(self,'s0gcm','GCM reference elevation; (default is 0) [m]');
[27652]238 fielddisplay(self,'albedo_scheme','albedom scheme. 0: none, 1: (default is 0)');
[27498]239
240 fielddisplay(self,'ismethod','method for calculating SMB with SEMIC. Default version of SEMIC is really slow. 0: steady, 1: transient (default: 0)');
[27513]241 if self.ismethod == 1 % transient mode
[27498]242 fielddisplay(self,'desfacElevation','desertification elevation (default is 2000 m; Vizcaino et al. 2010)');
243 fielddisplay(self,'Tamp','amplitude of diurnal cycle [K]');
244 fielddisplay(self,'albedo','initial albedo [no unit]');
245 fielddisplay(self,'albedo_snow','initial albedo for snow [no unit]');
246 fielddisplay(self,'hice','initial thickness of ice [unit: m]');
247 fielddisplay(self,'hsnow','initial thickness of snow [unit: m]');
248 fielddisplay(self,'mask','masking for albedo. 0: ocean, 1: land, 2: ice (default: 2)');
[28025]249 fielddisplay(self,'qmr','initial net energy difference between melt and refreeze in SEMIC [unit: W m^{-2}]. This variable can be set with zeros because net energy difference between melt and refreeze is dissipated fast.');
[27498]250 fielddisplay(self,'hcrit','critical snow height for albedo [unit: m]');
251 fielddisplay(self,'rcrit','critical refreezing height for albedo [no unit]');
252
253 disp(sprintf('\nSEMIC albedo parameters.'));
254 fielddisplay(self,'albedo_scheme','albedo scheme for SEMIC. 0: none, 1: slater, 2: isba, 3: denby, 4: alex (default is 0)');
[27504]255 fielddisplay(self,'alb_smax','maximum snow albedo (default: 0.79)');
256 fielddisplay(self,'alb_smin','minimum snow albedo (default: 0.6)');
[27513]257 fielddisplay(self,'albi','background albedo for bare ice (default: 0.41)');
258 fielddisplay(self,'albl','background albedo for bare land (default: 0.07)');
[27498]259 end
[27513]260 % albedo_scheme - 0: none, 1: slater, 2: isba, 3: denby, 4: alex.
[27778]261 if self.albedo_scheme == 0
[27773]262 disp(sprintf('\n\tSEMIC snow albedo parameter of None.'));
263 disp(sprintf('\t albedo of snow is updated from albedo snow max (alb_smax).'));
264 disp(sprintf('\t alb_snow = abl_smax'));
265 elseif self.albedo_scheme == 1
266 disp(sprintf('\n\tSEMIC snow albedo parameters of Slater et al, (1998).'));
[27511]267 disp(sprintf('\t alb = alb_smax - (alb_smax - alb_smin)*tm^(3.0)'))
268 disp(sprintf('\t tm = 1 (tsurf > 273.15 K)'));
269 disp(sprintf('\t tm = f*(tsurf-tmin) (tmin <= tsurf < 273.15)'));
270 disp(sprintf('\t 0 (tsurf < tmin)'));
271 disp(sprintf('\t f = 1/(273.15-tmin)'));
272 fielddisplay(self,'tmin','minimum temperature for which albedo decline become effective. (default: 263.15 K)[unit: K])');
273 fielddisplay(self,'tmax','maxmium temperature for which albedo decline become effective. This value should be fixed. (default: 273.15 K)[unit: K])');
[27778]274 elseif self.albedo_scheme == 2
[27511]275 disp(sprintf('\n\tSEMIC snow albedo parameters for ISBA.? where is citation?'));
[27513]276 fielddisplay(self,'mcrit','critical melt rate (default: 6e-8) [unit: m/sec]');
277 fielddisplay(self,'wcrit','critical liquid water content (default: 15) [unit: kg/m2]');
[27511]278 fielddisplay(self,'tau_a','dry albedo decline [unit: 1/day]');
279 fielddisplay(self,'tau_f','wet albedo decline [unit: 1/day]');
[27778]280 elseif self.albedo_scheme == 3
[27511]281 disp(sprintf('\n\tSEMIC snow albedo parameters for Denby et al. (2002 Tellus)'));
[27513]282 fielddisplay(self,'mcrit','critical melt rate (default: 6e-8) [unit: m/sec]');
[27778]283 elseif self.albedo_scheme == 4
[27511]284 disp(sprintf('\n\tSEMIC snow albedo parameters for Alex.?'));
285 fielddisplay(self,'afac','[unit: ?]');
286 fielddisplay(self,'tmid','[unit: ?]');
287 else
288 error(sprintf('ERROR: %d is not supported albedom scheme.',self.albedo_scheme))
289 end
[27498]290
[24240]291 fielddisplay(self, 'steps_per_step', 'number of smb steps per time step');
[24793]292 fielddisplay(self, 'averaging', 'averaging methods from short to long steps');
[24806]293 disp(sprintf('%51s 0: Arithmetic (default)',' '));
294 disp(sprintf('%51s 1: Geometric',' '));
295 disp(sprintf('%51s 2: Harmonic',' '));
[23540]296 fielddisplay(self,'requested_outputs','additional outputs requested');
297 end % }}}
298 function marshall(self,prefix,md,fid) % {{{
[24240]299
[27453]300 yts=md.constants.yts;
301
[23540]302 WriteData(fid,prefix,'name','md.smb.model','data',12,'format','Integer');
303
[27498]304 WriteData(fid,prefix,'object',self,'class','smb','fieldname','ismethod','format','Integer','values',[0, 1]);
[23540]305 WriteData(fid,prefix,'object',self,'class','smb','fieldname','desfac','format','Double');
[27498]306 WriteData(fid,prefix,'object',self,'class','smb','fieldname','desfacElevation','format','Double');
[23540]307 WriteData(fid,prefix,'object',self,'class','smb','fieldname','s0gcm','format','DoubleMat','mattype',1);
308 WriteData(fid,prefix,'object',self,'class','smb','fieldname','rlaps','format','Double');
309 WriteData(fid,prefix,'object',self,'class','smb','fieldname','rdl','format','Double');
[27453]310 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailysnowfall','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
311 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailyrainfall','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
312 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailydsradiation','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
313 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailydlradiation','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
314 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailywindspeed','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
315 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailypressure','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
316 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailyairdensity','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
317 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailyairhumidity','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
318 WriteData(fid,prefix,'object',self,'class','smb','fieldname','dailytemperature','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',yts);
[27498]319 % TODO: transient mode should be merged with SEMIC developed by Ruckamp et al. (2018).
[27513]320 if self.ismethod == 1% transient mode
[27498]321 WriteData(fid,prefix,'object',self,'class','smb','fieldname','Tamp','format','DoubleMat','mattype',1);
322 WriteData(fid,prefix,'object',self,'class','smb','fieldname','mask','format','DoubleMat','mattype',1);
323 WriteData(fid,prefix,'object',self,'class','smb','fieldname','hice','format','DoubleMat','mattype',1);
324 WriteData(fid,prefix,'object',self,'class','smb','fieldname','hsnow','format','DoubleMat','mattype',1);
[27647]325 WriteData(fid,prefix,'object',self,'class','smb','fieldname','qmr','format','DoubleMat','mattype',1);
[27498]326
327 WriteData(fid,prefix,'object',self,'class','smb','fieldname','hcrit','format','Double');
328 WriteData(fid,prefix,'object',self,'class','smb','fieldname','rcrit','format','Double');
329
[27513]330 %albedo
[27498]331 WriteData(fid,prefix,'object',self,'class','smb','fieldname','albedo','format','DoubleMat','mattype',1);
332 WriteData(fid,prefix,'object',self,'class','smb','fieldname','albedo_snow','format','DoubleMat','mattype',1);
333 WriteData(fid,prefix,'object',self,'class','smb','fieldname','albedo_scheme','format','Integer');
334 WriteData(fid,prefix,'object',self,'class','smb','fieldname','albi','format','Double');
335 WriteData(fid,prefix,'object',self,'class','smb','fieldname','albl','format','Double');
336 WriteData(fid,prefix,'object',self,'class','smb','fieldname','alb_smin','format','Double');
337 WriteData(fid,prefix,'object',self,'class','smb','fieldname','alb_smax','format','Double');
[27511]338
[27513]339 %albedo parameters for ?
[27511]340 %for slater
341 WriteData(fid,prefix,'object',self,'class','smb','fieldname','tmin','format','Double');
342 WriteData(fid,prefix,'object',self,'class','smb','fieldname','tmax','format','Double');
343 %for isba & denby
344 WriteData(fid,prefix,'object',self,'class','smb','fieldname','mcrit','format','Double');
345 %for isba
346 WriteData(fid,prefix,'object',self,'class','smb','fieldname','wcrit','format','Double');
347 WriteData(fid,prefix,'object',self,'class','smb','fieldname','tau_a','format','Double');
348 WriteData(fid,prefix,'object',self,'class','smb','fieldname','tau_f','format','Double');
349 %for alex
350 WriteData(fid,prefix,'object',self,'class','smb','fieldname','tmid','format','Double');
351 WriteData(fid,prefix,'object',self,'class','smb','fieldname','afac','format','Double');
[27498]352 end
353
[27453]354 WriteData(fid,prefix,'object',self,'fieldname','steps_per_step','format','Integer');
355 WriteData(fid,prefix,'object',self,'fieldname','averaging','format','Integer');
[27498]356
[23540]357 %process requested outputs
358 outputs = self.requested_outputs;
359 pos = find(ismember(outputs,'default'));
[27778]360 if ~isempty(pos)
[23540]361 outputs(pos) = []; %remove 'default' from outputs
362 outputs = [outputs defaultoutputs(self,md)]; %add defaults
363 end
364 WriteData(fid,prefix,'data',outputs,'name','md.smb.requested_outputs','format','StringArray');
365
366 end % }}}
367 end
368end
Note: See TracBrowser for help on using the repository browser.