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

Last change on this file since 20891 was 20891, checked in by Mathieu Morlighem, 9 years ago

CHG: reordering fields to have the same marshalls
File size: 7.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 maxiter = 0;
11 reltol = 0;
12 abstol = 0;
13 love_h = 0; %provided by PREM model
14 love_k = 0; %ideam
15 tide_love_k = 0; %ideam
16 tide_love_h = 0; %ideam
17 rigid = 0;
18 elastic = 0;
19 rotation = 0;
20 degacc = 0;
21 requested_outputs = {};
22 transitions = {};
23 end
24 methods
25 function self = slr(varargin) % {{{
26 switch nargin
27 case 0
28 self=setdefaultparameters(self);
29 otherwise
30 error('constructor not supported');
31 end
32 end % }}}
33 function self = setdefaultparameters(self) % {{{
34
35 %Convergence criterion: absolute, relative and residual
36 self.reltol=NaN; %default
37 self.abstol=0.001; %1 mm of sea level rise
38
39 %maximum of non-linear iterations.
40 self.maxiter=10;
41
42 %computational flags:
43 self.rigid=1;
44 self.elastic=1;
45 self.rotation=1;
46
47 %tidal love numbers:
48 self.tide_love_h=0.6149; %degree 2
49 self.tide_love_k=0.3055; % degree 2
50
51 %numerical discretization accuracy
52 self.degacc=.01;
53
54 %output default:
55 self.requested_outputs={'default'};
56
57 %transitions should be a cell array of vectors:
58 self.transitions={};
59
60 end % }}}
61 function md = checkconsistency(self,md,solution,analyses) % {{{
62
63 if ~ismember(SealevelriseAnalysisEnum(),analyses), return; end
64 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofelements 1]);
65 %md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 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.tide_love_h','NaN',1,'Inf',1);
70 md = checkfield(md,'fieldname','slr.tide_love_k','NaN',1,'Inf',1);
71 md = checkfield(md,'fieldname','slr.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)),
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','love load number for radial displacement');
104 fielddisplay(self,'love_k','love load number for gravitational potential perturbation');
105 fielddisplay(self,'tide_love_k','tidal love number (deg 2)');
106 fielddisplay(self,'tide_love_h','tidal love number (deg 2)');
107 fielddisplay(self,'rotation','earth rotational potential perturbation');
108 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
109 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
110 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
111 fielddisplay(self,'transitions','indices into parts of the mesh that will be icecaps');
112 fielddisplay(self,'requested_outputs','additional outputs requested');
113
114 end % }}}
115 function marshall(self,prefix,md,fid) % {{{
116 WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',2);
117 WriteData(fid,prefix,'object',self,'fieldname','sealevel','mattype',1,'format','DoubleMat','timeserieslength',md.mesh.numberofvertices+1);
118 WriteData(fid,prefix,'object',self,'fieldname','reltol','format','Double');
119 WriteData(fid,prefix,'object',self,'fieldname','abstol','format','Double');
120 WriteData(fid,prefix,'object',self,'fieldname','maxiter','format','Integer');
121 WriteData(fid,prefix,'object',self,'fieldname','love_h','format','DoubleMat','mattype',1);
122 WriteData(fid,prefix,'object',self,'fieldname','love_k','format','DoubleMat','mattype',1);
123 WriteData(fid,prefix,'object',self,'fieldname','tide_love_h','format','Double');
124 WriteData(fid,prefix,'object',self,'fieldname','tide_love_k','format','Double');
125 WriteData(fid,prefix,'object',self,'fieldname','rigid','format','Boolean');
126 WriteData(fid,prefix,'object',self,'fieldname','elastic','format','Boolean');
127 WriteData(fid,prefix,'object',self,'fieldname','rotation','format','Boolean');
128 WriteData(fid,prefix,'object',self,'fieldname','degacc','format','Double');
129 WriteData(fid,prefix,'object',self,'fieldname','transitions','format','MatArray');
130
131 %process requested outputs
132 outputs = self.requested_outputs;
133 pos = find(ismember(outputs,'default'));
134 if ~isempty(pos),
135 outputs(pos) = []; %remove 'default' from outputs
136 outputs = [outputs defaultoutputs(self,md)]; %add defaults
137 end
138 WriteData(fid,prefix,'data',outputs,'name','md.slr.requested_outputs','format','StringArray');
139
140 end % }}}
141 function savemodeljs(self,fid,modelname) % {{{
142
143 writejs1Darray(fid,[modelname '.slr.deltathickness'],self.deltathickness);
144 writejs1Darray(fid,[modelname '.slr.sealevel'],self.sealevel);
145 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
146 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
147 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
148 writejs1Darray(fid,[modelname '.slr.love_h'],self.love_h);
149 writejs1Darray(fid,[modelname '.slr.love_k'],self.love_k);
150 writejsdouble(fid,[modelname '.slr.tide_love_k'],self.tide_love_k);
151 writejsdouble(fid,[modelname '.slr.tide_love_h'],self.tide_love_h);
152 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
153 writejsdouble(fid,[modelname '.slr.rotation'],self.rotation);
154 writejsdouble(fid,[modelname '.slr.elastic'],self.elastic);
155 writejsdouble(fid,[modelname '.slr.degacc'],self.degacc);
156 writejscellstring(fid,[modelname '.slr.requested_outputs'],self.requested_outputs);
157 writejscellarray(fid,[modelname '.slr.transitions'],self.transitions);
158 end % }}}
159 end
160end
Note: See TracBrowser for help on using the repository browser.