source: issm/trunk-jpl/src/m/classes/solidearthsettings.m@ 25763

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

CHG: fixing issues with elastic vs rigid vs rotation.
File size: 6.5 KB
Line 
1%SOLIDEARTHSETTINGS class definition
2%
3% Usage:
4% solidearthsettings=solidearthsettings();
5
6classdef solidearthsettings
7 properties (SetAccess=public)
8 reltol = 0;
9 abstol = 0;
10 maxiter = 0;
11 rigid = 0;
12 elastic = 0;
13 rotation = 0;
14 ocean_area_scaling = 0;
15 runfrequency = 1; %how many time steps we skip before we run grd_core
16 computesealevelchange = 1; %will sea-level be coputed?
17 isgrd = 1; %will GRD patterns be computed?
18 degacc = 0; %degree increment for resolution of Green tables
19 horiz = 0; %compute horizontal deformation
20 glfraction = 1; %barystatic contribution full or fractional (default fractional)
21 end
22 methods
23 function self = solidearthsettings(varargin) % {{{
24 switch nargin
25 case 0
26 self=setdefaultparameters(self);
27 otherwise
28 error('constructor not supported');
29 end
30 end % }}}
31 function self = setdefaultparameters(self) % {{{
32
33 %Convergence criterion: absolute, relative and residual
34 self.reltol=0.01; % 1 per cent
35 self.abstol=NaN; % default
36
37 %maximum of non-linear iterations.
38 self.maxiter=5;
39
40 %computational flags:
41 self.rigid=1;
42 self.elastic=1;
43 self.rotation=1;
44 self.ocean_area_scaling=0;
45 self.isgrd=1;
46 self.computesealevelchange=1;
47
48 %numerical discretization accuracy
49 self.degacc=.01;
50
51 %how many time steps we skip before we run solidearthsettings solver during transient
52 self.runfrequency=1;
53
54 %fractional contribution:
55 self.glfraction=1;
56
57 %horizontal displacement? (not by default)
58 self.horiz=0;
59 end % }}}
60 function md = checkconsistency(self,md,solution,analyses) % {{{
61
62 if ~ismember('SealevelriseAnalysis',analyses) | (strcmp(solution,'TransientSolution') & md.transient.isslr==0),
63 return;
64 end
65 md = checkfield(md,'fieldname','solidearth.settings.reltol','size',[1 1]);
66 md = checkfield(md,'fieldname','solidearth.settings.abstol','size',[1 1]);
67 md = checkfield(md,'fieldname','solidearth.settings.maxiter','size',[1 1],'>=',1);
68 md = checkfield(md,'fieldname','solidearth.settings.runfrequency','size',[1 1],'>=',1);
69 md = checkfield(md,'fieldname','solidearth.settings.degacc','size',[1 1],'>=',1e-10);
70 md = checkfield(md,'fieldname','solidearth.settings.horiz','NaN',1,'Inf',1,'values',[0 1]);
71 md = checkfield(md,'fieldname','solidearth.settings.glfraction','values',[0 1]);
72
73 %a coupler to a planet model is provided.
74 if self.isgrd,
75 if md.transient.iscoupler,
76 %we are good;
77 else
78 if strcmpi(class(md.mesh),'mesh3dsurface'),
79 %we are good
80 else
81 error('model is requesting sealevel computations without being a mesh3dsurface, or being coupled to one!');
82 end
83 end
84 end
85
86 end % }}}
87 function disp(self) % {{{
88 disp(sprintf(' solidearth settings:'));
89
90 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
91 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
92 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
93 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
94 fielddisplay(self,'computesealevelchange','compute sealevel change (default 1)');
95 fielddisplay(self,'isgrd','compute GRD patterns (default 1)');
96 fielddisplay(self,'runfrequency','how many time steps we skip before we run solidearthsettings solver during transient (default: 1)');
97 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
98 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
99 fielddisplay(self,'rotation','earth rotational potential perturbation');
100 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
101 fielddisplay(self,'glfraction','contribute fractionally (default, 1) to barystatic sea level');
102 end % }}}
103 function marshall(self,prefix,md,fid) % {{{
104 WriteData(fid,prefix,'object',self,'fieldname','reltol','name','md.solidearth.settings.reltol','format','Double');
105 WriteData(fid,prefix,'object',self,'fieldname','abstol','name','md.solidearth.settings.abstol','format','Double');
106 WriteData(fid,prefix,'object',self,'fieldname','maxiter','name','md.solidearth.settings.maxiter','format','Integer');
107 WriteData(fid,prefix,'object',self,'fieldname','rigid','name','md.solidearth.settings.rigid','format','Boolean');
108 WriteData(fid,prefix,'object',self,'fieldname','elastic','name','md.solidearth.settings.elastic','format','Boolean');
109 WriteData(fid,prefix,'object',self,'fieldname','rotation','name','md.solidearth.settings.rotation','format','Boolean');
110 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','name','md.solidearth.settings.ocean_area_scaling','format','Boolean');
111 WriteData(fid,prefix,'object',self,'fieldname','runfrequency','name','md.solidearth.settings.runfrequency','format','Integer');
112 WriteData(fid,prefix,'object',self,'fieldname','degacc','name','md.solidearth.settings.degacc','format','Double');
113 WriteData(fid,prefix,'object',self,'fieldname','horiz','name','md.solidearth.settings.horiz','format','Integer');
114 WriteData(fid,prefix,'object',self,'fieldname','computesealevelchange','name','md.solidearth.settings.computesealevelchange','format','Integer');
115 WriteData(fid,prefix,'object',self,'fieldname','isgrd','name','md.solidearth.settings.isgrd','format','Integer');
116 WriteData(fid,prefix,'object',self,'fieldname','glfraction','name','md.solidearth.settings.glfraction','format','Integer');
117 end % }}}
118 function savemodeljs(self,fid,modelname) % {{{
119
120 writejsdouble(fid,[modelname '.slr.settings.maxiter'],self.maxiter);
121 writejsdouble(fid,[modelname '.slr.settings.reltol'],self.reltol);
122 writejsdouble(fid,[modelname '.slr.settings.abstol'],self.abstol);
123 writejsdouble(fid,[modelname '.slr.settings.rigid'],self.rigid);
124 writejsdouble(fid,[modelname '.slr.settings.elastic'],self.elastic);
125 writejsdouble(fid,[modelname '.slr.settings.rotation'],self.rotation);
126 writejsdouble(fid,[modelname '.slr.settings.ocean_area_scaling'],self.ocean_area_scaling);
127 writejsdouble(fid,[modelname '.slr.settings.run_frequency'],self.run_frequency);
128 writejsdouble(fid,[modelname '.slr.settings.degacc'],self.degacc);
129 writejsdouble(fid,[modelname '.slr.settings.glfraction'],self.glfraction);
130 end % }}}
131 function self = extrude(self,md) % {{{
132 end % }}}
133 end
134end
Note: See TracBrowser for help on using the repository browser.