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

Last change on this file since 27829 was 27829, checked in by inwoo, 20 months ago

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