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

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

CHG: adding store green functions flag
File size: 5.5 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 legendre_precompute = 0;
18 legendre_coefficients = NaN;
19 store_green_functions = 0;
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=0.01; %1 percent
34 self.abstol=0.001; %1 mm of sea level rise
35
36 %maximum of non-linear iterations.
37 self.maxiter=5;
38
39 %computational flags:
40 self.rigid=1;
41 self.elastic=1;
42 self.eustatic=1;
43
44 %legendre coefficients:
45 self.legendre_precompute = 0;
46 self.legendre_coefficients = NaN;
47
48 %optimization:
49 self.store_green_functions=1;
50
51 end % }}}
52 function md = checkconsistency(self,md,solution,analyses) % {{{
53
54 if ~ismember(SealevelriseAnalysisEnum(),analyses), return; end
55 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
56 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
57 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
58 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
59 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
60 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
61 md = checkfield(md,'fieldname','slr.store_green_functions','value',[0 1]);
62
63 %check that love numbers are provided at the same level of accuracy:
64 if (size(self.love_h,1) ~= size(self.love_k,1)),
65 error('slr error message: love numbers should be provided at the same level of accuracy');
66 end
67
68 %check that the legendre coefficients have indeed been computed if requested:
69 if self.legendre_precompute,
70 md = checkfield(md,'fieldname','slr.legendre_coefficients','NaN',1,'Inf',1,'size',[NaN length(self.love_h)]);
71 end
72
73 end % }}}
74 function disp(self) % {{{
75 disp(sprintf(' slr parameters:'));
76
77 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
78 fielddisplay(self,'reltol','sea level rise relative convergence criterion, NaN: not applied');
79 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
80 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
81 fielddisplay(self,'love_h','love load number for radial displacement');
82 fielddisplay(self,'love_k','love load number for gravitational potential perturbation');
83 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
84 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
85 fielddisplay(self,'eustatic','eustatic sea level rise');
86 fielddisplay(self,'store_green_functions','store green functions (default 1) to speed up solutoin (though memory intense)');
87 fielddisplay(self,'legendre_precompute','precompute legendre coefficients? (default is 0)');
88 if(self.legendre_precompute)
89 fielddisplay(self,'legendre_coefficients','precomputed legendre coefficients');
90 end
91
92 end % }}}
93 function marshall(self,md,fid) % {{{
94 WriteData(fid,'object',self,'class','sealevelrise','fieldname','deltathickness','format','DoubleMat','mattype',1);
95 WriteData(fid,'object',self,'class','sealevelrise','fieldname','reltol','format','Double');
96 WriteData(fid,'object',self,'class','sealevelrise','fieldname','abstol','format','Double');
97 WriteData(fid,'object',self,'class','sealevelrise','fieldname','maxiter','format','Integer');
98 WriteData(fid,'object',self,'class','sealevelrise','fieldname','love_h','format','DoubleMat','mattype',1);
99 WriteData(fid,'object',self,'class','sealevelrise','fieldname','love_k','format','DoubleMat','mattype',1);
100 WriteData(fid,'object',self,'class','sealevelrise','fieldname','rigid','format','Boolean');
101 WriteData(fid,'object',self,'class','sealevelrise','fieldname','elastic','format','Boolean');
102 WriteData(fid,'object',self,'class','sealevelrise','fieldname','eustatic','format','Boolean');
103 WriteData(fid,'object',self,'class','sealevelrise','fieldname','store_green_functions','format','Boolean');
104 WriteData(fid,'object',self,'class','sealevelrise','fieldname','legendre_precompute','format','Boolean');
105 if(self.legendre_precompute),
106 WriteData(fid,'object',self,'class','sealevelrise','fieldname','legendre_coefficients','format','DoubleMat','mattype',1);
107 end
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.store_green_functions'],self.store_green_functions);
118 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
119 writejsdouble(fid,[modelname '.slr.eustatic'],self.eustatic);
120 writejsdouble(fid,[modelname '.slr.legendre_precompute'],self.legendre_precompute);
121 if self.legendre_precompute,
122 writejs2Darray(fid,[modelname '.srl.legendre_coefficients'],self.legendre_coefficients);
123 end
124
125 end % }}}
126 end
127end
Note: See TracBrowser for help on using the repository browser.