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

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

CHG: do not apply reltol by default.
File size: 5.2 KB
Line 
1%SLR class definition
2%
3% Usage:
4% slr=slr();
5
6classdef slr
7 properties (SetAccess=public)
8 deltathickness = NaN;
9 maxiter = 0;
10 reltol = 0;
11 abstol = 0;
12 love_h = 0; %provided by PREM model
13 love_k = 0; %ideam
14 rigid = 0;
15 elastic = 0;
16 eustatic = 0;
17 degacc = 0;
18 requested_outputs = {};
19 end
20 methods
21 function self = slr(varargin) % {{{
22 switch nargin
23 case 0
24 self=setdefaultparameters(self);
25 otherwise
26 error('constructor not supported');
27 end
28 end % }}}
29 function self = setdefaultparameters(self) % {{{
30
31 %Convergence criterion: absolute, relative and residual
32 self.reltol=NaN; %default
33 self.abstol=0.001; %1 mm of sea level rise
34
35 %maximum of non-linear iterations.
36 self.maxiter=10;
37
38 %computational flags:
39 self.rigid=1;
40 self.elastic=1;
41 self.eustatic=1;
42
43 %numerical discretization accuracy
44 self.degacc=.01;
45
46 %output default:
47 self.requested_outputs={'default'};
48
49 end % }}}
50 function md = checkconsistency(self,md,solution,analyses) % {{{
51
52 if ~ismember(SealevelriseAnalysisEnum(),analyses), return; end
53 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
54 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
55 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
56 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
57 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
58 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
59 md = checkfield(md,'fieldname','slr.degacc','size',[1 1],'>=',1e-10);
60 md = checkfield(md,'fieldname','slr.requested_outputs','stringrow',1);
61
62 %check that love numbers are provided at the same level of accuracy:
63 if (size(self.love_h,1) ~= size(self.love_k,1)),
64 error('slr error message: love numbers should be provided at the same level of accuracy');
65 end
66
67 end % }}}
68 function list=defaultoutputs(self,md) % {{{
69 list = {'SealevelriseS'};
70 end % }}}
71 function disp(self) % {{{
72 disp(sprintf(' slr parameters:'));
73
74 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
75 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
76 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
77 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
78 fielddisplay(self,'love_h','love load number for radial displacement');
79 fielddisplay(self,'love_k','love load number for gravitational potential perturbation');
80 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
81 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
82 fielddisplay(self,'eustatic','eustatic sea level rise');
83 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
84 fielddisplay(self,'requested_outputs','additional outputs requested');
85
86 end % }}}
87 function marshall(self,md,fid) % {{{
88 WriteData(fid,'object',self,'class','sealevelrise','fieldname','deltathickness','format','DoubleMat','mattype',1);
89 WriteData(fid,'object',self,'class','sealevelrise','fieldname','reltol','format','Double');
90 WriteData(fid,'object',self,'class','sealevelrise','fieldname','abstol','format','Double');
91 WriteData(fid,'object',self,'class','sealevelrise','fieldname','maxiter','format','Integer');
92 WriteData(fid,'object',self,'class','sealevelrise','fieldname','love_h','format','DoubleMat','mattype',1);
93 WriteData(fid,'object',self,'class','sealevelrise','fieldname','love_k','format','DoubleMat','mattype',1);
94 WriteData(fid,'object',self,'class','sealevelrise','fieldname','rigid','format','Boolean');
95 WriteData(fid,'object',self,'class','sealevelrise','fieldname','elastic','format','Boolean');
96 WriteData(fid,'object',self,'class','sealevelrise','fieldname','eustatic','format','Boolean');
97 WriteData(fid,'object',self,'class','sealevelrise','fieldname','degacc','format','Double');
98
99 %process requested outputs
100 outputs = self.requested_outputs;
101 pos = find(ismember(outputs,'default'));
102 if ~isempty(pos),
103 outputs(pos) = []; %remove 'default' from outputs
104 outputs = [outputs defaultoutputs(self,md)]; %add defaults
105 end
106 WriteData(fid,'data',outputs,'enum',SealevelriseRequestedOutputsEnum,'format','StringArray');
107
108 end % }}}
109 function savemodeljs(self,fid,modelname) % {{{
110
111 writejs1Darray(fid,[modelname '.srl.deltathickness'],self.deltathickness);
112 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
113 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
114 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
115 writejs1Darray(fid,[modelname '.srl.love_h'],self.love_h);
116 writejs1Darray(fid,[modelname '.srl.love_k'],self.love_k);
117 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
118 writejsdouble(fid,[modelname '.slr.eustatic'],self.eustatic);
119 writejsdouble(fid,[modelname '.slr.degacc'],self.degacc);
120 writejscellstring(fid,[modelname '.slr.requested_outputs'],self.requested_outputs);
121
122 end % }}}
123 end
124end
Note: See TracBrowser for help on using the repository browser.