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

Last change on this file since 27308 was 27308, checked in by caronlam, 2 years ago

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