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

Last change on this file since 21530 was 21530, checked in by adhikari, 8 years ago

CHG: Gia model is now named GiaIvins
File size: 9.3 KB
RevLine 
[19984]1%SLR class definition
2%
3% Usage:
4% slr=slr();
5
6classdef slr
7 properties (SetAccess=public)
8 deltathickness = NaN;
[20154]9 sealevel = NaN;
[19984]10 maxiter = 0;
11 reltol = 0;
12 abstol = 0;
13 love_h = 0; %provided by PREM model
14 love_k = 0; %ideam
[21000]15 love_l = 0; %ideam
[20349]16 tide_love_k = 0; %ideam
17 tide_love_h = 0; %ideam
[21345]18 fluid_love = 0;
19 equatorial_moi = 0;
20 polar_moi = 0;
[21331]21 angular_velocity = 0;
[20349]22 rigid = 0;
23 elastic = 0;
24 rotation = 0;
[21295]25 ocean_area_scaling = 0;
[20033]26 degacc = 0;
[20036]27 requested_outputs = {};
[20137]28 transitions = {};
[19984]29 end
30 methods
31 function self = slr(varargin) % {{{
32 switch nargin
33 case 0
34 self=setdefaultparameters(self);
35 otherwise
36 error('constructor not supported');
37 end
38 end % }}}
39 function self = setdefaultparameters(self) % {{{
40
41 %Convergence criterion: absolute, relative and residual
[20074]42 self.reltol=NaN; %default
[19984]43 self.abstol=0.001; %1 mm of sea level rise
44
45 %maximum of non-linear iterations.
[20074]46 self.maxiter=10;
[19984]47
48 %computational flags:
49 self.rigid=1;
50 self.elastic=1;
[21331]51 self.rotation=0;
[21309]52 self.ocean_area_scaling=0;
[20033]53
[20349]54 %tidal love numbers:
55 self.tide_love_h=0.6149; %degree 2
56 self.tide_love_k=0.3055; % degree 2
[21345]57
58 %secular fluid love number:
59 self.fluid_love=0.942;
[21331]60
[21345]61 %moment of inertia:
62 self.equatorial_moi=8.0077*10^37; % [kg m^2]
63 self.polar_moi =8.0345*10^37; % [kg m^2]
64
[21331]65 % mean rotational velocity of earth
66 self.angular_velocity=7.2921*10^-5; % [s^-1]
[20349]67
[20033]68 %numerical discretization accuracy
69 self.degacc=.01;
[19986]70
[20036]71 %output default:
72 self.requested_outputs={'default'};
[20137]73
74 %transitions should be a cell array of vectors:
75 self.transitions={};
[20036]76
[19984]77 end % }}}
78 function md = checkconsistency(self,md,solution,analyses) % {{{
79
[21049]80 if ~ismember('SealevelriseAnalysis',analyses), return; end
[20322]81 md = checkfield(md,'fieldname','slr.deltathickness','NaN',1,'Inf',1,'size',[md.mesh.numberofelements 1]);
[20154]82 md = checkfield(md,'fieldname','slr.sealevel','NaN',1,'Inf',1,'size',[md.mesh.numberofvertices 1]);
[19984]83 md = checkfield(md,'fieldname','slr.love_h','NaN',1,'Inf',1);
84 md = checkfield(md,'fieldname','slr.love_k','NaN',1,'Inf',1);
[21000]85 md = checkfield(md,'fieldname','slr.love_l','NaN',1,'Inf',1);
[20349]86 md = checkfield(md,'fieldname','slr.tide_love_h','NaN',1,'Inf',1);
87 md = checkfield(md,'fieldname','slr.tide_love_k','NaN',1,'Inf',1);
[21345]88 md = checkfield(md,'fieldname','slr.fluid_love','NaN',1,'Inf',1);
89 md = checkfield(md,'fieldname','slr.equatorial_moi','NaN',1,'Inf',1);
90 md = checkfield(md,'fieldname','slr.polar_moi','NaN',1,'Inf',1);
[21331]91 md = checkfield(md,'fieldname','slr.angular_velocity','NaN',1,'Inf',1);
[19984]92 md = checkfield(md,'fieldname','slr.reltol','size',[1 1]);
93 md = checkfield(md,'fieldname','slr.abstol','size',[1 1]);
94 md = checkfield(md,'fieldname','slr.maxiter','size',[1 1],'>=',1);
[20033]95 md = checkfield(md,'fieldname','slr.degacc','size',[1 1],'>=',1e-10);
[20036]96 md = checkfield(md,'fieldname','slr.requested_outputs','stringrow',1);
[19984]97
98 %check that love numbers are provided at the same level of accuracy:
[21000]99 if (size(self.love_h,1)~=size(self.love_k,1) | size(self.love_h,1)~=size(self.love_l,1)),
[19984]100 error('slr error message: love numbers should be provided at the same level of accuracy');
101 end
102
[20322]103 %cross check that whereever we have an ice load, the mask is <0 on each vertex:
104 pos=find(self.deltathickness);
105 maskpos=md.mask.ice_levelset(md.mesh.elements(pos,:));
106 [els,vertices]=find(maskpos>0);
107 if length(els),
108 error('slr checkconsistency fail: there are elements with ice loads where some vertices are not on the ice!');
109 end
110
[19984]111 end % }}}
[20036]112 function list=defaultoutputs(self,md) % {{{
[20154]113 list = {'Sealevel'};
[20036]114 end % }}}
[19984]115 function disp(self) % {{{
116 disp(sprintf(' slr parameters:'));
117
118 fielddisplay(self,'deltathickness','thickness change (main loading of the slr solution core [m]');
[20154]119 fielddisplay(self,'sealevel','current sea level (prior to computation) [m]');
[20074]120 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
[19984]121 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
122 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
[21000]123 fielddisplay(self,'love_h','load Love number for radial displacement');
124 fielddisplay(self,'love_k','load Love number for gravitational potential perturbation');
125 fielddisplay(self,'love_l','load Love number for horizontal displacements');
126 fielddisplay(self,'tide_love_k','tidal load Love number (deg 2)');
127 fielddisplay(self,'tide_love_h','tidal load Love number (deg 2)');
[21345]128 fielddisplay(self,'fluid_love','secular fluid Love number');
129 fielddisplay(self,'equatorial_moi','mean equatorial moment of inertia [kg m^2]');
130 fielddisplay(self,'polar_moi','polar moment of inertia [kg m^2]');
[21331]131 fielddisplay(self,'angular_velocity','mean rotational velocity of earth [per second]');
[19984]132 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
133 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
[21295]134 fielddisplay(self,'rotation','earth rotational potential perturbation');
[21309]135 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
[20033]136 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
[20137]137 fielddisplay(self,'transitions','indices into parts of the mesh that will be icecaps');
[20036]138 fielddisplay(self,'requested_outputs','additional outputs requested');
[19984]139
140 end % }}}
[20690]141 function marshall(self,prefix,md,fid) % {{{
142 WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',2);
[21530]143 %WriteData(fid,prefix,'object',self,'fieldname','deltathickness','format','DoubleMat','mattype',1,'timeserieslength',md.mesh.numberofelements+1);
[20902]144 WriteData(fid,prefix,'object',self,'fieldname','sealevel','mattype',1,'format','DoubleMat','timeserieslength',md.mesh.numberofvertices+1,'yts',md.constants.yts);
[20690]145 WriteData(fid,prefix,'object',self,'fieldname','reltol','format','Double');
146 WriteData(fid,prefix,'object',self,'fieldname','abstol','format','Double');
147 WriteData(fid,prefix,'object',self,'fieldname','maxiter','format','Integer');
148 WriteData(fid,prefix,'object',self,'fieldname','love_h','format','DoubleMat','mattype',1);
149 WriteData(fid,prefix,'object',self,'fieldname','love_k','format','DoubleMat','mattype',1);
[21000]150 WriteData(fid,prefix,'object',self,'fieldname','love_l','format','DoubleMat','mattype',1);
[20891]151 WriteData(fid,prefix,'object',self,'fieldname','tide_love_h','format','Double');
[20690]152 WriteData(fid,prefix,'object',self,'fieldname','tide_love_k','format','Double');
[21345]153 WriteData(fid,prefix,'object',self,'fieldname','fluid_love','format','Double');
154 WriteData(fid,prefix,'object',self,'fieldname','equatorial_moi','format','Double');
155 WriteData(fid,prefix,'object',self,'fieldname','polar_moi','format','Double');
[21331]156 WriteData(fid,prefix,'object',self,'fieldname','angular_velocity','format','Double');
[20690]157 WriteData(fid,prefix,'object',self,'fieldname','rigid','format','Boolean');
158 WriteData(fid,prefix,'object',self,'fieldname','elastic','format','Boolean');
159 WriteData(fid,prefix,'object',self,'fieldname','rotation','format','Boolean');
[21295]160 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','format','Boolean');
[20690]161 WriteData(fid,prefix,'object',self,'fieldname','degacc','format','Double');
162 WriteData(fid,prefix,'object',self,'fieldname','transitions','format','MatArray');
[20036]163
164 %process requested outputs
165 outputs = self.requested_outputs;
166 pos = find(ismember(outputs,'default'));
167 if ~isempty(pos),
168 outputs(pos) = []; %remove 'default' from outputs
169 outputs = [outputs defaultoutputs(self,md)]; %add defaults
170 end
[20690]171 WriteData(fid,prefix,'data',outputs,'name','md.slr.requested_outputs','format','StringArray');
[20036]172
[19984]173 end % }}}
174 function savemodeljs(self,fid,modelname) % {{{
175
[20181]176 writejs1Darray(fid,[modelname '.slr.deltathickness'],self.deltathickness);
177 writejs1Darray(fid,[modelname '.slr.sealevel'],self.sealevel);
[20262]178 writejsdouble(fid,[modelname '.slr.maxiter'],self.maxiter);
[19984]179 writejsdouble(fid,[modelname '.slr.reltol'],self.reltol);
180 writejsdouble(fid,[modelname '.slr.abstol'],self.abstol);
[20181]181 writejs1Darray(fid,[modelname '.slr.love_h'],self.love_h);
182 writejs1Darray(fid,[modelname '.slr.love_k'],self.love_k);
[21000]183 writejs1Darray(fid,[modelname '.slr.love_l'],self.love_l);
[20349]184 writejsdouble(fid,[modelname '.slr.tide_love_k'],self.tide_love_k);
185 writejsdouble(fid,[modelname '.slr.tide_love_h'],self.tide_love_h);
[21345]186 writejsdouble(fid,[modelname '.slr.fluid_love'],self.fluid_love);
187 writejsdouble(fid,[modelname '.slr.equatorial_moi'],self.equatorial_moi);
188 writejsdouble(fid,[modelname '.slr.polar_moi'],self.polar_moi);
[21331]189 writejsdouble(fid,[modelname '.slr.angular_velocity'],self.angular_velocity);
[19984]190 writejsdouble(fid,[modelname '.slr.rigid'],self.rigid);
[21295]191 writejsdouble(fid,[modelname '.slr.elastic'],self.elastic);
[20349]192 writejsdouble(fid,[modelname '.slr.rotation'],self.rotation);
[21295]193 writejsdouble(fid,[modelname '.slr.ocean_area_scaling'],self.ocean_area_scaling);
[20033]194 writejsdouble(fid,[modelname '.slr.degacc'],self.degacc);
[20036]195 writejscellstring(fid,[modelname '.slr.requested_outputs'],self.requested_outputs);
[20262]196 writejscellarray(fid,[modelname '.slr.transitions'],self.transitions);
[19984]197 end % }}}
198 end
199end
Note: See TracBrowser for help on using the repository browser.