File: satelliteModelCreate.cpp

package info (click to toggle)
groops 0%2Bgit20240830%2Bds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: trixie
  • size: 11,052 kB
  • sloc: cpp: 134,939; fortran: 1,569; makefile: 20
file content (272 lines) | stat: -rw-r--r-- 11,750 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
/***********************************************/
/**
* @file satelliteModelCreate.cpp
*
* @brief Create satellite macro model.
*
* @author Torsten Mayer-Guerr
* @author Sandro Krauss
* @date 2015-27-05
*/
/***********************************************/

// Latex documentation
#define DOCSTRING docstring
static const char *docstring = R"(
This program creates a satellite macro model for the estimation of non-gravitational accelerations acting on a satellite.
Mandatory input values are the \config{satelliteName}, \config{mass}, \config{coefficientDrag} and information
about the satellite \config{surfaces}. For low Earth orbiting satellites, like GRACE for instance, a good guess
for the drag coefficient could be 2.3. Apart from that, it is latter on possible to estimate a more precise variable drag coefficient
(e.g. \configClass{miscAccelerations:atmosphericDrag}{miscAccelerationsType:atmosphericDrag}), which will override this initial guess.
Concerning the satellite surfaces an external file must be imported which must contain information about each single
 satellite plate in terms of plate \config{area}, the associated plate normal and re-radiation properties
(reflexion, diffusion and absorption) properties in the visible and IR part. Examplarily, a description of
the macro model for GRACE can be found under:
\url{https://podaac-tools.jpl.nasa.gov/drive/files/allData/grace/docs/ProdSpecDoc_v4.6.pdf}
Additionally, it is possible to add further information like antennaThrust, solar panel, temporal mass changes and
massInstrument using the modules option.
)";

/***********************************************/

#include "programs/program.h"
#include "parser/dataVariables.h"
#include "files/fileMatrix.h"
#include "files/fileInstrument.h"
#include "files/fileSatelliteModel.h"

/***** CLASS ***********************************/

/** @brief Create satellite macro model.
* @ingroup programsGroup */
class SatelliteModelCreate
{
public:
  void run(Config &config, Parallel::CommunicatorPtr comm);
};

GROOPS_REGISTER_PROGRAM(SatelliteModelCreate, SINGLEPROCESS, "Create satellite macro model.", Misc)

/***********************************************/

template<> Bool readConfig(Config &config, const std::string &name, SatelliteModelModulePtr &var, Config::Appearance mustSet, const std::string &defaultValue, const std::string &annotation)
{
  try
  {
    std::string choice;
    if(!readConfigChoice(config, name, choice, mustSet, defaultValue, annotation))
      return FALSE;

    // Antenna thrust
    // --------------
    if(readConfigChoiceElement(config, "antennaThrust", choice, ""))
    {
      SatelliteModelModuleAntennaThrust *modul = new SatelliteModelModuleAntennaThrust;
      var = SatelliteModelModulePtr(modul);

      readConfig(config, "thrustX", modul->thrust.x(), Config::DEFAULT,  "0", "");
      readConfig(config, "thrustY", modul->thrust.y(), Config::DEFAULT,  "0", "");
      readConfig(config, "thrustZ", modul->thrust.z(), Config::DEFAULT,  "0", "");
    }

    // Solar Panel
    // -----------
    if(readConfigChoiceElement(config, "solarPanel", choice, ""))
    {
      SatelliteModelModuleSolarPanel *modul = new SatelliteModelModuleSolarPanel;
      var = SatelliteModelModulePtr(modul);

      readConfig(config, "rotationAxisX", modul->rotationAxis.x(), Config::DEFAULT,  "0", "");
      readConfig(config, "rotationAxisY", modul->rotationAxis.y(), Config::DEFAULT,  "0", "");
      readConfig(config, "rotationAxisZ", modul->rotationAxis.z(), Config::DEFAULT,  "0", "");
      readConfig(config, "normalX",       modul->normal.x(),       Config::DEFAULT,  "0", "Direction to sun");
      readConfig(config, "normalY",       modul->normal.y(),       Config::DEFAULT,  "0", "Direction to sun");
      readConfig(config, "normalZ",       modul->normal.z(),       Config::DEFAULT,  "0", "Direction to sun");
      readConfig(config, "indexSurface",  modul->indexSurface,     Config::MUSTSET,   "", "index of solar panel surfaces");
    }

    // Satellite mass change
    // ---------------------
    if(readConfigChoiceElement(config, "massChange", choice, ""))
    {
      SatelliteModelModuleMassChange *modul = new SatelliteModelModuleMassChange;
      var = SatelliteModelModulePtr(modul);

      readConfig(config, "time", modul->times, Config::MUSTSET,  "", "");
      readConfig(config, "mass", modul->mass,  Config::MUSTSET,  "", "");
    }

    // Satellite mass change
    // ---------------------
    if(readConfigChoiceElement(config, "massInstrument", choice, ""))
    {
      std::vector<FileName> fileName;
      readConfig(config, "inputfileInstrument", fileName, Config::MUSTSET,  "", "");

      if(!isCreateSchema(config))
      {
        MassArc massArc;
        for(UInt i=0; i<fileName.size(); i++)
          massArc.append(InstrumentFile::read(fileName.at(i)));
        massArc.sort();

        SatelliteModelModuleMassChange *modul = new SatelliteModelModuleMassChange;
        var = SatelliteModelModulePtr(modul);
        for(UInt i=0; i<massArc.size(); i++)
          if(massArc.at(i).massThr > 0.0)
          {
            modul->times.push_back(massArc.at(i).time);
            modul->mass.push_back(massArc.at(i).massThr);
          }
      }
    }

    endChoice(config);

    return TRUE;
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/

template<> Bool readConfig(Config &config, const std::string &name, std::vector<SatelliteModel::Surface> &surfaces, Config::Appearance mustSet, const std::string &defaultValue, const std::string &annotation)
{
  try
  {
    if(!readConfigSequence(config, name, mustSet, defaultValue, annotation))
      return FALSE;

    FileName fileNameIn;
    ExpressionVariablePtr typeExpr, areaExpr;
    ExpressionVariablePtr normalXExpr, normalYExpr, normalZExpr;
    ExpressionVariablePtr absorptionVisibleExpr, diffusionVisibleExpr, reflexionVisibleExpr;
    ExpressionVariablePtr absorptionInfraredExpr, diffusionInfraredExpr, reflexionInfraredExpr;
    ExpressionVariablePtr specificHeatCapacityExpr;

    readConfig(config, "inputfile",            fileNameIn,               Config::MUSTSET, "",       "each line must contain one surface element");
    readConfig(config, "type",                 typeExpr,                 Config::MUSTSET, "0",      "0: plate, 1: sphere, 2: cylinder");
    readConfig(config, "area",                 areaExpr,                 Config::MUSTSET, "data0",  "[m^2]");
    readConfig(config, "normalX",              normalXExpr,              Config::MUSTSET, "data1",  "");
    readConfig(config, "normalY",              normalYExpr,              Config::MUSTSET, "data2",  "");
    readConfig(config, "normalZ",              normalZExpr,              Config::MUSTSET, "data3",  "");
    readConfig(config, "reflexionVisible",     reflexionVisibleExpr,     Config::MUSTSET, "data4",  "");
    readConfig(config, "diffusionVisible",     diffusionVisibleExpr,     Config::MUSTSET, "data5",  "");
    readConfig(config, "absorptionVisible",    absorptionVisibleExpr,    Config::MUSTSET, "data6",  "");
    readConfig(config, "reflexionInfrared",    reflexionInfraredExpr,    Config::MUSTSET, "data7",  "");
    readConfig(config, "diffusionInfrared",    diffusionInfraredExpr,    Config::MUSTSET, "data8",  "");
    readConfig(config, "absorptionInfrared",   absorptionInfraredExpr,   Config::MUSTSET, "data9",  "");
    readConfig(config, "specificHeatCapacity", specificHeatCapacityExpr, Config::MUSTSET, "data10", "0: no thermal radiation, -1: direct reemission [Ws/K/m^2]");
    endSequence(config);
    if(isCreateSchema(config))
      return TRUE;

    // read data
    // ---------
    logStatus<<"read input from <"<<fileNameIn<<">"<<Log::endl;
    Matrix data;
    readFileMatrix(fileNameIn, data);

    // calculate output
    // -----------------
    VariableList varList;
    addDataVariables(data, varList);
    surfaces.resize(data.rows());
    for(UInt i=0; i<data.rows(); i++)
    {
      evaluateDataVariables(data, i, varList);

      // evaluate expression
      surfaces.at(i).type                 = static_cast<SatelliteModel::Surface::Type>(typeExpr->evaluate(varList));
      surfaces.at(i).area                 = areaExpr                ->evaluate(varList);
      surfaces.at(i).normal.x()           = normalXExpr             ->evaluate(varList);
      surfaces.at(i).normal.y()           = normalYExpr             ->evaluate(varList);
      surfaces.at(i).normal.z()           = normalZExpr             ->evaluate(varList);
      surfaces.at(i).absorptionVisible    = absorptionVisibleExpr   ->evaluate(varList);
      surfaces.at(i).diffusionVisible     = diffusionVisibleExpr    ->evaluate(varList);
      surfaces.at(i).reflexionVisible     = reflexionVisibleExpr    ->evaluate(varList);
      surfaces.at(i).absorptionInfrared   = absorptionInfraredExpr  ->evaluate(varList);
      surfaces.at(i).diffusionInfrared    = diffusionInfraredExpr   ->evaluate(varList);
      surfaces.at(i).reflexionInfrared    = reflexionInfraredExpr   ->evaluate(varList);
      surfaces.at(i).specificHeatCapacity = specificHeatCapacityExpr->evaluate(varList);

      surfaces.at(i).normal.normalize();
    }

    return TRUE;
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/

template<> Bool readConfig(Config &config, const std::string &name, SatelliteModelPtr &satellite, Config::Appearance mustSet, const std::string &defaultValue, const std::string &annotation)
{
  try
  {
    if(!readConfigSequence(config, name, mustSet, defaultValue, annotation))
      return FALSE;

    satellite = SatelliteModelPtr(new SatelliteModel);

    renameDeprecatedConfig(config, "modul", "module", date2time(2020, 8, 20));

    readConfig(config, "satelliteName",   satellite->satelliteName,   Config::MUSTSET,  "", "");
    readConfig(config, "mass",            satellite->mass,            Config::MUSTSET,  "", "");
    readConfig(config, "coefficientDrag", satellite->coefficientDrag, Config::MUSTSET,  "", "");
    readConfig(config, "surfaces",        satellite->surfaces,        Config::MUSTSET,  "", "");
    readConfig(config, "module",          satellite->modules,         Config::OPTIONAL, "", "");
    endSequence(config);

    // extra module to set specificHeatCapacity without changing the file format
    if(std::any_of(satellite->surfaces.begin(), satellite->surfaces.end(), [](auto &x) {return x.specificHeatCapacity > 0;}))
    {
      auto module = std::make_shared<SatelliteModelModuleSetSpecificHeatCapacity>();
      for(UInt i=0; i<satellite->surfaces.size(); i++)
        if(satellite->surfaces.at(i).specificHeatCapacity > 0)
        {
          module->specificHeatCapacity.push_back(satellite->surfaces.at(i).specificHeatCapacity);
          module->indexSurface.push_back(i);
        }
      satellite->modules.push_back(module);
    }

    return TRUE;
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/

void SatelliteModelCreate::run(Config &config, Parallel::CommunicatorPtr /*comm*/)
{
  try
  {
    FileName fileNameOut;
    std::vector<SatelliteModelPtr> satellites;

    readConfig(config, "outputfileSatelliteModel", fileNameOut, Config::MUSTSET,  "", "");
    readConfig(config, "satellite",                satellites,  Config::MUSTSET,  "", "");
    if(isCreateSchema(config)) return;

    // write file
    // ----------
    logStatus<<"write satellite model file <"<<fileNameOut<<">"<<Log::endl;
    writeFileSatelliteModel(fileNameOut, satellites);
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/