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

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

CHG: visco elastic solid-Earth/sea-level solver now activated.

File size: 9.0 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 viscous = 0;
14 rotation = 0;
15 ocean_area_scaling = 0;
16 runfrequency = 1; %how many time steps we skip before we run grd_core
17 computesealevelchange = 1; %will sea-level be coputed?
18 isgrd = 0; %will GRD patterns be computed?
19 compute_bp_grd = 0; %will GRD patterns for bottom pressures be computed?
20 degacc = 0; %degree increment for resolution of Green tables.
21 timeacc = 0; %time step accurary required to compute Green tables
22 horiz = 0; %compute horizontal deformation
23 grdmodel = 0; %grd model (0 by default, 1 for elastic, 2 for Ivins)
24 cross_section_shape = 0; %cross section only used when grd model is Ivins
25 end
26 methods
27 function self = solidearthsettings(varargin) % {{{
28 switch nargin
29 case 0
30 self=setdefaultparameters(self);
31 otherwise
32 error('constructor not supported');
33 end
34 end % }}}
35 function self = setdefaultparameters(self) % {{{
36
37 %Convergence criterion: absolute, relative and residual
38 self.reltol=0.01; % 1 percent
39 self.abstol=NaN; % default
40
41 %maximum of non-linear iterations.
42 self.maxiter=5;
43
44 %computational flags:
45 self.rigid=1;
46 self.elastic=1;
47 self.viscous=1;
48 self.rotation=1;
49 self.ocean_area_scaling=0;
50 self.compute_bp_grd=0;
51 self.isgrd=0;
52 self.computesealevelchange=1;
53
54 %numerical discretization accuracy
55 self.degacc=.01;
56 self.timeacc=1;
57
58 %how many time steps we skip before we run solidearthsettings solver during transient
59 self.runfrequency=1;
60
61 %horizontal displacement? (not by default)
62 self.horiz=0;
63
64 %cross section for Ivins model
65 self.cross_section_shape=1; %square as default (see iedge in GiaDeflectionCorex)
66
67 %no grd model by default:
68 self.grdmodel=0;
69
70 end % }}}
71 function md = checkconsistency(self,md,solution,analyses) % {{{
72
73 if ~ismember('SealevelchangeAnalysis',analyses) | (strcmp(solution,'TransientSolution') & md.transient.isslc==0),
74 return;
75 end
76 md = checkfield(md,'fieldname','solidearth.settings.reltol','size',[1 1]);
77 md = checkfield(md,'fieldname','solidearth.settings.abstol','size',[1 1]);
78 md = checkfield(md,'fieldname','solidearth.settings.maxiter','size',[1 1],'>=',1);
79 md = checkfield(md,'fieldname','solidearth.settings.runfrequency','size',[1 1],'>=',1);
80 md = checkfield(md,'fieldname','solidearth.settings.degacc','size',[1 1],'>=',1e-10);
81 md = checkfield(md,'fieldname','solidearth.settings.timeacc','size',[1 1],'>',0);
82 md = checkfield(md,'fieldname','solidearth.settings.horiz','NaN',1,'Inf',1,'values',[0 1]);
83 md = checkfield(md,'fieldname','solidearth.settings.grdmodel','>=',0,'<=',2);
84 md = checkfield(md,'fieldname','solidearth.settings.cross_section_shape','numel',[1],'values',[1,2]);
85
86 %checks on computational flags
87 if self.elastic==1 & self.rigid==0,
88 error('solidearthsettings checkconsistency error message: need rigid on if elastic flag is set');
89 end
90 if self.viscous==1 & self.elastic==0,
91 error('solidearthsettings checkconsistency error message: need elastic on if viscous flag is set');
92 end
93
94 %a GRD computation has been requested, make some checks on the nature of the meshes provided.
95 if self.isgrd,
96 if strcmpi(class(md.mesh),'mesh3dsurface'),
97 if self.grdmodel==2,
98 error('model requires a 2D mesh to run gia Ivins computations (change mesh from mesh3dsurface to mesh2d)');
99 end
100 else
101 if self.grdmodel==1,
102 error('model requires a 3D surface mesh to run GRD computations (change mesh from mesh2d to mesh3dsurface)');
103 end
104 end
105 end
106
107 if self.compute_bp_grd==1 & md.solidearth.settings.isgrd==0,
108 error('solidearthsettings checkconsistency error message; if bottom pressure grd patterns are requested, solidearth settings class should have isgrd flag on');
109 end
110
111 end % }}}
112 function disp(self) % {{{
113 disp(sprintf(' solidearth settings:'));
114
115 fielddisplay(self,'reltol','sea level change relative convergence criterion, (default, NaN: not applied)');
116 fielddisplay(self,'abstol','sea level change absolute convergence criterion, NaN: not applied');
117 fielddisplay(self,'maxiter','maximum number of nonlinear iterations');
118 fielddisplay(self,'ocean_area_scaling','correction for model representation of ocean area [default: No correction]');
119 fielddisplay(self,'computesealevelchange','compute sealevel change (default 1)');
120 fielddisplay(self,'isgrd','compute GRD patterns (default 1)');
121 fielddisplay(self,'compute_bp_grd','compute GRD patterns for bottom pressure loads (default 1)');
122 fielddisplay(self,'runfrequency','how many time steps we skip before we run solidearthsettings solver during transient (default: 1)');
123 fielddisplay(self,'rigid','rigid earth graviational potential perturbation');
124 fielddisplay(self,'elastic','elastic earth graviational potential perturbation');
125 fielddisplay(self,'viscous','viscous earth graviational potential perturbation');
126 fielddisplay(self,'rotation','earth rotational potential perturbation');
127 fielddisplay(self,'degacc','accuracy (default .01 deg) for numerical discretization of the Green''s functions');
128 fielddisplay(self,'timeacc','time accuracy (default 1 yr) for numerical discretization of the Green''s functions');
129 fielddisplay(self,'grdmodel','type of deformation model, 1 for elastic, 2 for visco-elastic from Ivins');
130 fielddisplay(self,'cross_section_shape','1: square-edged (default). 2: elliptical. See iedge in GiaDeflectionCore');
131 end % }}}
132 function marshall(self,prefix,md,fid) % {{{
133 WriteData(fid,prefix,'object',self,'fieldname','reltol','name','md.solidearth.settings.reltol','format','Double');
134 WriteData(fid,prefix,'object',self,'fieldname','abstol','name','md.solidearth.settings.abstol','format','Double');
135 WriteData(fid,prefix,'object',self,'fieldname','maxiter','name','md.solidearth.settings.maxiter','format','Integer');
136 WriteData(fid,prefix,'object',self,'fieldname','rigid','name','md.solidearth.settings.rigid','format','Boolean');
137 WriteData(fid,prefix,'object',self,'fieldname','elastic','name','md.solidearth.settings.elastic','format','Boolean');
138 WriteData(fid,prefix,'object',self,'fieldname','viscous','name','md.solidearth.settings.viscous','format','Boolean');
139 WriteData(fid,prefix,'object',self,'fieldname','rotation','name','md.solidearth.settings.rotation','format','Boolean');
140 WriteData(fid,prefix,'object',self,'fieldname','ocean_area_scaling','name','md.solidearth.settings.ocean_area_scaling','format','Boolean');
141 WriteData(fid,prefix,'object',self,'fieldname','runfrequency','name','md.solidearth.settings.runfrequency','format','Integer');
142 WriteData(fid,prefix,'object',self,'fieldname','degacc','name','md.solidearth.settings.degacc','format','Double');
143 WriteData(fid,prefix,'object',self,'fieldname','timeacc','name','md.solidearth.settings.timeacc','format','Double','scale',md.constants.yts);
144 WriteData(fid,prefix,'object',self,'fieldname','horiz','name','md.solidearth.settings.horiz','format','Integer');
145 WriteData(fid,prefix,'object',self,'fieldname','computesealevelchange','name','md.solidearth.settings.computesealevelchange','format','Integer');
146 WriteData(fid,prefix,'object',self,'fieldname','isgrd','name','md.solidearth.settings.isgrd','format','Integer');
147 WriteData(fid,prefix,'object',self,'fieldname','compute_bp_grd','name','md.solidearth.settings.compute_bp_grd','format','Integer');
148 WriteData(fid,prefix,'object',self,'fieldname','grdmodel','name','md.solidearth.settings.grdmodel','format','Integer');
149 WriteData(fid,prefix,'object',self,'fieldname','cross_section_shape','name','md.solidearth.settings.cross_section_shape','format','Integer');
150 end % }}}
151 function savemodeljs(self,fid,modelname) % {{{
152
153 writejsdouble(fid,[modelname '.solidearth.settings.maxiter'],self.maxiter);
154 writejsdouble(fid,[modelname '.solidearth.settings.reltol'],self.reltol);
155 writejsdouble(fid,[modelname '.solidearth.settings.abstol'],self.abstol);
156 writejsdouble(fid,[modelname '.solidearth.settings.rigid'],self.rigid);
157 writejsdouble(fid,[modelname '.solidearth.settings.elastic'],self.elastic);
158 writejsdouble(fid,[modelname '.solidearth.settings.viscous'],self.viscous);
159 writejsdouble(fid,[modelname '.solidearth.settings.rotation'],self.rotation);
160 writejsdouble(fid,[modelname '.solidearth.settings.ocean_area_scaling'],self.ocean_area_scaling);
161 writejsdouble(fid,[modelname '.solidearth.settings.run_frequency'],self.run_frequency);
162 writejsdouble(fid,[modelname '.solidearth.settings.degacc'],self.degacc);
163 writejsdouble(fid,[modelname '.solidearth.settings.timeacc'],self.timeacc);
164 writejsdouble(fid,[modelname '.solidearth.settings.cross_section_shape'],self.cross_section_shape);
165 end % }}}
166 function self = extrude(self,md) % {{{
167 end % }}}
168 end
169end
Note: See TracBrowser for help on using the repository browser.