File: potentialCoefficients2Icgem.cpp

package info (click to toggle)
groops 0%2Bgit20250907%2Bds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: forky, sid
  • size: 11,140 kB
  • sloc: cpp: 135,607; fortran: 1,603; makefile: 20
file content (237 lines) | stat: -rw-r--r-- 10,031 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
/***********************************************/
/**
* @file potentialCoefficients2Icgem.cpp
*
* @brief Write spherical harmonics in ICGEM format.
*
* @author Torsten Mayer-Guerr
* @author Andreas Kvas
* @date 2005-01-19
*
*/
/***********************************************/

// Latex documentation
#define DOCSTRING docstring
static const char *docstring = R"(
Write spherical harmonics in ICGEM format.
GROOPS uses this format as default but this program enables
the possibility to include comments and set the modelname.
)";

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

#include "programs/program.h"
#include "inputOutput/file.h"
#include "files/fileSphericalHarmonics.h"

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

/** @brief Write spherical harmonics in ICGEM format.
* @ingroup programsConversionGroup */
class PotentialCoefficients2Icgem
{
public:
  void run(Config &config, Parallel::CommunicatorPtr comm);

  class Oscillation
  {
  public:
    FileName    fileNameCos, fileNameSin;
    std::string period;
    SphericalHarmonics harmCos, harmSin;
  };
};

GROOPS_REGISTER_PROGRAM(PotentialCoefficients2Icgem, SINGLEPROCESS, "write spherical harmonics in ICGEM format", Conversion, PotentialCoefficients)

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

template<> Bool readConfig(Config &config, const std::string &name, PotentialCoefficients2Icgem::Oscillation &var, Config::Appearance mustSet, const std::string &defaultValue, const std::string &annotation)
{
  try
  {
    if(!readConfigSequence(config, name, mustSet, defaultValue, annotation))
      return FALSE;
    readConfig(config, "inputfileCosPotentialCoefficients", var.fileNameCos, Config::MUSTSET,  "", "");
    readConfig(config, "inputfileSinPotentialCoefficients", var.fileNameSin, Config::MUSTSET,  "", "");
    readConfig(config, "period",                            var.period,      Config::MUSTSET, "1.0", "period of oscillation [year]");
    endSequence(config);
    return TRUE;
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

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

void PotentialCoefficients2Icgem::run(Config &config, Parallel::CommunicatorPtr /*comm*/)
{
  try
  {
    FileName                 fileNameOut;
    FileName                 fileNameStatic, fileNameTrend;
    FileName                 fileNameComments;
    std::string              modelname;
    std::vector<std::string> comment;
    std::vector<Oscillation> oscillation;
    std::string              choice;
    std::string              tides;
    UInt                     minDegree, maxDegree = INFINITYDEGREE;
    Double                   GM, R;
    Time                     time;

    readConfig(config, "outputfile",                     fileNameOut,      Config::MUSTSET,  "", "");
    readConfig(config, "inputfilePotentialCoefficients", fileNameStatic,   Config::MUSTSET,  "", "");
    readConfig(config, "inputfileTrend",                 fileNameTrend,    Config::OPTIONAL, "", "");
    readConfig(config, "oscillation",                    oscillation,      Config::OPTIONAL, "", "");
    readConfig(config, "comment",                        comment,          Config::OPTIONAL, "", "comment in header");
    readConfig(config, "inputfileComment",               fileNameComments, Config::OPTIONAL, "", "file containing comments for header");
    readConfig(config, "modelname",                      modelname,        Config::MUSTSET,  "", "name of the model");
    if(readConfigChoice(config, "tideSystem", choice,  Config::OPTIONAL, "", "tide system of model"))
    {
      if(readConfigChoiceElement(config, "zero_tide", choice)) tides = "zero_tide";
      if(readConfigChoiceElement(config, "tide_free", choice)) tides = "tide_free";
      endChoice(config);
    }
    readConfig(config, "minDegree",       minDegree,      Config::DEFAULT,  "0", "");
    readConfig(config, "maxDegree",       maxDegree,      Config::OPTIONAL, "",  "");
    readConfig(config, "GM",              GM,             Config::DEFAULT,  STRING_DEFAULT_GM, "Geocentric gravitational constant");
    readConfig(config, "R",               R,              Config::DEFAULT,  STRING_DEFAULT_R,  "reference radius");
    readConfig(config, "time",            time,           Config::OPTIONAL, "", "reference time");
    if(isCreateSchema(config)) return;

    // read potential coefficients
    // ---------------------------
    logStatus<<"read potential coefficients from file <"<<fileNameStatic<<">"<<Log::endl;
    SphericalHarmonics harm;
    readFileSphericalHarmonics(fileNameStatic, harm);
    harm = harm.get(maxDegree, minDegree, GM, R);

    SphericalHarmonics harmTrend;
    if(!fileNameTrend.empty())
    {
      logStatus<<"read potential coefficients from file <"<<fileNameTrend<<">"<<Log::endl;
      readFileSphericalHarmonics(fileNameTrend, harmTrend);
    }
    harmTrend = harmTrend.get(harm.maxDegree(), minDegree, GM, R);

    for(UInt i=0; i<oscillation.size(); i++)
    {
      logStatus<<"read potential coefficients from file <"<<oscillation.at(i).fileNameCos<<">"<<Log::endl;
      readFileSphericalHarmonics(oscillation.at(i).fileNameCos, oscillation.at(i).harmCos);
      oscillation.at(i).harmCos = oscillation.at(i).harmCos.get(harm.maxDegree(), minDegree, GM, R);

      logStatus<<"read potential coefficients from file <"<<oscillation.at(i).fileNameSin<<">"<<Log::endl;
      readFileSphericalHarmonics(oscillation.at(i).fileNameSin, oscillation.at(i).harmSin);
      oscillation.at(i).harmSin = oscillation.at(i).harmSin.get(harm.maxDegree(), minDegree, GM, R);
    }

    const Bool hasSigmas = (harm.sigma2cnm().size()) && ((quadsum(harm.sigma2cnm())+quadsum(harm.sigma2snm())) != 0);

    // description of data section
    // ---------------------------
    std::stringstream ssHeader;
    ssHeader<<"key     L    M         C                   S          ";
    if(hasSigmas)
      ssHeader<<"      sigma C             sigma S       ";
    if((!fileNameTrend.empty()) || oscillation.size())
      ssHeader<<" t0 [yyyymmdd]";
    if(oscillation.size())
      ssHeader<<"/period [y]";

    // Potentialkoeffizienten speichern
    // --------------------------------
    logStatus<<"writing potential coefficients to file <"<<fileNameOut<<">"<<Log::endl;
    OutFile file(fileNameOut);
    for(UInt i=0; i<comment.size(); i++)
      file<<comment.at(i)<<std::endl;
    if(!fileNameComments.empty())
    {
      InFile commentFile(fileNameComments);
      std::string line;
      while(std::getline(commentFile, line))
        file<<line<<std::endl;
    }
    if(comment.size() || !fileNameComments.empty())
      file<<std::endl;
    file<<"begin_of_head "<<std::string(ssHeader.str().size()-14, '=')<<std::endl<<std::endl;
    file<<"modelname              "<<modelname<<std::endl;
    file<<"product_type           gravity_field"<<std::endl;
    file<<"earth_gravity_constant "<<harm.GM()%"%16.10e"s<<std::endl;
    file<<"radius                 "<<harm.R() %"%16.10e"s<<std::endl;
    file<<"max_degree             "<<harm.maxDegree()<<std::endl;
    file<<"norm                   fully_normalized"<<std::endl;
    if(!tides.empty())
      file<<"tide_system            "<<tides<<std::endl;
    file<<"errors                 "<<((hasSigmas) ? "formal" : "no")<<std::endl;
    file<<std::endl;
    // end_of_head
    file<<ssHeader.str()<<std::endl;
    file<<"end_of_head "<<std::string(ssHeader.str().size()-12, '=')<<std::endl;

    std::string fdouble = "%20.12e";
    std::string fint    = "%5i";

    // data section
    // ------------
    for(UInt n=0; n<=harm.maxDegree(); n++)
      for(UInt m=0; m<=n; m++)
      {
        Bool hasTemporal = ((harmTrend.cnm()(n,m)!= 0.) || (harmTrend.snm()(n,m)!= 0.));
        for(UInt i=0; i<oscillation.size(); i++)
        {
          hasTemporal = hasTemporal || (oscillation.at(i).harmCos.cnm()(n,m)!= 0.) || (oscillation.at(i).harmCos.snm()(n,m)!= 0.);
          hasTemporal = hasTemporal || (oscillation.at(i).harmSin.cnm()(n,m)!= 0.) || (oscillation.at(i).harmSin.snm()(n,m)!= 0.);
        }

        // static coefficients
        file<<((hasTemporal) ? "gfct" : "gfc ");
        file<<n%fint<<m%fint;
        file<<harm.cnm()(n,m)%fdouble<<harm.snm()(n,m)%fdouble;
        if(hasSigmas)
          file<<sqrt(harm.sigma2cnm()(n,m))%fdouble<<sqrt(harm.sigma2snm()(n,m))%fdouble;
        if(hasTemporal)
          file<<" "<<time%"%y%m%d"s;
        file<<std::endl;

        // trend
        if((harmTrend.cnm()(n,m)!= 0.) || (harmTrend.snm()(n,m)!= 0.))
        {
          file<<"trnd"<<n%fint<<m%fint;
          file<<harmTrend.cnm()(n,m)%fdouble<<harmTrend.snm()(n,m)%fdouble;
          if(hasSigmas)
            file<<sqrt(harmTrend.sigma2cnm()(n,m))%fdouble<<sqrt(harmTrend.sigma2snm()(n,m))%fdouble;
          file<<std::endl;
        }

        // oscillations
        for(UInt i=0; i<oscillation.size(); i++)
          if((oscillation.at(i).harmCos.cnm()(n,m)!= 0.) ||
             (oscillation.at(i).harmCos.snm()(n,m)!= 0.) ||
             (oscillation.at(i).harmSin.cnm()(n,m)!= 0.) ||
             (oscillation.at(i).harmSin.snm()(n,m)!= 0.))
          {
            file<<"acos"<<n%fint<<m%fint;
            file<<oscillation.at(i).harmCos.cnm()(n,m)%fdouble<<oscillation.at(i).harmCos.snm()(n,m)%fdouble;
            if(hasSigmas)
              file<<sqrt(oscillation.at(i).harmCos.sigma2cnm()(n,m))%fdouble<<sqrt(oscillation.at(i).harmCos.sigma2snm()(n,m))%fdouble;
            file<<" "<<oscillation.at(i).period<<std::endl;

            file<<"asin"<<n%fint<<m%fint;
            file<<oscillation.at(i).harmSin.cnm()(n,m)%fdouble<<oscillation.at(i).harmSin.snm()(n,m)%fdouble;
            if(hasSigmas)
              file<<sqrt(oscillation.at(i).harmSin.sigma2cnm()(n,m))%fdouble<<sqrt(oscillation.at(i).harmSin.sigma2snm()(n,m))%fdouble;
            file<<" "<<oscillation.at(i).period<<std::endl;
          }
      } // for(n,m)
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

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