source: issm/branches/trunk-larour-NatGeoScience2016/src/m/classes/slr.m

Last change on this file was 22890, checked in by Eric.Larour, 7 years ago

CHG: two new fields.
File size: 12.9 KB
RevLine 
[19984]1%SLR class definition
2%
3% Usage:
4% slr=slr();
5
6classdef slr
7 properties (SetAccess=public)
8 deltathickness = NaN;
[20154]9 sealevel = NaN;
[21324]10 spcthickness = NaN;
[19984]11 maxiter = 0;
12 reltol = 0;
13 abstol = 0;
14 love_h = 0; %provided by PREM model
15 love_k = 0; %ideam
[21000]16 love_l = 0; %ideam
[20349]17 tide_love_k = 0; %ideam
18 tide_love_h = 0; %ideam
[21759]19 fluid_love = 0;
20 equatorial_moi = 0;
21 polar_moi = 0;
22 angular_velocity = 0;
[20349]23 rigid = 0;
24 elastic = 0;
25 rotation = 0;
[21324]26 ocean_area_scaling = 0;
[21326]27 steric_rate = 0; %rate of ocean expansion from steric effects.
[22155]28 geodetic_run_frequency = 1; %how many time steps we skip before we run the geodetic part of the solver during transient
29 geodetic = 0; %compute geodetic SLR? (in addition to steric?)
[20033]30 degacc = 0;
[22114]31 loop_increment = 0;
32 horiz = 0;
[22162]33 Ngia = 0;
34 Ugia = 0;
[20036]35 requested_outputs = {};
[20137]36 transitions = {};
[19984]37 end
38 methods
39 function self = slr(varargin) % {{{
40 switch nargin
41 case 0
42 self=setdefaultparameters(self);
43 otherwise
44 error('constructor not supported');
45 end
46 end % }}}
47 function self = setdefaultparameters(self) % {{{
48
49 %Convergence criterion: absolute, relative and residual
[20074]50 self.reltol=NaN; %default
[19984]51 self.abstol=0.001; %1 mm of sea level rise
52
53 %maximum of non-linear iterations.
[20074]54 self.maxiter=10;
[22114]55 self.loop_increment=200;
[19984]56
57 %computational flags:
[22155]58 self.geodetic=0;
[19984]59 self.rigid=1;
60 self.elastic=1;
[21759]61 self.rotation=0;
[21324]62 self.ocean_area_scaling=0;
[21759]63 self.ocean_area_scaling=0;
[20033]64
[20349]65 %tidal love numbers:
66 self.tide_love_h=0.6149; %degree 2
67 self.tide_love_k=0.3055; % degree 2
[21759]68
69 %secular fluid love number:
70 self.fluid_love=0.942;
71
72 %moment of inertia:
73 self.equatorial_moi=8.0077*10^37; % [kg m^2]
74 self.polar_moi =8.0345*10^37; % [kg m^2]
[20349]75
[21759]76 % mean rotational velocity of earth
77 self.angular_velocity=7.2921*10^-5; % [s^-1]
78
[20033]79 %numerical discretization accuracy
80 self.degacc=.01;
[21326]81
82 %steric:
83 self.steric_rate=0;
[21329]84
85 %how many time steps we skip before we run SLR solver during transient
[22155]86 self.geodetic_run_frequency=1;
[21329]87
[20036]88 %output default:
89 self.requested_outputs={'default'};
[20137]90
91 %transitions should be a cell array of vectors:
92 self.transitions={};
[22114]93
94 %horizontal displacement? (not by default)
95 self.horiz=0;
[20036]96
[19984]97 end % }}}
98 function md = checkconsistency(self,md,solution,analyses) % {{{
99
[21049]100 if ~ismember('SealevelriseAnalysis',analyses), return; end
[20322]101 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofelements 1]);
[20154]102 md = checkfield(md,'fieldname','slr.sealevel','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
[21324]103 md = checkfield(md,'fieldname','slr.spcthickness','Inf',1,'timeseries',1);
[19984]104 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
105 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
[21000]106 md = checkfield(md,'fieldname','slr.love_l','NaN',1,'Inf',1);
[20349]107 md = checkfield(md,'fieldname','slr.tide_love_h','NaN',1,'Inf',1);
108 md = checkfield(md,'fieldname','slr.tide_love_k','NaN',1,'Inf',1);
[21759]109 md = checkfield(md,'fieldname','slr.fluid_love','NaN',1,'Inf',1);
110 md = checkfield(md,'fieldname','slr.equatorial_moi','NaN',1,'Inf',1);
111 md = checkfield(md,'fieldname','slr.polar_moi','NaN',1,'Inf',1);
112 md = checkfield(md,'fieldname','slr.angular_velocity','NaN',1,'Inf',1);
[19984]113 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
114 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
115 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
[22155]116 md = checkfield(md,'fieldname','slr.geodetic_run_frequency','size',[1 1],'>=',1);
[21759]117 md = checkfield(md,'fieldname','slr.steric_rate','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
[20033]118 md = checkfield(md,'fieldname','slr.degacc','size',[1 1],'>=',1e-10);
[20036]119 md = checkfield(md,'fieldname','slr.requested_outputs','stringrow',1);
[22114]120 md = checkfield(md,'fieldname','slr.loop_increment','NaN',1,'Inf',1,'>=',1);
121 md = checkfield(md,'fieldname','slr.horiz','NaN',1,'Inf',1,'values',[0 1]);
[22162]122 md = checkfield(md,'fieldname','slr.Ngia','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
123 md = checkfield(md,'fieldname','slr.Ugia','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
[19984]124
125 %check that love numbers are provided at the same level of accuracy:
[21000]126 if (size(self.love_h,1)~=size(self.love_k,1) | size(self.love_h,1)~=size(self.love_l,1)),
[19984]127 error('slr error message: love numbers should be provided at the same level of accuracy');
128 end
129
[20322]130 %cross check that whereever we have an ice load, the mask is <0 on each vertex:
131 pos=find(self.deltathickness);
132 maskpos=md.mask.ice_levelset(md.mesh.elements(pos,:));
133 [els,vertices]=find(maskpos>0);
134 if length(els),
[22245]135 warning('slr checkconsistency fail: there are elements with ice loads where some vertices are not on the ice!');
[20322]136 end
137
[22155]138 %check that if geodetic is requested, we are a mesh3dsurface model (planet), or if we are not,
139 %a coupler to a planet model is provided.
140 if self.geodetic,
141 if md.transient.iscoupler,
142 %we are good;
143 else
144 if strcmpi(class(md.mesh),'mesh3dsurface'),
145 %we are good
146 else
147 error('model is requesting geodetic computations without being a mesh3dsurface, or being coupled to one!');
148 end
149 end
150 end
151
152
[19984]153 end % }}}
[20036]154 function list=defaultoutputs(self,md) % {{{
[20154]155 list = {'Sealevel'};
[20036]156 end % }}}
[19984]157 function disp(self) % {{{
158 disp(sprintf(' slr parameters:'));
159
160 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
[20154]161 fielddisplay(self,'sealevel','current sea level (prior to computation) [m]');
[21324]162 fielddisplay(self,'spcthickness','thickness constraints (NaN means no constraint) [m]');
[20074]163 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
[19984]164 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
165 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
[21000]166 fielddisplay(self,'love_h','load Love number for radial displacement');
167 fielddisplay(self,'love_k','load Love number for gravitational potential perturbation');
168 fielddisplay(self,'love_l','load Love number for horizontal displacements');
169 fielddisplay(self,'tide_love_k','tidal load Love number (deg 2)');
170 fielddisplay(self,'tide_love_h','tidal load Love number (deg 2)');
[21759]171 fielddisplay(self,'fluid_love','secular fluid Love number');
172 fielddisplay(self,'equatorial_moi','mean equatorial moment of inertia [kg m^2]');
173 fielddisplay(self,'polar_moi','polar moment of inertia [kg m^2]');
174 fielddisplay(self,'angular_velocity','mean rotational velocity of earth [per second]');
[21324]175 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
[21326]176 fielddisplay(self,'steric_rate','rate of steric ocean expansion (in mm/yr)');
[22162]177 fielddisplay(self,'Ngia','rate of viscous (GIA) geoid expansion (in mm/yr)');
178 fielddisplay(self,'Ugia','rate of viscous (GIA) bedrock uplift (in mm/yr)');
[22890]179 fielddisplay(self,'loop_increment','vector assembly (in the convolution) framentation');
180 fielddisplay(self,'geodetic','compute geodetic SLR? ( in addition to steric?) default 0');
[22155]181 fielddisplay(self,'geodetic_run_frequency','how many time steps we skip before we run SLR solver during transient (default: 1)');
[19984]182 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
183 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
[21759]184 fielddisplay(self,'rotation','earth rotational potential perturbation');
[20033]185 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
[20137]186 fielddisplay(self,'transitions','indices into parts of the mesh that will be icecaps');
[20036]187 fielddisplay(self,'requested_outputs','additional outputs requested');
[19984]188
189 end % }}}
[20690]190 function marshall(self,prefix,md,fid) % {{{
191 WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',2);
[21759]192 %WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofelements+1);
[20902]193 WriteData(fid,prefix,'object',self,'fieldname','sealevel','mattype',1,'format','DoubleMat','timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
[21324]194 WriteData(fid,prefix,'object',self,'fieldname','spcthickness','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
[20690]195 WriteData(fid,prefix,'object',self,'fieldname','reltol','format','Double');
196 WriteData(fid,prefix,'object',self,'fieldname','abstol','format','Double');
197 WriteData(fid,prefix,'object',self,'fieldname','maxiter','format','Integer');
198 WriteData(fid,prefix,'object',self,'fieldname','love_h','format','DoubleMat','mattype',1);
199 WriteData(fid,prefix,'object',self,'fieldname','love_k','format','DoubleMat','mattype',1);
[21000]200 WriteData(fid,prefix,'object',self,'fieldname','love_l','format','DoubleMat','mattype',1);
[20891]201 WriteData(fid,prefix,'object',self,'fieldname','tide_love_h','format','Double');
[20690]202 WriteData(fid,prefix,'object',self,'fieldname','tide_love_k','format','Double');
[21759]203 WriteData(fid,prefix,'object',self,'fieldname','fluid_love','format','Double');
204 WriteData(fid,prefix,'object',self,'fieldname','equatorial_moi','format','Double');
205 WriteData(fid,prefix,'object',self,'fieldname','polar_moi','format','Double');
206 WriteData(fid,prefix,'object',self,'fieldname','angular_velocity','format','Double');
[20690]207 WriteData(fid,prefix,'object',self,'fieldname','rigid','format','Boolean');
208 WriteData(fid,prefix,'object',self,'fieldname','elastic','format','Boolean');
209 WriteData(fid,prefix,'object',self,'fieldname','rotation','format','Boolean');
[21324]210 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','format','Boolean');
[22155]211 WriteData(fid,prefix,'object',self,'fieldname','geodetic_run_frequency','format','Integer');
[21759]212 WriteData(fid,prefix,'object',self,'fieldname','steric_rate','format','DoubleMat','mattype',1,'scale',1e-3/md.constants.yts);
[22162]213 WriteData(fid,prefix,'object',self,'fieldname','Ngia','format','DoubleMat','mattype',1,'scale',1e-3/md.constants.yts);
214 WriteData(fid,prefix,'object',self,'fieldname','Ugia','format','DoubleMat','mattype',1,'scale',1e-3/md.constants.yts);
[20690]215 WriteData(fid,prefix,'object',self,'fieldname','degacc','format','Double');
216 WriteData(fid,prefix,'object',self,'fieldname','transitions','format','MatArray');
[22114]217 WriteData(fid,prefix,'object',self,'fieldname','loop_increment','format','Integer');
218 WriteData(fid,prefix,'object',self,'fieldname','horiz','format','Integer');
[22155]219 WriteData(fid,prefix,'object',self,'fieldname','geodetic','format','Integer');
[20036]220
221 %process requested outputs
222 outputs = self.requested_outputs;
223 pos = find(ismember(outputs,'default'));
224 if ~isempty(pos),
225 outputs(pos) = []; %remove 'default' from outputs
226 outputs = [outputs defaultoutputs(self,md)]; %add defaults
227 end
[20690]228 WriteData(fid,prefix,'data',outputs,'name','md.slr.requested_outputs','format','StringArray');
[20036]229
[19984]230 end % }}}
231 function savemodeljs(self,fid,modelname) % {{{
232
[20181]233 writejs1Darray(fid,[modelname '.slr.deltathickness'],self.deltathickness);
234 writejs1Darray(fid,[modelname '.slr.sealevel'],self.sealevel);
[21324]235 writejs1Darray(fid,[modelname '.slr.spcthickness'],self.spcthickness);
[20262]236 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
[19984]237 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
238 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
[20181]239 writejs1Darray(fid,[modelname '.slr.love_h'],self.love_h);
240 writejs1Darray(fid,[modelname '.slr.love_k'],self.love_k);
[21000]241 writejs1Darray(fid,[modelname '.slr.love_l'],self.love_l);
[20349]242 writejsdouble(fid,[modelname '.slr.tide_love_k'],self.tide_love_k);
243 writejsdouble(fid,[modelname '.slr.tide_love_h'],self.tide_love_h);
[21759]244 writejsdouble(fid,[modelname '.slr.fluid_love'],self.fluid_love);
245 writejsdouble(fid,[modelname '.slr.equatorial_moi'],self.equatorial_moi);
246 writejsdouble(fid,[modelname '.slr.polar_moi'],self.polar_moi);
247 writejsdouble(fid,[modelname '.slr.angular_velocity'],self.angular_velocity);
[19984]248 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
[21759]249 writejsdouble(fid,[modelname '.slr.elastic'],self.elastic);
[20349]250 writejsdouble(fid,[modelname '.slr.rotation'],self.rotation);
[21324]251 writejsdouble(fid,[modelname '.slr.ocean_area_scaling'],self.ocean_area_scaling);
[22155]252 writejsdouble(fid,[modelname '.slr.geodetic_run_frequency'],self.geodetic_run_frequency);
[20262]253 writejsdouble(fid,[modelname '.slr.elastic'],self.elastic);
[21759]254 writejs1Darray(fid,[modelname '.slr.steric_rate'],self.steric_rate);
[20033]255 writejsdouble(fid,[modelname '.slr.degacc'],self.degacc);
[20036]256 writejscellstring(fid,[modelname '.slr.requested_outputs'],self.requested_outputs);
[20262]257 writejscellarray(fid,[modelname '.slr.transitions'],self.transitions);
[19984]258 end % }}}
[22091]259 function self = extrude(self,md) % {{{
260 self.sealevel=project3d(md,'vector',self.sealevel,'type','node');
261 end % }}}
[19984]262 end
263end
Note: See TracBrowser for help on using the repository browser.