Debian Codegraph @

src/atlas/trans/detail/TransImpl.h

raw
1 /*
2 * (C) Copyright 2013 ECMWF.
3 *
4 * This software is licensed under the terms of the Apache Licence Version 2.0
5 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6 * In applying this licence, ECMWF does not waive the privileges and immunities
7 * granted to it by virtue of its status as an intergovernmental organisation
8 * nor does it submit to any jurisdiction.
9 */
10
11 #pragma once
12
13 #include "atlas/trans/Cache.h"
14 #include "atlas/util/Config.h"
15 #include "atlas/util/Object.h"
16
17 //-----------------------------------------------------------------------------
18 // Forward declarations
19
20 namespace atlas {
21 class Field;
22 class FieldSet;
23 class FunctionSpace;
24 class Grid;
25 class Domain;
26 namespace functionspace {
27 class Spectral;
28 }
29 } // namespace atlas
30
31 //-----------------------------------------------------------------------------
32
33 namespace atlas {
34 namespace trans {
35
36 //-----------------------------------------------------------------------------
37
38 class TransImpl : public util::Object {
39 public:
40 virtual std::string type() const { return "wrong value"; }
41
42 virtual ~TransImpl() = 0;
43
44 virtual int truncation() const = 0;
45
46 virtual size_t nb_spectral_coefficients() const = 0;
47
48 virtual size_t nb_spectral_coefficients_global() const = 0;
49
50 virtual const Grid& grid() const = 0;
51
52 virtual const functionspace::Spectral& spectral() const = 0;
53
54 virtual void dirtrans(const Field& gpfield, Field& spfield,
55 const eckit::Configuration& = util::NoConfig()) const = 0;
56
57 virtual void dirtrans(const FieldSet& gpfields, FieldSet& spfields,
58 const eckit::Configuration& = util::NoConfig()) const = 0;
59
60 virtual void dirtrans_wind2vordiv(const Field& gpwind, Field& spvor, Field& spdiv,
61 const eckit::Configuration& = util::NoConfig()) const = 0;
62
63 virtual void dirtrans_adj(const Field& spfield, Field& gpfield,
64 const eckit::Configuration& = util::NoConfig()) const = 0;
65
66 virtual void dirtrans_adj(const FieldSet& spfields, FieldSet& gpfields,
67 const eckit::Configuration& = util::NoConfig()) const = 0;
68
69 virtual void dirtrans_wind2vordiv_adj(const Field& spvor, const Field& spdiv, Field& gpwind,
70 const eckit::Configuration& = util::NoConfig()) const = 0;
71
72 virtual void invtrans(const Field& spfield, Field& gpfield,
73 const eckit::Configuration& = util::NoConfig()) const = 0;
74
75 virtual void invtrans(const FieldSet& spfields, FieldSet& gpfields,
76 const eckit::Configuration& = util::NoConfig()) const = 0;
77
78 virtual void invtrans_grad(const Field& spfield, Field& gradfield,
79 const eckit::Configuration& = util::NoConfig()) const = 0;
80
81 virtual void invtrans_grad(const FieldSet& spfields, FieldSet& gradfields,
82 const eckit::Configuration& = util::NoConfig()) const = 0;
83
84 virtual void invtrans_vordiv2wind(const Field& spvor, const Field& spdiv, Field& gpwind,
85 const eckit::Configuration& = util::NoConfig()) const = 0;
86
87 virtual void invtrans_adj(const Field& gpfield, Field& spfield,
88 const eckit::Configuration& = util::NoConfig()) const = 0;
89
90 virtual void invtrans_adj(const FieldSet& gpfields, FieldSet& spfields,
91 const eckit::Configuration& = util::NoConfig()) const = 0;
92
93 virtual void invtrans_grad_adj(const Field& gradfield, Field& gpfield,
94 const eckit::Configuration& = util::NoConfig()) const = 0;
95
96 virtual void invtrans_grad_adj(const FieldSet& gradfields, FieldSet& spfields,
97 const eckit::Configuration& = util::NoConfig()) const = 0;
98
99 virtual void invtrans_vordiv2wind_adj(const Field& gpwind, Field& spvor, Field& spdiv,
100 const eckit::Configuration& = util::NoConfig()) const = 0;
101
102 // -- IFS type fields --
103 // These fields have special interpretation required. You need to know what
104 // you're doing.
105 // See IFS trans library.
106
107 /*!
108 * @brief invtrans
109 * @param nb_scalar_fields
110 * @param scalar_spectra
111 * @param nb_vordiv_fields
112 * @param vorticity_spectra
113 * @param divergence_spectra
114 * @param gp_fields
115 */
116 virtual void invtrans(const int nb_scalar_fields, const double scalar_spectra[], const int nb_vordiv_fields,
117 const double vorticity_spectra[], const double divergence_spectra[], double gp_fields[],
118 const eckit::Configuration& = util::NoConfig()) const = 0;
119
120 /*!
121 * @brief invtrans
122 * @param nb_fields
123 * @param scalar_spectra
124 * @param scalar_fields
125 */
126 virtual void invtrans(const int nb_scalar_fields, const double scalar_spectra[], double gp_fields[],
127 const eckit::Configuration& = util::NoConfig()) const = 0;
128
129 /*!
130 * @brief Inverse transform of vorticity/divergence to wind(U/V)
131 * @param nb_fields [in] Number of fields ( both components of wind count as 1
132 * )
133 */
134 virtual void invtrans(const int nb_vordiv_fields, const double vorticity_spectra[],
135 const double divergence_spectra[], double gp_fields[],
136 const eckit::Configuration& = util::NoConfig()) const = 0;
137
138 /*!
139 * @brief invtrans_adj
140 * @param nb_scalar_fields
141 * @param scalar_spectra
142 * @param nb_vordiv_fields
143 * @param vorticity_spectra
144 * @param divergence_spectra
145 * @param gp_fields
146 */
147 virtual void invtrans_adj(const int nb_scalar_fields, const double gp_fields[], const int nb_vordiv_fields,
148 double vorticity_spectra[], double divergence_spectra[], double scalar_spectra[],
149 const eckit::Configuration& = util::NoConfig()) const = 0;
150
151 /*!
152 * @brief invtrans_adj
153 * @param nb_fields
154 * @param scalar_spectra
155 * @param scalar_fields
156 */
157 virtual void invtrans_adj(const int nb_scalar_fields, const double gp_fields[], double scalar_spectra[],
158 const eckit::Configuration& = util::NoConfig()) const = 0;
159
160 /*!
161 * @brief Adjoint of Inverse transform of vorticity/divergence to wind(U/V)
162 * @param nb_fields [in] Number of fields ( both components of wind count as 1
163 * )
164 */
165 virtual void invtrans_adj(const int nb_vordiv_fields, const double wind_fields[], double vorticity_spectra[],
166 double divergence_spectra[], const eckit::Configuration& = util::NoConfig()) const = 0;
167
168
169 /*!
170 * @brief Direct transform of scalar fields
171 */
172 virtual void dirtrans(const int nb_fields, const double scalar_fields[], double scalar_spectra[],
173 const eckit::Configuration& = util::NoConfig()) const = 0;
174
175 /*!
176 * @brief Direct transform of wind(U/V) to vorticity/divergence
177 * @param nb_fields [in] Number of fields ( both components of wind count as 1
178 * )
179 */
180 virtual void dirtrans(const int nb_fields, const double wind_fields[], double vorticity_spectra[],
181 double divergence_spectra[], const eckit::Configuration& = util::NoConfig()) const = 0;
182
183
184 // deprecated
185 virtual size_t spectralCoefficients() const { return nb_spectral_coefficients(); }
186
187 private:
188 friend class TransInterface;
189 // Only for TransIFS backend
190 virtual int handle() const;
191 };
192
193 //----------------------------------------------------------------------------------------------------------------------
194
195 } // namespace trans
196 } // namespace atlas