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

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

CHG: added precomputation of legendre polynomials.
File size: 5.0 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 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=0.01; %1 percent
33 self.abstol=0.001; %1 mm of sea level rise
34
35 %maximum of non-linear iterations.
36 self.maxiter=5;
37
38 %computational flags:
39 self.rigid=1;
40 self.elastic=1;
41 self.eustatic=1;
42
43 %legendre coefficients:
44 legendre_precompute = 0;
45 legendre_coefficients = NaN;
46
47 end % }}}
48 function md = checkconsistency(self,md,solution,analyses) % {{{
49
50 if ~ismember(SealevelriseAnalysisEnum(),analyses), return; end
51 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
52 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
53 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
54 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
55 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
56 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
57
58 %check that love numbers are provided at the same level of accuracy:
59 if (size(self.love_h,1) ~= size(self.love_k,1)),
60 error('slr error message: love numbers should be provided at the same level of accuracy');
61 end
62
63 %check that the legendre coefficients have indeed been computed if requested:
64 if self.legendre_precompute,
65 md = checkfield(md,'fieldname','slr.legendre_coefficients','NaN',1,'Inf',1,'size',[NaN length(self.love_h)]);
66 end
67
68 end % }}}
69 function disp(self) % {{{
70 disp(sprintf(' slr parameters:'));
71
72 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
73 fielddisplay(self,'reltol','sea level rise relative convergence criterion, NaN: not applied');
74 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
75 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
76 fielddisplay(self,'love_h','love load number for radial displacement');
77 fielddisplay(self,'love_k','love load number for gravitational potential perturbation');
78 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
79 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
80 fielddisplay(self,'eustatic','eustatic sea level rise');
81 fielddisplay(self,'legendre_precompute','precompute legendre coefficients? (default is 0)');
82 if(self.legendre_precompute)
83 fielddisplay(self,'legendre_coefficients','precomputed legendre coefficients');
84 end
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','legendre_precompute','format','Boolean');
98 if(self.legendre_precompute),
99 WriteData(fid,'object',self,'class','sealevelrise','fieldname','legendre_coefficients','format','DoubleMat','mattype',1);
100 end
101 end % }}}
102 function savemodeljs(self,fid,modelname) % {{{
103
104 writejs1Darray(fid,[modelname '.srl.deltathickness'],self.deltathickness);
105 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
106 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
107 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
108 writejs1Darray(fid,[modelname '.srl.love_h'],self.love_h);
109 writejs1Darray(fid,[modelname '.srl.love_k'],self.love_k);
110 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
111 writejsdouble(fid,[modelname '.slr.eustatic'],self.eustatic);
112 writejsdouble(fid,[modelname '.slr.legendre_precompute'],self.legendre_precompute);
113 if self.legendre_precompute,
114 writejs2Darray(fid,[modelname '.srl.legendre_coefficients'],self.legendre_coefficients);
115 end
116
117 end % }}}
118 end
119end
Note: See TracBrowser for help on using the repository browser.