source: issm/trunk-jpl/src/m/classes/SMBpdd.m@ 24793

Last change on this file since 24793 was 24793, checked in by bdef, 5 years ago

NEW: adding several averaging methods to pass from substep to main step

File size: 13.8 KB
RevLine 
[17078]1%SMBpdd Class definition
2%
3% Usage:
4% SMBpdd=SMBpdd();
5
6classdef SMBpdd
[24240]7 properties (SetAccess=public)
[17078]8 precipitation = NaN;
9 monthlytemperatures = NaN;
[18724]10 desfac = 0;
[19309]11 s0p = NaN;
12 s0t = NaN;
[18984]13 rlaps = 0;
[24240]14 rlapslgm = 0;
[18984]15 Pfac = NaN;
16 Tdiff = NaN;
17 sealev = NaN;
[17078]18 isdelta18o = 0;
[18968]19 ismungsm = 0;
[22448]20 issetpddfac = 0;
[17078]21 delta18o = NaN;
22 delta18o_surface = NaN;
23 temperatures_presentday = NaN;
24 temperatures_lgm = NaN;
25 precipitations_presentday = NaN;
[18950]26 precipitations_lgm = NaN;
[24240]27 steps_per_step = 1;
[24793]28 averaging = 0;
[24240]29 requested_outputs = {};
[17078]30 end
31 methods
[19040]32 function self = SMBpdd(varargin) % {{{
[17078]33 switch nargin
34 case 0
[19040]35 self=setdefaultparameters(self);
[17078]36 otherwise
37 error('constructor not supported');
38 end
39 end % }}}
[17079]40 function self = extrude(self,md) % {{{
[19200]41 if(self.isdelta18o==0 & self.ismungsm==0),self.precipitation=project3d(md,'vector',self.precipitation,'type','node');end
42 if(self.isdelta18o==0 & self.ismungsm==0),self.monthlytemperatures=project3d(md,'vector',self.monthlytemperatures,'type','node');end
[17079]43 if(self.isdelta18o),self.temperatures_lgm=project3d(md,'vector',self.temperatures_lgm,'type','node');end
44 if(self.isdelta18o),self.temperatures_presentday=project3d(md,'vector',self.temperatures_presentday,'type','node');end
45 if(self.isdelta18o),self.precipitations_presentday=project3d(md,'vector',self.precipitations_presentday,'type','node');end
[18950]46 if(self.isdelta18o),self.precipitations_lgm=project3d(md,'vector',self.precipitations_lgm,'type','node');end
[18968]47 if(self.ismungsm),self.temperatures_lgm=project3d(md,'vector',self.temperatures_lgm,'type','node');end
48 if(self.ismungsm),self.temperatures_presentday=project3d(md,'vector',self.temperatures_presentday,'type','node');end
49 if(self.ismungsm),self.precipitations_presentday=project3d(md,'vector',self.precipitations_presentday,'type','node');end
50 if(self.ismungsm),self.precipitations_lgm=project3d(md,'vector',self.precipitations_lgm,'type','node');end
[19309]51 self.s0p=project3d(md,'vector',self.s0p,'type','node');
52 self.s0t=project3d(md,'vector',self.s0t,'type','node');
[17079]53
54 end % }}}
[19527]55 function list = defaultoutputs(self,md) % {{{
56 list = {''};
57 end % }}}
[17078]58 function self = initialize(self,md) % {{{
[24240]59
[19309]60 if isnan(self.s0p),
61 self.s0p=zeros(md.mesh.numberofvertices,1);
62 disp(' no SMBpdd.s0p specified: values set as zero');
63 end
64 if isnan(self.s0t),
65 self.s0t=zeros(md.mesh.numberofvertices,1);
66 disp(' no SMBpdd.s0t specified: values set as zero');
67 end
[17078]68
69 end % }}}
[19040]70 function self = setdefaultparameters(self) % {{{
[17078]71
[19040]72 self.isdelta18o = 0;
73 self.ismungsm = 0;
74 self.desfac = 0.5;
75 self.rlaps = 6.5;
76 self.rlapslgm = 6.5;
[24240]77
[17078]78 end % }}}
[19040]79 function md = checkconsistency(self,md,solution,analyses) % {{{
[17078]80
[21049]81 if ismember('MasstransportAnalysis',analyses),
[19527]82 md = checkfield(md,'fieldname','smb.desfac','<=',1,'numel',1);
[19897]83 md = checkfield(md,'fieldname','smb.s0p','>=',0,'NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
84 md = checkfield(md,'fieldname','smb.s0t','>=',0,'NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
[19527]85 md = checkfield(md,'fieldname','smb.rlaps','>=',0,'numel',1);
86 md = checkfield(md,'fieldname','smb.rlapslgm','>=',0,'numel',1);
[19200]87 if(self.isdelta18o==0 & self.ismungsm==0)
[19897]88 md = checkfield(md,'fieldname','smb.monthlytemperatures','timeseries',1,'NaN',1,'Inf',1);
89 md = checkfield(md,'fieldname','smb.precipitation','timeseries',1,'NaN',1,'Inf',1);
[24240]90 elseif(self.isdelta18o==1)
[19897]91 md = checkfield(md,'fieldname','smb.delta18o','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
92 md = checkfield(md,'fieldname','smb.delta18o_surface','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
[24586]93 md = checkfield(md,'fieldname','smb.temperatures_presentday','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
94 md = checkfield(md,'fieldname','smb.temperatures_lgm','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
95 md = checkfield(md,'fieldname','smb.precipitations_presentday','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
96 md = checkfield(md,'fieldname','smb.precipitations_lgm','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
[19897]97 md = checkfield(md,'fieldname','smb.Tdiff','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
98 md = checkfield(md,'fieldname','smb.sealev','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
[24240]99 elseif(self.ismungsm==1)
[24586]100 md = checkfield(md,'fieldname','smb.temperatures_presentday','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
101 md = checkfield(md,'fieldname','smb.temperatures_lgm','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
102 md = checkfield(md,'fieldname','smb.precipitations_presentday','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
103 md = checkfield(md,'fieldname','smb.precipitations_lgm','size',[md.mesh.numberofvertices 12],'NaN',1,'Inf',1);
[19897]104 md = checkfield(md,'fieldname','smb.Pfac','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
105 md = checkfield(md,'fieldname','smb.Tdiff','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
106 md = checkfield(md,'fieldname','smb.sealev','NaN',1,'Inf',1,'size',[2,NaN],'singletimeseries',1);
[17078]107 end
[18984]108 end
[24240]109 md = checkfield(md,'fieldname','smb.steps_per_step','>=',1,'numel',[1]);
[24793]110 md = checkfield(md,'fieldname','smb.averaging',,'numel',[1],'values',[0 1 2]);
[19527]111 md = checkfield(md,'fieldname','smb.requested_outputs','stringrow',1);
[24240]112
[17078]113 end % }}}
[19040]114 function disp(self) % {{{
[17078]115 disp(sprintf(' surface forcings parameters:'));
116
117 disp(sprintf('\n PDD and deltaO18 parameters:'));
[19040]118 fielddisplay(self,'isdelta18o','is temperature and precipitation delta18o parametrisation activated (0 or 1, default is 0)');
119 fielddisplay(self,'ismungsm','is temperature and precipitation mungsm parametrisation activated (0 or 1, default is 0)');
120 fielddisplay(self,'desfac','desertification elevation factor (between 0 and 1, default is 0.5) [m]');
121 fielddisplay(self,'s0p','should be set to elevation from precip source (between 0 and a few 1000s m, default is 0) [m]');
122 fielddisplay(self,'s0t','should be set to elevation from temperature source (between 0 and a few 1000s m, default is 0) [m]');
123 fielddisplay(self,'rlaps','present day lapse rate [degree/km]');
124 fielddisplay(self,'rlapslgm','LGM lapse rate [degree/km]');
[19264]125 if(self.isdelta18o==0 & self.ismungsm==0)
126 fielddisplay(self,'monthlytemperatures',['monthly surface temperatures [K], required if pdd is activated and delta18o not activated']);
127 fielddisplay(self,'precipitation',['monthly surface precipitation [m/yr water eq], required if pdd is activated and delta18o or mungsm not activated']);
128 elseif(self.isdelta18o==1)
129 fielddisplay(self,'delta18o','delta18o [per mil], required if pdd is activated and delta18o activated');
130 fielddisplay(self,'delta18o_surface','surface elevation of the delta18o site, required if pdd is activated and delta18o activated');
131 fielddisplay(self,'temperatures_presentday','monthly present day surface temperatures [K], required if delta18o/mungsm is activated');
132 fielddisplay(self,'temperatures_lgm','monthly LGM surface temperatures [K], required if delta18o or mungsm is activated');
133 fielddisplay(self,'precipitations_presentday','monthly surface precipitation [m/yr water eq], required if delta18o/mungsm is activated');
134 fielddisplay(self,'precipitations_lgm','monthly surface precipitation [m/yr water eq], required if delta18o/mungsm is activated');
135 fielddisplay(self,'Tdiff','time interpolation parameter for temperature, 1D(year), required if mungsm is activated');
136 fielddisplay(self,'sealev','sea level [m], 1D(year), required if mungsm is activated');
137 elseif(self.ismungsm==1)
138 fielddisplay(self,'temperatures_presentday','monthly present day surface temperatures [K], required if delta18o/mungsm is activated');
139 fielddisplay(self,'temperatures_lgm','monthly LGM surface temperatures [K], required if delta18o or mungsm is activated');
140 fielddisplay(self,'precipitations_presentday','monthly surface precipitation [m/yr water eq], required if delta18o/mungsm is activated');
141 fielddisplay(self,'precipitations_lgm','monthly surface precipitation [m/yr water eq], required if delta18o/mungsm is activated');
142 fielddisplay(self,'Pfac','time interpolation parameter for precipitation, 1D(year), required if mungsm is activated');
143 fielddisplay(self,'Tdiff','time interpolation parameter for temperature, 1D(year), required if mungsm is activated');
144 fielddisplay(self,'sealev','sea level [m], 1D(year), required if mungsm is activated');
145 end
[24240]146 fielddisplay(self, 'steps_per_step', 'number of smb steps per time step');
[24793]147 fielddisplay(self, 'averaging', 'averaging methods from short to long steps');
148 disp(sprintf('%55s 0: Arithmetic (default)');
149 disp(sprintf('%55s 0: Geometric');
150 disp(sprintf('%55s 0: Harmonic');
[19527]151 fielddisplay(self,'requested_outputs','additional outputs requested');
[17078]152 end % }}}
[20690]153 function marshall(self,prefix,md,fid) % {{{
[17078]154
[20896]155 yts=md.constants.yts;
[17078]156
[20889]157 WriteData(fid,prefix,'name','md.smb.model','data',4,'format','Integer');
[17078]158
[20690]159 WriteData(fid,prefix,'object',self,'class','smb','fieldname','isdelta18o','format','Boolean');
[22448]160 WriteData(fid,prefix,'object',self,'class','smb','fieldname','issetpddfac','format','Boolean');
[20690]161 WriteData(fid,prefix,'object',self,'class','smb','fieldname','ismungsm','format','Boolean');
162 WriteData(fid,prefix,'object',self,'class','smb','fieldname','desfac','format','Double');
163 WriteData(fid,prefix,'object',self,'class','smb','fieldname','s0p','format','DoubleMat','mattype',1);
164 WriteData(fid,prefix,'object',self,'class','smb','fieldname','s0t','format','DoubleMat','mattype',1);
165 WriteData(fid,prefix,'object',self,'class','smb','fieldname','rlaps','format','Double');
166 WriteData(fid,prefix,'object',self,'class','smb','fieldname','rlapslgm','format','Double');
[24240]167 WriteData(fid, prefix, 'object', self, 'fieldname', 'steps_per_step', 'format', 'Integer');
[24793]168 WriteData(fid, prefix, 'object', self, 'fieldname', 'averaging', 'format', 'Integer');
[19200]169 if(self.isdelta18o==0 & self.ismungsm==0)
[20690]170 %WriteData(fid,prefix,'object',self,'class','smb','fieldname','monthlytemperatures','format','DoubleMat','mattype',1);
[20902]171 WriteData(fid,prefix,'object',self,'class','smb','fieldname','monthlytemperatures','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
172 WriteData(fid,prefix,'object',self,'class','smb','fieldname','precipitation','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
[19040]173 elseif self.isdelta18o
[20902]174 WriteData(fid,prefix,'object',self,'class','smb','fieldname','temperatures_presentday','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
175 WriteData(fid,prefix,'object',self,'class','smb','fieldname','temperatures_lgm','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
176 WriteData(fid,prefix,'object',self,'class','smb','fieldname','precipitations_presentday','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
177 WriteData(fid,prefix,'object',self,'class','smb','fieldname','precipitations_lgm','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
178 WriteData(fid,prefix,'object',self,'class','smb','fieldname','delta18o_surface','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
179 WriteData(fid,prefix,'object',self,'class','smb','fieldname','delta18o','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
180 WriteData(fid,prefix,'object',self,'class','smb','fieldname','Tdiff','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
181 WriteData(fid,prefix,'object',self,'class','smb','fieldname','sealev','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
[19040]182 elseif self.ismungsm
[20902]183 WriteData(fid,prefix,'object',self,'class','smb','fieldname','temperatures_presentday','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
184 WriteData(fid,prefix,'object',self,'class','smb','fieldname','temperatures_lgm','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
185 WriteData(fid,prefix,'object',self,'class','smb','fieldname','precipitations_presentday','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
186 WriteData(fid,prefix,'object',self,'class','smb','fieldname','precipitations_lgm','format','DoubleMat','mattype',1,'scale',1./yts,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
187 WriteData(fid,prefix,'object',self,'class','smb','fieldname','Pfac','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
188 WriteData(fid,prefix,'object',self,'class','smb','fieldname','Tdiff','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
189 WriteData(fid,prefix,'object',self,'class','smb','fieldname','sealev','format','DoubleMat','mattype',1,'timeserieslength',2,'yts',md.constants.yts);
[17078]190 end
[24240]191
[19527]192 %process requested outputs
193 outputs = self.requested_outputs;
194 pos = find(ismember(outputs,'default'));
195 if ~isempty(pos),
196 outputs(pos) = []; %remove 'default' from outputs
197 outputs = [outputs defaultoutputs(self,md)]; %add defaults
198 end
[20690]199 WriteData(fid,prefix,'data',outputs,'name','md.smb.requested_outputs','format','StringArray');
[19527]200
[17078]201 end % }}}
202 end
203end
Note: See TracBrowser for help on using the repository browser.