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

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

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