source: issm/trunk-jpl/src/m/classes/solidearth.m@ 26099

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

CHG: new ElementCoordinatesx module, use for an optimized
version of the sea level core. Many bug fixes to get test2002
to run.

File size: 5.9 KB
Line 
1%SOLIDEARTH class definition
2%
3% Usage:
4% solidearth=solidearth();
5
6classdef solidearth
7 properties (SetAccess=public)
8 settings = solidearthsettings();
9 external = [];
10 lovenumbers = lovenumbers();
11 rotational = rotational();
12 planetradius = planetradius('earth');
13 requested_outputs = {};
14 transitions = {};
15 partitionice = [];
16 partitionhydro = [];
17 partitionocean = [];
18 end
19 methods (Static)
20 function self = loadobj(self) % {{{
21 % This function is directly called by matlab when a model object is
22 % loaded. If the input is a struct it is an old version of this class and
23 % old fields must be recovered (make sure they are in the deprecated
24 % model properties)
25
26 if isstruct(self)
27 % 2021, Jan 10
28 if isfield(self,'sealevel')
29 self.initialsealevel = self.sealevel;
30 end
31 self = structtoobj(solidearth(),self);
32
33 end
34 end% }}}
35 end
36 methods
37 function self = solidearth(varargin) % {{{
38 switch nargin
39 case 0
40 self=setdefaultparameters(self,'earth');
41 case 1
42 self=setdefaultparameters(self,varargin{:});
43 otherwise
44 error('solidearth constructor error message: zero or one argument only!');
45 end
46 end % }}}
47 function self = setdefaultparameters(self,planet) % {{{
48
49 %output default:
50 self.requested_outputs={'default'};
51
52 %transitions should be a cell array of vectors:
53 self.transitions={};
54
55 %no partitions requested for barystatic contribution:
56 self.partitionice=[];
57 self.partitionhydro=[];
58 self.partitionocean=[];
59
60 %no external solutions by default:
61 self.external=[];
62
63 %earth radius
64 self.planetradius= planetradius(planet);
65
66 end % }}}
67 function md = checkconsistency(self,md,solution,analyses) % {{{
68
69 if ~ismember('SealevelchangeAnalysis',analyses) | (strcmp(solution,'TransientSolution') & md.transient.isslc==0),
70 return;
71 end
72
73 md = checkfield(md,'fieldname','solidearth.requested_outputs','stringrow',1);
74
75 self.settings.checkconsistency(md,solution,analyses);
76 self.lovenumbers.checkconsistency(md,solution,analyses);
77 self.rotational.checkconsistency(md,solution,analyses);
78 if ~isempty(self.external),
79 if ~isa(self.external,'solidearthsolution'),
80 error('solidearth consistency check: external field should be a solidearthsolution');
81 end
82 self.external.checkconsistency(md,solution,analyses);
83 end
84
85
86 end % }}}
87 function list=defaultoutputs(self,md) % {{{
88 list = {'Sealevel'};
89 end % }}}
90 function disp(self) % {{{
91 disp(sprintf(' solidearth inputs, forcings and settings:'));
92
93 fielddisplay(self,'planetradius','planet radius [m]');
94 fielddisplay(self,'transitions','indices into parts of the mesh that will be icecaps');
95 fielddisplay(self,'requested_outputs','additional outputs requested');
96 fielddisplay(self,'partitionice','ice partition vector for barystatic contribution');
97 fielddisplay(self,'partitionhydro','hydro partition vector for barystatic contribution');
98 fielddisplay(self,'partitionocean','ocean partition vector for barystatic contribution');
99 if isempty(self.external), fielddisplay(self,'external','external solution, of the type solidearthsolution'); end
100 self.settings.disp();
101 self.lovenumbers.disp();
102 self.rotational.disp();
103 if ~isempty(self.external),
104 self.external.disp();
105 end
106
107 end % }}}
108 function marshall(self,prefix,md,fid) % {{{
109
110 WriteData(fid,prefix,'object',self,'fieldname','planetradius','format','Double');
111 WriteData(fid,prefix,'object',self,'fieldname','transitions','format','MatArray');
112
113 if ~isempty(self.partitionice),
114 npartice=max(self.partitionice)+2;
115 else
116 npartice=0;
117 end
118 if ~isempty(self.partitionhydro),
119 nparthydro=max(self.partitionhydro)+2;
120 else
121 nparthydro=0;
122 end
123 if ~isempty(self.partitionocean),
124 npartocean=max(self.partitionocean)+2;
125 else
126 npartocean=0;
127 end
128
129
130
131 WriteData(fid,prefix,'object',self,'fieldname','partitionice','mattype',1,'format','DoubleMat');
132 WriteData(fid,prefix,'data',npartice,'format','Integer','name','md.solidearth.npartice');
133 WriteData(fid,prefix,'object',self,'fieldname','partitionhydro','mattype',1,'format','DoubleMat');
134 WriteData(fid,prefix,'data',nparthydro,'format','Integer','name','md.solidearth.nparthydro');
135 WriteData(fid,prefix,'object',self,'fieldname','partitionocean','mattype',1,'format','DoubleMat');
136 WriteData(fid,prefix,'data',npartocean,'format','Integer','name','md.solidearth.npartocean');
137
138 self.settings.marshall(prefix,md,fid);
139 self.lovenumbers.marshall(prefix,md,fid);
140 self.rotational.marshall(prefix,md,fid);
141 if ~isempty(self.external),
142 WriteData(fid,prefix,'data',1,'format','Integer','name','md.solidearth.isexternal');
143 self.external.marshall(prefix,md,fid);
144 else
145 WriteData(fid,prefix,'data',0,'format','Integer','name','md.solidearth.isexternal');
146 end
147
148 %process requested outputs
149 outputs = self.requested_outputs;
150 pos = find(ismember(outputs,'default'));
151 if ~isempty(pos),
152 outputs(pos) = []; %remove 'default' from outputs
153 outputs = [outputs defaultoutputs(self,md)]; %add defaults
154 end
155 WriteData(fid,prefix,'data',outputs,'name','md.solidearth.requested_outputs','format','StringArray');
156
157 end % }}}
158 function savemodeljs(self,fid,modelname) % {{{
159
160 self.settings.savemodeljs(fid,modelname);
161 self.lovenumbers.savemodeljs(fid,modelname);
162 self.rotational.savemodeljs(fid,modelname);
163 if ~isempty(self.external),
164 self.external.savemodeljs(fid,modelname);
165 end
166 writejscellstring(fid,[modelname '.solidearth.requested_outputs'],self.requested_outputs);
167 writejscellarray(fid,[modelname '.solidearth.transitions'],self.transitions);
168 writejscellarray(fid,[modelname '.solidearth.partition'],self.partition);
169 end % }}}
170 function self = extrude(self,md) % {{{
171 end % }}}
172 end
173end
Note: See TracBrowser for help on using the repository browser.