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

Last change on this file since 21324 was 21324, checked in by Eric.Larour, 8 years ago

CHG: introducing ocean area scaling from Surendra's work.
File size: 8.1 KB
Line 
1%SLR class definition
2%
3% Usage:
4% slr=slr();
5
6classdef slr
7 properties (SetAccess=public)
8 deltathickness = NaN;
9 sealevel = NaN;
10 spcthickness = NaN;
11 maxiter = 0;
12 reltol = 0;
13 abstol = 0;
14 love_h = 0; %provided by PREM model
15 love_k = 0; %ideam
16 love_l = 0; %ideam
17 tide_love_k = 0; %ideam
18 tide_love_h = 0; %ideam
19 rigid = 0;
20 elastic = 0;
21 rotation = 0;
22 ocean_area_scaling = 0;
23 degacc = 0;
24 requested_outputs = {};
25 transitions = {};
26 end
27 methods
28 function self = slr(varargin) % {{{
29 switch nargin
30 case 0
31 self=setdefaultparameters(self);
32 otherwise
33 error('constructor not supported');
34 end
35 end % }}}
36 function self = setdefaultparameters(self) % {{{
37
38 %Convergence criterion: absolute, relative and residual
39 self.reltol=NaN; %default
40 self.abstol=0.001; %1 mm of sea level rise
41
42 %maximum of non-linear iterations.
43 self.maxiter=10;
44
45 %computational flags:
46 self.rigid=1;
47 self.elastic=1;
48 self.rotation=1;
49 self.ocean_area_scaling=0;
50
51 %tidal love numbers:
52 self.tide_love_h=0.6149; %degree 2
53 self.tide_love_k=0.3055; % degree 2
54
55 %numerical discretization accuracy
56 self.degacc=.01;
57
58 %output default:
59 self.requested_outputs={'default'};
60
61 %transitions should be a cell array of vectors:
62 self.transitions={};
63
64 end % }}}
65 function md = checkconsistency(self,md,solution,analyses) % {{{
66
67 if ~ismember('SealevelriseAnalysis',analyses), return; end
68 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofelements 1]);
69 md = checkfield(md,'fieldname','slr.sealevel','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
70 md = checkfield(md,'fieldname','slr.spcthickness','Inf',1,'timeseries',1);
71 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
72 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
73 md = checkfield(md,'fieldname','slr.love_l','NaN',1,'Inf',1);
74 md = checkfield(md,'fieldname','slr.tide_love_h','NaN',1,'Inf',1);
75 md = checkfield(md,'fieldname','slr.tide_love_k','NaN',1,'Inf',1);
76 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
77 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
78 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
79 md = checkfield(md,'fieldname','slr.degacc','size',[1 1],'>=',1e-10);
80 md = checkfield(md,'fieldname','slr.requested_outputs','stringrow',1);
81
82 %check that love numbers are provided at the same level of accuracy:
83 if (size(self.love_h,1)~=size(self.love_k,1) | size(self.love_h,1)~=size(self.love_l,1)),
84 error('slr error message: love numbers should be provided at the same level of accuracy');
85 end
86
87 %cross check that whereever we have an ice load, the mask is <0 on each vertex:
88 pos=find(self.deltathickness);
89 maskpos=md.mask.ice_levelset(md.mesh.elements(pos,:));
90 [els,vertices]=find(maskpos>0);
91 if length(els),
92 error('slr checkconsistency fail: there are elements with ice loads where some vertices are not on the ice!');
93 end
94
95 end % }}}
96 function list=defaultoutputs(self,md) % {{{
97 list = {'Sealevel'};
98 end % }}}
99 function disp(self) % {{{
100 disp(sprintf(' slr parameters:'));
101
102 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
103 fielddisplay(self,'sealevel','current sea level (prior to computation) [m]');
104 fielddisplay(self,'spcthickness','thickness constraints (NaN means no constraint) [m]');
105 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
106 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
107 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
108 fielddisplay(self,'love_h','load Love number for radial displacement');
109 fielddisplay(self,'love_k','load Love number for gravitational potential perturbation');
110 fielddisplay(self,'love_l','load Love number for horizontal displacements');
111 fielddisplay(self,'tide_love_k','tidal load Love number (deg 2)');
112 fielddisplay(self,'tide_love_h','tidal load Love number (deg 2)');
113 fielddisplay(self,'rotation','earth rotational potential perturbation');
114 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
115 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
116 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
117 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
118 fielddisplay(self,'transitions','indices into parts of the mesh that will be icecaps');
119 fielddisplay(self,'requested_outputs','additional outputs requested');
120
121 end % }}}
122 function marshall(self,prefix,md,fid) % {{{
123 WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',2);
124 WriteData(fid,prefix,'object',self,'fieldname','sealevel','mattype',1,'format','DoubleMat','timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
125 WriteData(fid,prefix,'object',self,'fieldname','spcthickness','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
126 WriteData(fid,prefix,'object',self,'fieldname','reltol','format','Double');
127 WriteData(fid,prefix,'object',self,'fieldname','abstol','format','Double');
128 WriteData(fid,prefix,'object',self,'fieldname','maxiter','format','Integer');
129 WriteData(fid,prefix,'object',self,'fieldname','love_h','format','DoubleMat','mattype',1);
130 WriteData(fid,prefix,'object',self,'fieldname','love_k','format','DoubleMat','mattype',1);
131 WriteData(fid,prefix,'object',self,'fieldname','love_l','format','DoubleMat','mattype',1);
132 WriteData(fid,prefix,'object',self,'fieldname','tide_love_h','format','Double');
133 WriteData(fid,prefix,'object',self,'fieldname','tide_love_k','format','Double');
134 WriteData(fid,prefix,'object',self,'fieldname','rigid','format','Boolean');
135 WriteData(fid,prefix,'object',self,'fieldname','elastic','format','Boolean');
136 WriteData(fid,prefix,'object',self,'fieldname','rotation','format','Boolean');
137 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','format','Boolean');
138 WriteData(fid,prefix,'object',self,'fieldname','degacc','format','Double');
139 WriteData(fid,prefix,'object',self,'fieldname','transitions','format','MatArray');
140
141 %process requested outputs
142 outputs = self.requested_outputs;
143 pos = find(ismember(outputs,'default'));
144 if ~isempty(pos),
145 outputs(pos) = []; %remove 'default' from outputs
146 outputs = [outputs defaultoutputs(self,md)]; %add defaults
147 end
148 WriteData(fid,prefix,'data',outputs,'name','md.slr.requested_outputs','format','StringArray');
149
150 end % }}}
151 function savemodeljs(self,fid,modelname) % {{{
152
153 writejs1Darray(fid,[modelname '.slr.deltathickness'],self.deltathickness);
154 writejs1Darray(fid,[modelname '.slr.sealevel'],self.sealevel);
155 writejs1Darray(fid,[modelname '.slr.spcthickness'],self.spcthickness);
156 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
157 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
158 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
159 writejs1Darray(fid,[modelname '.slr.love_h'],self.love_h);
160 writejs1Darray(fid,[modelname '.slr.love_k'],self.love_k);
161 writejs1Darray(fid,[modelname '.slr.love_l'],self.love_l);
162 writejsdouble(fid,[modelname '.slr.tide_love_k'],self.tide_love_k);
163 writejsdouble(fid,[modelname '.slr.tide_love_h'],self.tide_love_h);
164 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
165 writejsdouble(fid,[modelname '.slr.rotation'],self.rotation);
166 writejsdouble(fid,[modelname '.slr.ocean_area_scaling'],self.ocean_area_scaling);
167 writejsdouble(fid,[modelname '.slr.elastic'],self.elastic);
168 writejsdouble(fid,[modelname '.slr.degacc'],self.degacc);
169 writejscellstring(fid,[modelname '.slr.requested_outputs'],self.requested_outputs);
170 writejscellarray(fid,[modelname '.slr.transitions'],self.transitions);
171 end % }}}
172 end
173end
Note: See TracBrowser for help on using the repository browser.