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

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

CHG: significant changes to the organization of slr -> new solidearth class
that encompasses all of the slr fields.

File size: 5.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 = 0; %will grd_core compute sea level?
17 degacc = 0; %degree increment for resolution of Green tables
18 horiz = 0; %compute horizontal deformation
19 end
20 methods
21 function self = solidearthsettings(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 per cent
33 self.abstol=NaN; % default
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.rotation=1;
42 self.ocean_area_scaling=0;
43 self.computesealevelchange=0;
44
45 %numerical discretization accuracy
46 self.degacc=.01;
47
48 %how many time steps we skip before we run SOLIDEARTHSETTINGS solver during transient
49 self.runfrequency=1;
50
51 %horizontal displacement? (not by default)
52 self.horiz=0;
53 end % }}}
54 function md = checkconsistency(self,md,solution,analyses) % {{{
55
56 if ~ismember('SealevelriseAnalysis',analyses) | (strcmp(solution,'TransientSolution') & md.transient.issolidearthsettings==0),
57 return;
58 end
59 md = checkfield(md,'fieldname','solidearth.settings.reltol','size',[1 1]);
60 md = checkfield(md,'fieldname','solidearth.settings.abstol','size',[1 1]);
61 md = checkfield(md,'fieldname','solidearth.settings.maxiter','size',[1 1],'>=',1);
62 md = checkfield(md,'fieldname','solidearth.settings.runfrequency','size',[1 1],'>=',1);
63 md = checkfield(md,'fieldname','solidearth.settings.degacc','size',[1 1],'>=',1e-10);
64 md = checkfield(md,'fieldname','solidearth.settings.horiz','NaN',1,'Inf',1,'values',[0 1]);
65
66 %a coupler to a planet model is provided.
67 if self.computesealevelchange,
68 if md.transient.iscoupler,
69 %we are good;
70 else
71 if strcmpi(class(md.mesh),'mesh3dsurface'),
72 %we are good
73 else
74 error('model is requesting sealevel computations without being a mesh3dsurface, or being coupled to one!');
75 end
76 end
77 end
78
79 end % }}}
80 function disp(self) % {{{
81 disp(sprintf(' solidearth settings:'));
82
83 fielddisplay(self,'reltol','sea level rise relative convergence criterion, (default, NaN: not applied)');
84 fielddisplay(self,'abstol','sea level rise absolute convergence criterion, NaN: not applied');
85 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
86 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
87 fielddisplay(self,'computesealevelchange','compute sealevel change from GRD in addition to steric?) default 0');
88 fielddisplay(self,'runfrequency','how many time steps we skip before we run SOLIDEARTHSETTINGS solver during transient (default: 1)');
89 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
90 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
91 fielddisplay(self,'rotation','earth rotational potential perturbation');
92 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
93 end % }}}
94 function marshall(self,prefix,md,fid) % {{{
95 WriteData(fid,prefix,'object',self,'fieldname','reltol','name','md.solidearth.settings.reltol','format','Double');
96 WriteData(fid,prefix,'object',self,'fieldname','abstol','name','md.solidearth.settings.abstol','format','Double');
97 WriteData(fid,prefix,'object',self,'fieldname','maxiter','name','md.solidearth.settings.maxiter','format','Integer');
98 WriteData(fid,prefix,'object',self,'fieldname','rigid','name','md.solidearth.settings.rigid','format','Boolean');
99 WriteData(fid,prefix,'object',self,'fieldname','elastic','name','md.solidearth.settings.elastic','format','Boolean');
100 WriteData(fid,prefix,'object',self,'fieldname','rotation','name','md.solidearth.settings.rotation','format','Boolean');
101 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','name','md.solidearth.settings.ocean_area_scaling','format','Boolean');
102 WriteData(fid,prefix,'object',self,'fieldname','runfrequency','name','md.solidearth.settings.runfrequency','format','Integer');
103 WriteData(fid,prefix,'object',self,'fieldname','degacc','name','md.solidearth.settings.degacc','format','Double');
104 WriteData(fid,prefix,'object',self,'fieldname','horiz','name','md.solidearth.settings.horiz','format','Integer');
105 WriteData(fid,prefix,'object',self,'fieldname','computesealevelchange','name','md.solidearth.settings.computesealevelchange','format','Integer');
106 end % }}}
107 function savemodeljs(self,fid,modelname) % {{{
108
109 writejsdouble(fid,[modelname '.slr.settings.maxiter'],self.maxiter);
110 writejsdouble(fid,[modelname '.slr.settings.reltol'],self.reltol);
111 writejsdouble(fid,[modelname '.slr.settings.abstol'],self.abstol);
112 writejsdouble(fid,[modelname '.slr.settings.rigid'],self.rigid);
113 writejsdouble(fid,[modelname '.slr.settings.elastic'],self.elastic);
114 writejsdouble(fid,[modelname '.slr.settings.rotation'],self.rotation);
115 writejsdouble(fid,[modelname '.slr.settings.ocean_area_scaling'],self.ocean_area_scaling);
116 writejsdouble(fid,[modelname '.slr.settings.run_frequency'],self.run_frequency);
117 writejsdouble(fid,[modelname '.slr.settings.degacc'],self.degacc);
118 end % }}}
119 function self = extrude(self,md) % {{{
120 end % }}}
121 end
122end
Note: See TracBrowser for help on using the repository browser.