source: issm/trunk-jpl/src/m/classes/slr.m@ 21000

Last change on this file since 21000 was 21000, checked in by adhikari, 9 years ago

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