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

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

CHG: changing sea level rise to sea level change. Mostly cosmetic.
File size: 6.8 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('SealevelchangeAnalysis',analyses) | (strcmp(solution,'TransientSolution') & md.transient.isslc==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 %checks on computational flags
74 if self.elastic==1 & self.rigid==0,
75 error('solidearthsettings checkconsistency error message: need rigid on if elastic flag is set');
76 end
77
78 %a coupler to a planet model is provided.
79 if self.isgrd,
80 if md.transient.iscoupler,
81 %we are good;
82 else
83 if strcmpi(class(md.mesh),'mesh3dsurface'),
84 %we are good
85 else
86 error('model is requesting sealevel computations without being a mesh3dsurface, or being coupled to one!');
87 end
88 end
89 end
90
91 end % }}}
92 function disp(self) % {{{
93 disp(sprintf(' solidearth settings:'));
94
95 fielddisplay(self,'reltol','sea level change relative convergence criterion, (default, NaN: not applied)');
96 fielddisplay(self,'abstol','sea level change absolute convergence criterion, NaN: not applied');
97 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
98 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
99 fielddisplay(self,'computesealevelchange','compute sealevel change (default 1)');
100 fielddisplay(self,'isgrd','compute GRD patterns (default 1)');
101 fielddisplay(self,'runfrequency','how many time steps we skip before we run solidearthsettings solver during transient (default: 1)');
102 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
103 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
104 fielddisplay(self,'rotation','earth rotational potential perturbation');
105 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
106 fielddisplay(self,'glfraction','contribute fractionally (default, 1) to barystatic sea level');
107 end % }}}
108 function marshall(self,prefix,md,fid) % {{{
109 WriteData(fid,prefix,'object',self,'fieldname','reltol','name','md.solidearth.settings.reltol','format','Double');
110 WriteData(fid,prefix,'object',self,'fieldname','abstol','name','md.solidearth.settings.abstol','format','Double');
111 WriteData(fid,prefix,'object',self,'fieldname','maxiter','name','md.solidearth.settings.maxiter','format','Integer');
112 WriteData(fid,prefix,'object',self,'fieldname','rigid','name','md.solidearth.settings.rigid','format','Boolean');
113 WriteData(fid,prefix,'object',self,'fieldname','elastic','name','md.solidearth.settings.elastic','format','Boolean');
114 WriteData(fid,prefix,'object',self,'fieldname','rotation','name','md.solidearth.settings.rotation','format','Boolean');
115 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','name','md.solidearth.settings.ocean_area_scaling','format','Boolean');
116 WriteData(fid,prefix,'object',self,'fieldname','runfrequency','name','md.solidearth.settings.runfrequency','format','Integer');
117 WriteData(fid,prefix,'object',self,'fieldname','degacc','name','md.solidearth.settings.degacc','format','Double');
118 WriteData(fid,prefix,'object',self,'fieldname','horiz','name','md.solidearth.settings.horiz','format','Integer');
119 WriteData(fid,prefix,'object',self,'fieldname','computesealevelchange','name','md.solidearth.settings.computesealevelchange','format','Integer');
120 WriteData(fid,prefix,'object',self,'fieldname','isgrd','name','md.solidearth.settings.isgrd','format','Integer');
121 WriteData(fid,prefix,'object',self,'fieldname','glfraction','name','md.solidearth.settings.glfraction','format','Integer');
122 end % }}}
123 function savemodeljs(self,fid,modelname) % {{{
124
125 writejsdouble(fid,[modelname '.solidearth.settings.maxiter'],self.maxiter);
126 writejsdouble(fid,[modelname '.solidearth.settings.reltol'],self.reltol);
127 writejsdouble(fid,[modelname '.solidearth.settings.abstol'],self.abstol);
128 writejsdouble(fid,[modelname '.solidearth.settings.rigid'],self.rigid);
129 writejsdouble(fid,[modelname '.solidearth.settings.elastic'],self.elastic);
130 writejsdouble(fid,[modelname '.solidearth.settings.rotation'],self.rotation);
131 writejsdouble(fid,[modelname '.solidearth.settings.ocean_area_scaling'],self.ocean_area_scaling);
132 writejsdouble(fid,[modelname '.solidearth.settings.run_frequency'],self.run_frequency);
133 writejsdouble(fid,[modelname '.solidearth.settings.degacc'],self.degacc);
134 writejsdouble(fid,[modelname '.solidearth.settings.glfraction'],self.glfraction);
135 end % }}}
136 function self = extrude(self,md) % {{{
137 end % }}}
138 end
139end
Note: See TracBrowser for help on using the repository browser.