ARTS  2.0.49
workspace.cc
Go to the documentation of this file.
1 /* Copyright (C) 2000-2008
2  Stefan Buehler <sbuehler@ltu.se>
3  Patrick Eriksson <patrick.eriksson@chalmers.se>
4 
5  This program is free software; you can redistribute it and/or modify it
6  under the terms of the GNU General Public License as published by the
7  Free Software Foundation; either version 2, or (at your option) any
8  later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with this program; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18  USA. */
19 
34 #include "arts.h"
35 #include "matpackI.h"
36 #include "matpackII.h"
37 #include "matpackIII.h"
38 #include "matpackVI.h"
39 #include "array.h"
40 #include "wsv_aux.h"
41 #include "ppath.h"
42 #include "workspace_ng.h"
43 
44 // Some #defines to make the records better readable:
45 #define NAME(x) x
46 #define DESCRIPTION(x) x
47 #define GROUP(x) x
48 
49 
50 void Workspace::define_wsv_data()
51 {
52 
53  //--------------------< Build the wsv data >--------------------
54  // Initialize to empty, just in case.
55  wsv_data.resize(0);
56 
57 /* Templace record entry:
58 
59  wsv_data.push_back
60  (WsvRecord
61  ( NAME( "workspace_variable_name" ),
62  DESCRIPTION
63  (
64  "Brief description of the variable (1 line).\n"
65  "\n"
66  "Detailed description of the variable. Don't be too short here,\n"
67  "this is the main place where your documentation should be. I\n"
68  "really recommend to edit this in a text buffer, so that you can\n"
69  "do some re-formatting until it looks nice. Only at the end put it\n"
70  "in quotes and add the line breaks.\n"
71  "\n"
72  "Use blank lines to separate paragraphs. There really should be a\n"
73  "detailed descriptions of all component of your variable, if it\n"
74  "has a complicated type. Also some detailed discussion of the\n"
75  "dimensions if necessary. Also some detailed discussion of the\n"
76  "members if your variable is a structure.\n"
77  "\n"
78  "Usage: Set by user (or "Method output.")\n"
79  "\n"
80  "Units: E.g., kg/m\n"
81  "\n"
82  "Dimensions: [ first dimension, second dimension, ... ]\n"
83  "or\n"
84  "Size: [ .., nrows, ncols ]\n"
85  "\n"
86  "Members: Here you would list the members if your\n"
87  " variable is a structure.\n"
88  "\n"
89  "Dimensions: [x, y]\n"
90  "\n"
91  "Unit: Which unit this variable uses\n"
92  "\n"
93  "Give the keywords above only if they apply, i.e., Members only\n"
94  "for a structure, Units only for a physical variable.\n"
95  "Use either Dimensions or Size, depending on what is most appropiate\n"
96  "for the variable.\n"
97  ),
98  GROUP( "VariableType" )));
99 
100 */
101 
102 
103 
104  /*----------------------------------------------------------------------
105  Let's put in the variables in alphabetical order. This gives a clear
106  rule for where to place a new variable and this gives a nicer
107  results when the methods are listed by "arts -w all". No
108  distinction is made between uppercase and lowercase letters. The
109  sign "_" comes after all letters.
110  Patrick Eriksson 2002-05-08
111  ----------------------------------------------------------------------*/
112 
113  // New name: abs_coef
114  wsv_data.push_back
115  (WsvRecord
116  ( NAME( "abs_coef" ),
117  DESCRIPTION
118  (
119  "The matrix of total absorption coefficients.\n"
120  "\n"
121  "This variable is not used explicitly in a standard calculation, where\n"
122  "absorption comes from the lookup table *abs_lookup*. However, it is\n"
123  "useful for testing the methods that actually calculate line-by-line\n"
124  "absorption, which have this variable as output. These methods are\n"
125  "called internally by the method *abs_lookupCreate*, which generates\n"
126  "the lookup table.\n"
127  "\n"
128  "Dimensions: [f_grid, abs_p]\n"
129  "\n"
130  "Unit: 1/m\n"
131  ),
132  GROUP( "Matrix" )));
133 
134  wsv_data.push_back
135  (WsvRecord
136  (NAME( "abs_coef_per_species" ),
137  DESCRIPTION
138  (
139  "These are the absorption coefficients individually for each\n"
140  "tag group. The Array contains one matrix for each tag group,\n"
141  "the matrix format is the same as that of abs_coef\n"
142  ),
143  GROUP( "ArrayOfMatrix" )));
144 
145 // wsv_data.push_back
146 // (WsvRecord
147 // ( NAME( "abs_coef_agenda" ),
148 // DESCRIPTION
149 // (
150 // "See agendas.cc.\n"
151 // ),
152 // GROUP( "Agenda" )));
153 
154  wsv_data.push_back
155  (WsvRecord
156  (NAME( "abs_cont_models" ),
157  DESCRIPTION
158  (
159  "Continuum / full model absorption model description parameter.\n"
160  "See the WSV `abs_cont_names' for a detailed description\n"
161  "of the allowed continuum models. There should be one string here\n"
162  "for each entry in `abs_cont_names'.See also the online\n"
163  "documentation in arts/doc/doxygen/html/continua_cc.html.\n"
164  ),
165  GROUP( "ArrayOfString" )));
166 
167  wsv_data.push_back
168  (WsvRecord
169  (NAME( "abs_cont_names" ),
170  DESCRIPTION
171  (
172  "Continuum / full model absorption tag names. This variable should\n"
173  "contain a list of tag names of continuum and full models, respectively.\n"
174  "Associated with this WSV is the WSV\n"
175  "`abs_cont_models' which contains the specific model version of\n"
176  "each continuum / full model absorption tag and the WSV\n"
177  "`abs_cont_parameters' which should contain the continuum / full model\n"
178  "user defined parameters. The user defined parameters are only used when\n"
179  "the specified model is 'user'. See also the online documentation in\n"
180  "arts/doc/doxygen/html/continua_cc.html.\n"
181  "\n"
182  "The following full water vapor models are implemented:\n"
183  "'H2O-MPM87': absorption model (line and continuum) according to \n"
184  " H. J. Liebe,\n"
185  " A contribution to modeling atmospheric millimeter-wave properties,\n"
186  " Frequenz, 41, 1987, 31-36\n"
187  " and\n"
188  " H. J. Liebe and D. H. Layton,\n"
189  " Millimeter-wave properties of the atmosphere:\n"
190  " Laboratory studies and propagation modeling,\n"
191  " U.S. Dept. of Commerce, National Telecommunications and Information\n"
192  " Administration, Institute for Communication Sciences,\n"
193  " 325 Broadway, Boulder, CO 80303-3328, report 87224.\n"
194  "'H2O-MPM89': absorption model (line and continuum) according to \n"
195  " H. J. Liebe,\n Int. J. Infrared and Millimeter Waves, 10(6), 1989, 631\n"
196  "'H2O-MPM93': absorption model (line and continuum) according to \n"
197  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
198  " Propagation modeling of moist air and suspended water/ice\n"
199  " particles at frequencies below 1000 GHz,\n"
200  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
201  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21 \n"
202  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
203  "'H2O-CP98': absorption model (line and continuum) according to \n"
204  " S. L. Cruz-Pol et al.,\n Radio Science, 33(5), 1319, 1998"
205  " (ece.uprm.edu/~pol/Atmosphere.html)\n"
206  "'H2O-PWR98': absorption model (line and continuum) according to \n"
207  " P. W. Rosenkranz,\n "
208  " Radio Science, 33(4), 919, 1998, Radio Science, 34(4), 1025, 1999\n"
209  " (ftp: mesa.mit.edu/phil/lbl_rt).\n"
210  "\n"
211  "The following full oxygen models are implemented:\n"
212  "'O2-MPM93': absorption model (line and continuum) according to\n"
213  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
214  " Propagation modeling of moist air and suspended water/ice\n"
215  " particles at frequencies below 1000 GHz,\n"
216  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
217  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
218  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
219  "'O2-PWR93': absorption model (line and continuum) according to \n"
220  " P. W. Rosenkranz,\n Chapter 2, in M. A. Janssen, \n"
221  " Atmospheric Remote Sensing by Microwave Radiometry\n"
222  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
223  "\n"
224  "The following continuum parameterizations are implemented:\n"
225  "H2O-H2O ('H2O-SelfContStandardType'):\n"
226  " P. W. Rosenkranz, \n"
227  " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
228  " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
229  "H2O-air ('H2O-ForeignContStandardType'): \n"
230  " P. W. Rosenkranz, \n"
231  " Radio Science, Vol. 33, No 4, Pages 919-928, 1998 and \n"
232  " Radio Science, Vol. 34, No 4, Page 1025, 1999 (mesa.mit.edu/phil/lbl_rt)\n"
233  "H2O-air ('H2O-ContMPM93'): \n"
234  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
235  " Propagation modeling of moist air and suspended water/ice\n"
236  " particles at frequencies below 1000 GHz,\n"
237  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
238  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
239  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
240  "O2-air ('O2-SelfContStandardType'):\n"
241  " P. W. Rosenkranz,\n"
242  " Chapter 2, in M. A. Janssen,\n"
243  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
244  " John Wiley & Sons, Inc., 1993\n"
245  " (mesa.mit.edu/phil/lbl_rt)\n"
246  " and also described in \n"
247  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
248  " Propagation modeling of moist air and suspended water/ice\n"
249  " particles at frequencies below 1000 GHz,\n"
250  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
251  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
252  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
253  "N2-N2 ('N2-SelfContStandardType'):\n"
254  " The functional form of Rosenkranz but with more input parameters.\n"
255  " P. W. Rosenkranz,\n"
256  " Chapter 2, in M. A. Janssen,\n"
257  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
258  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
259  "N2-N2 ('N2-SelfContMPM93'):\n"
260  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
261  " Propagation modeling of moist air and suspended water/ice\n"
262  " particles at frequencies below 1000 GHz,\n"
263  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
264  " Propagation Panel, Palma de Mallorca, Spain, 1993, May 17-21 \n"
265  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
266  "CO2-CO2 ('CO2-SelfContPWR93'):\n"
267  " P. W. Rosenkranz,\n"
268  " Chapter 2, in M. A. Janssen,\n"
269  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
270  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
271  "CO2-N2 ('CO2-ForeignContPWR93'):\n"
272  " P. W. Rosenkranz,\n"
273  " Chapter 2, in M. A. Janssen,\n"
274  " Atmospheric Remote Sensing by Microwave Radiometry,\n"
275  " John Wiley & Sons, Inc., 1993 (mesa.mit.edu/phil/lbl_rt)\n"
276  "\n"
277  "The following cloud absorption models are implemented:\n"
278  "Suspended water droplet ('liquidcloud-MPM93') \n"
279  " absorption parameterization from the MPM93 model:\n"
280  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
281  " Propagation modeling of moist air and suspended water/ice\n"
282  " particles at frequencies below 1000 GHz,\n"
283  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
284  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
285  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
286  "Ice water droplet absorption ('icecloud-MPM93') \n"
287  " parameterization from MPM93 model:\n"
288  " H. J. Liebe and G. A. Hufford and M. G. Cotton,\n"
289  " Propagation modeling of moist air and suspended water/ice\n"
290  " particles at frequencies below 1000 GHz,\n"
291  " AGARD 52nd Specialists Meeting of the Electromagnetic Wave\n"
292  " Propagation Panel,\n Palma de Mallorca, Spain, 1993, May 17-21\n"
293  " (ftp.its.bldrdoc.gov/pub/mpm93/)\n"
294  "\n"
295  "The following rain extinction model is implemented:\n"
296  "Rain extinction parameterization ('rain-MPM93') from the\n"
297  " MPM93 model, described in:\n"
298  " H. J. Liebe,\n"
299  " MPM - An Atmospheric Millimeter-Wave Propagation Model,\n"
300  " Int. J. Infrared and Millimeter Waves, vol. 10(6),\n"
301  " pp. 631-650, 1989;\n"
302  " and based on:\n"
303  " Olsen, R.L., D.V. Rogers, and D. B. Hodge,\n"
304  " The aR^b relation in the calculation of rain attenuation,\n"
305  " IEEE Trans. Antennas Propagat., vol. AP-26, pp. 318-329, 1978.\n"
306  " IMPORTANT NOTE: rain-MPM93 parameterizes the EXTINCTION by rain,\n"
307  " not just the absorption. Therefore it is not suitable for \n"
308  " calculating thermal emission by rain!\n"
309  " Please use rain-MPM93 only for calculation of attenuation.\n"
310  ),
311  GROUP( "ArrayOfString" )));
312 
313  wsv_data.push_back
314  (WsvRecord
315  (NAME( "abs_cont_parameters" ),
316  DESCRIPTION
317  (
318  "Continuum model parameters. See the WSV *abs_cont_names*\n"
319  "for a detailed description of the allowed continuum models. There\n"
320  "should be one parameter vector here for each entry in\n"
321  "*abs_cont_names*. See also the online documentation in\n"
322  "arts/doc/doxygen/html/continua_cc.html.\n"
323  ),
324  GROUP( "ArrayOfVector" )));
325 
326  wsv_data.push_back
327  (WsvRecord
328  (NAME( "abs_h2o" ),
329  DESCRIPTION
330  (
331  "The total water profile associated with the pressures in *abs_p* [-]\n"
332  ),
333  GROUP( "Vector" )));
334 
335  wsv_data.push_back
336  (WsvRecord
337  ( NAME( "abs_lines" ),
338  DESCRIPTION
339  (
340  "A list of spectral line data.\n"
341  ),
342  GROUP( "ArrayOfLineRecord" )));
343 
344  wsv_data.push_back
345  (WsvRecord
346  ( NAME( "abs_lineshape" ),
347  DESCRIPTION
348  (
349  "Lineshape specification: function, norm, cutoff. There is one entry for\n"
350  "each abs_tag, not for each species. This means if you have several\n"
351  "abs_tags for different isotopes or transitions of a species, you\n"
352  "may use different lineshapes.\n"
353  ),
354  GROUP( "ArrayOfLineshapeSpec" )));
355 
356  wsv_data.push_back
357  (WsvRecord
358  ( NAME( "abs_lines_per_species" ),
359  DESCRIPTION
360  (
361  "A list of spectral line data for each tag.\n"
362  "Dimensions: (tag_groups.nelem()) (# of lines for this tag)\n"
363  ),
364  GROUP( "ArrayOfArrayOfLineRecord" )));
365 
366  wsv_data.push_back
367  (WsvRecord
368  ( NAME( "abs_lookup" ),
369  DESCRIPTION
370  (
371  "An absorption lookup table.\n"
372  "\n"
373  "This holds an absorption lookup table, as well as all information that\n"
374  "is necessary to use the table to extract absorption. Extraction\n"
375  "routines are implemented as member functions. \n"
376  "\n"
377  "This has quite a complicated structure. See Doxygen documentation for\n"
378  "class GasAbsLookup for details. See also the Arts User Guide, \n"
379  "Chapter 3.1 (\"The gas absorption lookup table\").\n"
380  ),
381  GROUP( "GasAbsLookup" )));
382 
383  wsv_data.push_back
384  (WsvRecord
385  ( NAME( "abs_nls" ),
386  DESCRIPTION
387  (
388  "Nonlinear species for absorption lookup table generation.\n"
389  "\n"
390  "A list of absorption species that should be treated non-linearly.\n"
391  "This means that the H2O VMR should be varied when calculating the\n"
392  "lookup table for those species.\n"
393  "\n"
394  "A typical example is for this to containt the Rosenkranz full\n"
395  "absorption model species for water vapor and oxygen \n"
396  "([\"H2O-PWR98\", \"O2-PWR93\"]).\n"
397  "\n"
398  "It only makes sense to put a species here if is either a water vapor\n"
399  "species, or some other species that uses *abs_h2o*, that is, for which\n"
400  "the absorption coefficient depends directly on water vapor.\n"
401  "\n"
402  "See user guide and online documentation of *abs_pts* and *abs_lookupCreate*\n"
403  "for more details and usage examples.\n"
404  ),
405  GROUP( "ArrayOfArrayOfSpeciesTag" )));
406 
407  wsv_data.push_back
408  (WsvRecord
409  ( NAME( "abs_nls_pert" ),
410  DESCRIPTION
411  (
412  "Fractional perturbations for the nonlinear species in the absorption\n"
413  "lookup table.\n"
414  "\n"
415  "This is a vector of fractional perturbations that should contain 1\n"
416  "(the unperturbed reference profile). A value of 0 may lead to error\n"
417  "messages from some absorption routines, so a possible content for this\n"
418  "variable is: [1e-24, 1, 2].\n"
419  "(This is similar to *abs_t_pert*, but multiplicative, not additive.)\n"
420  ),
421  GROUP( "Vector" )));
422 
423  wsv_data.push_back
424  (WsvRecord
425  ( NAME( "abs_nls_interp_order" ),
426  DESCRIPTION
427  (
428  "The interpolation order to use when interpolating absorption between\n"
429  "the H2O values given by *abs_nls_pert*. This is used by methods\n"
430  "extracting absorption coefficients from the lookup table, and by\n"
431  "methods setting up parameters for lookup table generation. Has a\n"
432  "default value, which is set in general.arts.\n"
433  "\n"
434  "Note that the number of points used in the interpolation scheme is\n"
435  "interpolation order + 1 (e.g., two for first order interpolation).\n"
436  ),
437  GROUP( "Index" )));
438 
439  wsv_data.push_back
440  (WsvRecord
441  ( NAME( "abs_p_interp_order" ),
442  DESCRIPTION
443  (
444  "The interpolation order to use when interpolating absorption\n"
445  "between pressure levels. This is used by methods extracting\n"
446  "absorption coefficients from the lookup table, and by methods\n"
447  "setting up parameters for lookup table generation. Has a\n"
448  "default value, which is set in general.arts.\n"
449  "\n"
450  "Note that the number of points used in the interpolation scheme is\n"
451  "interpolation order + 1 (e.g., two for first order interpolation).\n"
452  ),
453  GROUP( "Index" )));
454 
455  wsv_data.push_back
456  (WsvRecord
457  ( NAME( "abs_t_pert" ),
458  DESCRIPTION
459  (
460  "Temperature perturbations for the absorption lookup table.\n"
461  "\n"
462  "This is a vector containing temperature perturbations (in Kelvin) that\n"
463  "should be added to the reference temperature profile. (Similar to\n"
464  "*abs_nls_pert*, but additive, not multiplicative.) Should normally\n"
465  "contain 0, to include the reference profile itself. Example content:\n"
466  "[-5, 0, 5].\n"
467  ),
468  GROUP( "Vector" )));
469 
470  wsv_data.push_back
471  (WsvRecord
472  ( NAME( "abs_t_interp_order" ),
473  DESCRIPTION
474  (
475  "The interpolation order to use when interpolating absorption between\n"
476  "the temperature values given by *abs_t_pert*. This is used by methods\n"
477  "extracting absorption coefficients from the lookup table, and by\n"
478  "methods setting up parameters for lookup table generation. Has a\n"
479  "default value, which is set in general.arts.\n"
480  "\n"
481  "Note that the number of points used in the interpolation scheme is\n"
482  "interpolation order + 1 (e.g., two for first order interpolation).\n"
483  ),
484  GROUP( "Index" )));
485 
486  wsv_data.push_back
487  (WsvRecord
488  ( NAME( "abs_lookup_is_adapted" ),
489  DESCRIPTION
490  (
491  "Flag to indicate whether *abs_lookupAdapt* has already been\n"
492  "called.\n"
493  "\n"
494  "Values: 0=false, 1=true.\n"
495  ),
496  GROUP( "Index" )));
497 
498  wsv_data.push_back
499  (WsvRecord
500  (NAME( "abs_n2" ),
501  DESCRIPTION
502  (
503  "The total nitrogen profile associated with the pressures in *abs_p* [-]\n"
504  ),
505  GROUP( "Vector" )));
506 
507  wsv_data.push_back
508  (WsvRecord
509  ( NAME( "abs_p" ),
510  DESCRIPTION
511  (
512  "List of pressures to be used for the calculation of absorption\n"
513  "coefficients. \n"
514  "\n"
515  "This can be copied from the global *p_grid*, but could also be\n"
516  "different. \n"
517  "\n"
518  "Any absorption method should check that the length of this vector\n"
519  "is the same as that of *abs_t*\n"
520  "\n"
521  "Dimension: [number of pressures]\n"
522  "\n"
523  "Unit: Pa\n"
524  ),
525  GROUP( "Vector" )));
526 
527  wsv_data.push_back
528  (WsvRecord
529  ( NAME( "abs_scalar_gas" ),
530  DESCRIPTION
531  (
532  "Scalar gas absorption coefficients.\n"
533  "\n"
534  "This contains the absorption coefficients for one point in the\n"
535  "atmosphere (one set of pressure, temperature, and VMR values). There\n"
536  "are two distinct cases:\n"
537  "\n"
538  "Case a: For all frequencies and all species:\n"
539  "Dimension: [ f_grid, abs_species ]\n"
540  "\n"
541  "Case b: For a single frequency for all species:\n"
542  "Dimension: [ 1, abs_species ]\n"
543  "\n"
544  "Unit: 1/m\n"
545  ),
546  GROUP( "Matrix" )));
547 
548  wsv_data.push_back
549  (WsvRecord
550  ( NAME( "abs_scalar_gas_agenda" ),
551  DESCRIPTION
552  (
553  "See agendas.cc.\n"
554  ),
555  GROUP( "Agenda" )));
556 
557  wsv_data.push_back
558  (WsvRecord
559  ( NAME( "abs_field" ),
560  DESCRIPTION
561  (
562  "Scalar gas absorption field.\n"
563  "\n"
564  "Contains the scalar gas absorption for all species as a function of\n"
565  "*f_grid*, *p_grid*, *lat_grid*, and *lon_grid*. \n"
566  "\n"
567  "This is mainly for testing and plotting gas absorption. For RT\n"
568  "calculations, gas absorption is calculated or extracted locally,\n"
569  "therefore there is no need to store a global field. But this variable\n"
570  "is handy for easy plotting of absorption vs. pressure, for example.\n"
571  "\n"
572  "Unit: 1/m\n"
573  "\n"
574  "Dimensions: [species, f_grid, p_grid, lat_grid, lon_grid]\n"
575  ),
576  GROUP( "Tensor5" )));
577 
578  wsv_data.push_back
579  (WsvRecord
580  ( NAME( "abs_species" ),
581  DESCRIPTION
582  (
583  "Tag groups for scalar gas absorption.\n"
584  "\n"
585  "This is an array of arrays of SpeciesTag tag definitions. It defines the\n"
586  "available tag groups for the calculation of scalar gas absorption\n"
587  "coefficients. See online documentation of method *SpeciesSet* for\n"
588  "more detailed information how tag groups work and some examples.\n"
589  ),
590  GROUP( "ArrayOfArrayOfSpeciesTag" )));
591 
592  wsv_data.push_back
593  (WsvRecord
594  ( NAME( "abs_t" ),
595  DESCRIPTION
596  (
597  "List of temperatures to be used for the calculation of absorption\n"
598  "coefficients.\n"
599  "\n"
600  "In contrast to the global *t_field*, this is just a vector. Any\n"
601  "absorption method should check that the length of this vector is the\n"
602  "same as that of *abs_p*\n"
603  "\n"
604  "Dimension: [number of pressures]\n"
605  "\n"
606  "Unit: K\n"
607  ),
608  GROUP( "Vector" )));
609 
610  wsv_data.push_back
611  (WsvRecord
612  ( NAME( "abs_vec" ),
613  DESCRIPTION
614  (
615  "Total absorption vector.\n"
616  "\n"
617  "This variable contains the absorption coefficient vector which \n"
618  "is used in the RTE calculation. It is \n"
619  "the physical absorption which includes particle absorption \n"
620  "for all chosen particle types as well as gaseous absorption for\n"
621  "all chosen gaseous species.\n"
622  "The vector is calculated by the agendas *opt_prop_gas_agenda* \n"
623  "and, if scattering calculations are performed, \n"
624  "*opt_prop_part_agenda* \n"
625  "The dimensision of the variable adapts to *stokes_dim*.\n"
626  "\n"
627  "See further the ARTS user guide (AUG). Use the index to find where\n"
628  "this variable is discussed. The variable is listed as a subentry to\n"
629  "\"workspace variables\".\n"
630  "\n"
631  "Usage: Output of the agendas *opt_prop_gas_agenda* \n"
632  " and *opt_prop_part_agenda* \n"
633  "\n"
634  "Unit: [Hz, m^2]\n"
635  "\n"
636  "Dimensions: [f_grid, stokes_dim]\n"
637  ),
638  GROUP( "Matrix" )));
639 
640  wsv_data.push_back
641  (WsvRecord
642  ( NAME("abs_vec_spt"),
643  DESCRIPTION
644  (
645  "Absorption vector for a single particle type.\n"
646  "\n"
647  "This variable contains the elements of absorption vector of a \n"
648  "single particle, given It is calculated in the agenda \n"
649  "*spt_calc_agenda*.\n"
650  "\n"
651  "ARTS user guide (AUG) gives the formulas used for computing all \n"
652  "the elements of absorption vector.\n"
653  "\n"
654  "Usage: Input and Output of the method abs_vec_sptCalc\n"
655  "\n"
656  "Unit: m^2\n"
657  "\n"
658  "Dimensions: [part_types,stokes_dim]\n"
659  ),
660  GROUP( "Matrix" ) ));
661 
662  wsv_data.push_back
663  (WsvRecord
664  (NAME( "abs_vmrs" ),
665  DESCRIPTION
666  (
667  "The VMRs (unit: absolute number) on the abs_p grid.\n"
668  "Dimensions: [tag_groups.nelem(), abs_p.nelem()]\n"
669  ),
670  GROUP( "Matrix" )));
671 
672  wsv_data.push_back
673  (WsvRecord
674  ( NAME( "abs_xsec_per_species" ),
675  DESCRIPTION
676  (
677  "Absorption cross sections.\n"
678  "\n"
679  "This variable contains absorption cross section xsec individually for\n"
680  "each tag group. The Array contains one matrix for each tag group, the\n"
681  "matrix format is the same as that of abs_coef.\n"
682  "\n"
683  "Dimensions: [abs_species](f_grid, abs_p)\n"
684  "\n"
685  "Unit: m^2 (alpha = xsec * n * VMR),\n"
686  " where n is total density.\n"
687  ),
688  GROUP( "ArrayOfMatrix" )));
689 
690  wsv_data.push_back
691  (WsvRecord
692  ( NAME( "antenna_dim" ),
693  DESCRIPTION
694  (
695  "The dimensionality of the antenna pattern (1-2).\n"
696  "\n"
697  "A dimensionality of 1 means that only the respons variation in the\n"
698  "zenith direction is considered. The provided respons shall then be the\n"
699  "integrated in the azimuth direction. For 2D, the respons of the\n"
700  "antenna has both a zenith and azimuth variation.\n"
701  "\n"
702  "Usage: Set by the user.\n"
703  "\n"
704  "Unit: Integer value [1-2].\n"
705  ),
706  GROUP( "Index" )));
707 
708  wsv_data.push_back
709  (WsvRecord
710  ( NAME( "antenna_los" ),
711  DESCRIPTION
712  (
713  "The relative line-of-sight of each antenna pattern.\n"
714  "\n"
715  "This variable describes the line-of-sight of the individual antennae\n"
716  "relative to *sensor_los*. If only one antenna is present the matrix\n"
717  "should contain a row of zero(s). The number of columns corresponds to\n"
718  "the *antenna_dim*, with the first column containing zenith angles\n"
719  "and the second azimuth angles. If each measurement block corresponds\n"
720  "to a single antenna pattern, the normal choice is to set the angle(s)\n"
721  "of this variable to zero.\n"
722  "\n"
723  "See further the ARTS user guide (AUG). Use the index to find where\n"
724  "this variable is discussed. The variable is listed as a subentry to\n"
725  "\"workspace variables\".\n"
726  "\n"
727  "Usage: Set by the user.\n"
728  "\n"
729  "Unit: [ degrees, degrees ]\n"
730  "\n"
731  "Size: [ number of antennae, 1 or 2 ]\n"
732  ),
733  GROUP( "Matrix" )));
734 
735  wsv_data.push_back
736  (WsvRecord
737  ( NAME( "antenna_response" ),
738  DESCRIPTION
739  (
740  "The antenna pattern/response.\n"
741  "\n"
742  "This WSV describes the antenna response as a function of polarisation\n"
743  "(pol), frequencue (f), zenith angle (za) and azimuth angle (aa).\n"
744  "\n"
745  "Polarisation dimension: If this dimension has size 1, the data are\n"
746  "applied for all polarisations of concern. The data are otherwise used\n"
747  "in sequential order. This signifies that, in general, the first\n"
748  "polarisation \"layer\" corresponds to the first stokes dimension\n"
749  "etc. An exception is if a polarisation rotation has been applied. In\n"
750  "any case, it is up to the user to ensure that polarisations are\n"
751  "consistently defined.\n"
752  "\n"
753  "Frequency dimension: If this dimension has size 1, the data are\n"
754  "applied for all frequencies of concern. The given frequency must be\n"
755  "inside the frequency range of concern. A linear interpolation is\n"
756  "otherwise applied.\n"
757  "\n"
758  "Zenith angle dimension: This dimension must always have a size >= 2\n"
759  "The response outside covered grid range is treated as zero. If\n"
760  "*antenna_dim* equals 1, the data should correspond to the response\n"
761  "integrated in the azimuthal direction.\n"
762  "\n"
763  "Azimuth angle dimension: If *antenna_dim* equals 1, this dimension\n"
764  "must have size 1. A size >= 2 is otherwise required. The response\n"
765  "outside covered grid range is treated as zero.\n"
766  "\n"
767  "Usage: Set by the user.\n"
768  "\n"
769  "Dimensions: \n"
770  " GriddedField4:\n"
771  " ArrayOfString field_names[N_pol]\n"
772  " Vector f_grid[N_f]\n"
773  " Vector za_grid[N_za]\n"
774  " Vector aa_grid[N_aa]\n"
775  " Tensor4 data[N_pol][N_f][N_za][N_aa]\n"
776  ),
777  GROUP( "GriddedField4" )));
778 
779  wsv_data.push_back
780  (WsvRecord
781  ( NAME( "atmosphere_dim" ),
782  DESCRIPTION
783  (
784  "The atmospheric dimensionality (1-3).\n"
785  "\n"
786  "This variable defines the complexity of the atmospheric structure.\n"
787  "The dimensionality is given by an integer between 1 and 3, where 1\n"
788  "means 1D etc. This is the master variable for the atmospheric\n"
789  "dimensionality, variables which size changes with the dimensionality\n"
790  "are checked to match this variable. \n"
791  "\n"
792  "Methods adapt automatically to this variable. That is, it should\n"
793  "not be needed to change any methods if the dimensionality is\n"
794  "changed. However, not all methods are working for higher dimensions.\n"
795  "\n"
796  "Usage: Set by the user.\n"
797  "\n"
798  "Unit: Integer value.\n"
799  ),
800  GROUP( "Index" )));
801 
802  wsv_data.push_back
803  (WsvRecord
804  ( NAME( "atm_fields_compact" ),
805  DESCRIPTION
806  (
807  "A compact combination of all atmospheric fields for a clear-sky\n"
808  "calculation on a common set of grids.\n"
809  "\n"
810  "This concerns temperature, altitude, and gas VMRs.\n"
811  "\n"
812  "The data are stored in a *GriddedField4*.\n"
813  "\n"
814  "The order of the fields must be:\n"
815  "T[K] z[m] VMR_1[1] ... VMR_n[1]\n"
816  "(the field names for the gases do not have to start with VMR_)\n"
817  "\n"
818  "Usage: Used inside batch calculations, to hold successive atmospheric\n"
819  " states from an *ArrayOfGriddedField4*.\n"
820  "\n"
821  "Possible future extensions: Add a similar variable\n"
822  "particle_fields_compact for hydrometeors?\n"
823  "\n"
824  "Dimensions: \n"
825  " GriddedField4:\n"
826  " ArrayOfString field_names[N_fields]\n"
827  " Vector p_grid[N_p]\n"
828  " Vector lat_grid[N_lat]\n"
829  " Vector lon_grid[N_lon]\n"
830  " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"
831  ),
832  GROUP( "GriddedField4" )));
833 
834  wsv_data.push_back
835  (WsvRecord
836  ( NAME( "atm_fields_compact_all" ),
837  DESCRIPTION
838  (
839  "A compact combination of all atmospheric fields for a clear-sky\n"
840  "and cloud particle scattering calculation on a common set of grids.\n"
841  "\n"
842  "This concerns temperature, altitude, scattering particles and gas VMRs.\n"
843  "\n"
844  "The data are stored in a *GriddedField4*.\n"
845  "\n"
846  "The order of the fields must be:\n"
847  "T[K] z[m] LWC[kg/m3] IWC[kg/m3] Rain[kg/m2/s] Snow[kg/m2/s] VMR_1[1] ... VMR_n[1]\n"
848  "(the field names for the gases do not have to start with VMR_)\n"
849  "\n"
850  "Usage: Used inside batch calculations, to hold successive atmospheric\n"
851  " states from an *ArrayOfGriddedField4*.\n"
852  "\n"
853  "Dimensions: \n"
854  " GriddedField4:\n"
855  " ArrayOfString field_names[N_fields]\n"
856  " Vector p_grid[N_p]\n"
857  " Vector lat_grid[N_lat]\n"
858  " Vector lon_grid[N_lon]\n"
859  " Tensor4 data[N_fields][N_p][N_lat][N_lon]\n"
860  ),
861  GROUP( "GriddedField4" )));
862 
863  wsv_data.push_back
864  (WsvRecord
865  ( NAME( "backend_channel_response" ),
866  DESCRIPTION
867  (
868  "The response of each backend channel.\n"
869  "\n"
870  "The response is given as an *ArrayOfGriddedField1*. The grid consists of\n"
871  "relative frequencies. These relative frequencies are added to \n"
872  "*f_backend* to obtain the absolute frequency for each response value.\n"
873  "The actual data are the response at each frequency grid point.\n"
874  "\n"
875  "There are here two options. If the array has length 1, the same\n"
876  "response is applied for all channels. Accordingly, this assumes that\n"
877  "all channels have the same response function. The second option is to\n"
878  "specify the response for each channel seperately. This signifies that\n"
879  "the *backend_channel_response* array has either 1 or n elements, where\n"
880  "n is the length of *f_backend*\n"
881  "\n"
882  "Usage: Set by the user.\n"
883  "\n"
884  "Size: Array[N_ch]\n"
885  " GriddedField1 \n "
886  " [N_f] \n"
887  " [N_f] \n"
888  ),
889  GROUP( "ArrayOfGriddedField1" )));
890 
891  wsv_data.push_back
892  (WsvRecord
893  ( NAME( "backend_channel_response_multi" ),
894  DESCRIPTION
895  (
896  "As *backend_channel_response* but describes an instrument with\n"
897  "muliple mixer/reciever chains.\n"
898  "\n"
899  "See *f_backend_multi* for when to use this variable and size\n"
900  "constraints.\n"
901  "\n"
902  "Usage: Set by the user.\n "
903  ),
904  GROUP( "ArrayOfArrayOfGriddedField1" )));
905 
906  wsv_data.push_back
907  (WsvRecord
908  ( NAME( "basics_checked" ),
909  DESCRIPTION
910  (
911  "OK-flag for basic variables and grids.\n"
912  "\n"
913  "For example, this variable flags that the (clear-sky) atmosphere\n"
914  "and the surface are defined in a formally correct way, e.g. that\n"
915  "the sizes of atmospheric fields match the atmospheric grids.\n"
916  "\n"
917  "Shall be set by *basics_checkedCalc*. See that WSM for treated WSVs.\n"
918  ),
919  GROUP( "Index" )));
920 
921  wsv_data.push_back
922  (WsvRecord
923  ( NAME( "batch_atm_fields_compact" ),
924  DESCRIPTION
925  (
926  "An array of compact atmospheric states.\n"
927  "\n"
928  "This is used to hold a set of *atm_fields_compact* for batch\n"
929  "calculations. \n"
930  ),
931  GROUP( "ArrayOfGriddedField4" )));
932 
933  wsv_data.push_back
934  (WsvRecord
935  ( NAME( "batch_atm_fields_compact_all" ),
936  DESCRIPTION
937  (
938  "An array of compact atmospheric states, including scattering particles.\n"
939  "\n"
940  "This is used to hold a set of *atm_fields_compact_all* for batch\n"
941  "calculations. \n"
942  ),
943  GROUP( "ArrayOfGriddedField4" )));
944 
945  wsv_data.push_back
946  (WsvRecord
947  ( NAME( "batch_cloudbox_limits" ),
948  DESCRIPTION
949  (
950  "An array of cloudbox_limits.\n"
951  "\n"
952  "This is used to hold a set of *cloudbox-limits* for batch\n"
953  "calculations. \n"
954  ),
955  GROUP( "ArrayOfArrayOfIndex" )));
956 
957  wsv_data.push_back
958  (WsvRecord
959  ( NAME( "batch_pnd_fields" ),
960  DESCRIPTION
961  (
962  "An array of compact pnd states.\n"
963  "\n"
964  "This is used to hold a set of 1D *pnd_field* for batch\n"
965  "calculations. \n"
966  ),
967  GROUP( "ArrayOfTensor4" )));
968 
969  wsv_data.push_back
970  (WsvRecord
971  ( NAME( "cloudbox_checked" ),
972  DESCRIPTION
973  (
974  "OK-flag for variables associated with the cloudbox.\n"
975  "\n"
976  "This variable flags that cloudbox variables are defined in a formally\n"
977  "and practically correct way. For example, that there is sufficient\n"
978  "space between the cloudbox and edges of the model atmosphere (for\n"
979  "2D and 3D). Pure clear-sky variables are covered by *basics_checked*.\n"
980  "\n"
981  "Relevant checks are performed by *cloudbox_checkedCalc.\n"
982  ),
983  GROUP( "Index" )));
984 
985  wsv_data.push_back
986  (WsvRecord
987  ( NAME( "cloudbox_on" ),
988  DESCRIPTION
989  (
990  "Flag to activate the cloud box.\n"
991  "\n"
992  "Scattering calculations are confined to a part of the atmosphere\n"
993  "denoted as the cloud box. The extension of the cloud box is given by\n"
994  "*cloudbox_limits*. This variable tells methods if a cloud box is\n"
995  "activated or not. \n"
996  "\n"
997  "See further the ARTS user guide (AUG). Use the index to find where\n"
998  "this variable is discussed. The variable is listed as a subentry to\n"
999  "\"workspace variables\".\n"
1000  "\n"
1001  "Usage: Set by the user.\n"
1002  "\n"
1003  "Unit: Boolean.\n"
1004  ),
1005  GROUP( "Index" )));
1006 
1007  wsv_data.push_back
1008  (WsvRecord
1009  ( NAME( "cloudbox_limits" ),
1010  DESCRIPTION
1011  (
1012  "The limits of the cloud box.\n"
1013  "\n"
1014  "This variable defines the extension of the cloud box. The cloud box \n"
1015  "is defined to be rectangular in the used coordinate system, with \n"
1016  "limits exactly at points of the involved grids. This means, for \n"
1017  "example, that the vertical limits of the cloud box are two pressure \n"
1018  "levels. For 2D, the angular extension of the cloud box is between \n"
1019  "two points of the latitude grid, and likewise for 3D but then also \n"
1020  "with a longitude extension between two grid points. The latitude and\n"
1021  "longitude limits for the cloud box cannot be placed at the end \n"
1022  "points of the corresponding grid as it must be possible to calculate\n"
1023  "the incoming intensity field.\n"
1024  "\n"
1025  "The variable *cloudbox_limits* is an array of index value with\n"
1026  "length twice *atmosphere_dim*. For each dimension there is a lower \n"
1027  "limit and an upper limit. The order of the dimensions is as usual \n"
1028  "pressure, latitude and longitude. The upper limit index must be \n"
1029  "greater then the lower limit index. For example, \n"
1030  "*cloudbox_limits* = [0 5 4 11 4 11] means that cloud box extends\n"
1031  "between pressure levels 0 and 5, and latitude and longitude points 4\n"
1032  "and 11.\n"
1033  "\n"
1034  "If *cloudbox_on* = 0, the content of this variable is neglected, but\n"
1035  "it must be initiated to some dummy values.\n"
1036  "\n"
1037  "See further the ARTS user guide (AUG). Use the index to find where\n"
1038  "this variable is discussed. The variable is listed as a subentry to\n"
1039  "\"workspace variables\".\n"
1040  "\n"
1041  "Usage: Set by the user, either directly or using a method\n"
1042  " checking the extension of scattering particles.\n"
1043  "\n"
1044  "Unit: Index values.\n"
1045  "\n"
1046  "Size: [ 2 * atmosphere_dim ]\n"
1047  ),
1048  GROUP( "ArrayOfIndex" )));
1049 
1050  wsv_data.push_back
1051  (WsvRecord
1052  ( NAME("complex_n"),
1053  DESCRIPTION
1054  (
1055  "Complex refractive index (n).\n"
1056  "\n"
1057  "This matrix describes the dielectric properties of a medium. \n"
1058  "A typical usage of this variable is to describe the properties of\n"
1059  "the surface (if it is assumed to be flat).\n"
1060  "\n"
1061  "This is a two-column matrix. The first column holds the real part\n"
1062  "of n, and the second column the imaginary part. The number of rows\n"
1063  "should match *f_grid*. The case of one row is also accepted,\n"
1064  "interpreted as that the refractive index is constant with \n"
1065  "frequency.\n"
1066  "\n"
1067  "Unit: -\n"
1068  "\n"
1069  "Dimensions: [f_grid or 1,2]\n"
1070  ),
1071  GROUP( "Matrix" ) ));
1072 
1073  wsv_data.push_back
1074  (WsvRecord
1075  ( NAME( "diy_dx" ),
1076  DESCRIPTION
1077  (
1078  "Derivative of *iy* with respect to retrieval quantities.\n"
1079  "\n"
1080  "The variable gives the derivative if *iy* with respect to some\n"
1081  "variables (but not all jacobian variables). Handled are only variables\n"
1082  "affecting monochromatic pencil beam radiances where an (semi-)\n"
1083  "analytical expression can be applied (and that this calculation way\n"
1084  "has been selected when the jacobian has been set-up).\n"
1085  "\n"
1086  "Usage: Output of *iy_clearsky_agenda*.\n"
1087  "\n"
1088  "Dimensions: \n"
1089  " [n_quantities][ ppath.np, f_grid, stokes_dim ]\n"
1090  ),
1091  GROUP( "ArrayOfTensor3" )));
1092 
1093  wsv_data.push_back
1094  (WsvRecord
1095  ( NAME( "doit_conv_flag" ),
1096  DESCRIPTION
1097  (
1098  "Flag for the convergence test.\n"
1099  "\n"
1100  "This variable is initialized with 0 inside the method \n"
1101  "*doit_i_fieldIterate*.\n"
1102  "If after an iteration the convergence test is fulfilled, 1 is \n"
1103  "assigned which means that the iteration is completed. \n"
1104  "\n"
1105  "Usage: Method output. \n"
1106  ),
1107  GROUP( "Index" )));
1108 
1109  wsv_data.push_back
1110  (WsvRecord
1111  ( NAME( "doit_conv_test_agenda" ),
1112  DESCRIPTION
1113  (
1114  "See agendas.cc.\n"
1115  ),
1116  GROUP( "Agenda" )));
1117 
1118  wsv_data.push_back
1119  (WsvRecord
1120  ( NAME( "doit_i_field" ),
1121  DESCRIPTION
1122  (
1123  "Radiation field.\n"
1124  "\n"
1125  "This variable is used to store the monochromatic radiation field \n"
1126  "inside the cloudbox which is found by an iterative solution (DOIT).\n"
1127  "Refer to AUG for further information.\n"
1128  "\n"
1129  "Usage: Method output. \n"
1130  "\n"
1131  "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1132  "\n"
1133  "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1134  " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1135  " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1136  " N_za, N_aa, N_i ]\n"
1137  ),
1138  GROUP( "Tensor6" )));
1139 
1140  wsv_data.push_back
1141  (WsvRecord
1142  ( NAME( "doit_i_field1D_spectrum" ),
1143  DESCRIPTION
1144  (
1145  "Radiation field for the whole frequency spectrum. \n"
1146  "\n"
1147  "This variable holds the radiation field. In contrast to \n"
1148  "*doit_i_field* this variable has an additional freqeuncy \n"
1149  "dimension. This variable is only used for 1D DOIT \n"
1150  "calculations.\n"
1151  "\n"
1152  "Usage: Output of *DoitCloudboxFieldPut*\n"
1153  "\n"
1154  "Unit: W / (m^2 Hz sr)\n"
1155  "\n"
1156  "Size: [N_f \n"
1157  " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1158  " N_za, N_aa, N_i ]\n"
1159  ),
1160  GROUP( "Tensor4" )));
1161 
1162  wsv_data.push_back
1163  (WsvRecord
1164  ( NAME( "doit_i_field_old" ),
1165  DESCRIPTION
1166  (
1167  "Intensity field inside the cloudbox.\n"
1168  "\n"
1169  "This variable is used to store the intensity field inside the\n"
1170  "cloudbox while performing the iteration. One has to store the\n"
1171  "intensity field of the previous iteration to be able to do the \n"
1172  "convergence test after each iteration.\n"
1173  "Refer to AUG for more information.\n"
1174  "\n"
1175  "Usage: Method output. \n"
1176  "\n"
1177  "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1178  "\n"
1179  "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1180  " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1181  " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1182  " N_za, N_aa, N_i ]\n"
1183  ),
1184  GROUP( "Tensor6" )));
1185 
1186  wsv_data.push_back
1187  (WsvRecord
1188  ( NAME( "doit_is_initialized" ),
1189  DESCRIPTION
1190  (
1191  "Flag to determine if *DoitInit* was called.\n"
1192  "\n"
1193  "This flag is checked by *ScatteringDoit* to make sure that\n"
1194  "*DoitInit* was called before.\n"
1195  ),
1196  GROUP( "Index" )));
1197 
1198  wsv_data.push_back
1199  (WsvRecord
1200  ( NAME( "doit_iteration_counter" ),
1201  DESCRIPTION
1202  (
1203  "Counter for number of iterations.\n"
1204  "\n"
1205  "This variable holds the number of iterations \n"
1206  "while solving the VRTE using the DOIT method. \n"
1207  ),
1208  GROUP( "Index" )));
1209 
1210  wsv_data.push_back
1211  (WsvRecord
1212  ( NAME( "doit_mono_agenda" ),
1213  DESCRIPTION
1214  (
1215  "See agendas.cc.\n"
1216  ),
1217  GROUP( "Agenda" )));
1218 
1219  wsv_data.push_back
1220  (WsvRecord
1221  ( NAME( "doit_rte_agenda" ),
1222  DESCRIPTION
1223  (
1224  "See agendas.cc.\n"
1225  ),
1226  GROUP( "Agenda" )));
1227 
1228  wsv_data.push_back
1229  (WsvRecord
1230  ( NAME( "doit_scat_field_agenda" ),
1231  DESCRIPTION
1232  (
1233  "See agendas.cc.\n"
1234  ),
1235  GROUP( "Agenda" )));
1236 
1237  wsv_data.push_back
1238  (WsvRecord
1239  ( NAME( "doit_scat_field" ),
1240  DESCRIPTION
1241  (
1242  "Scattered field field inside the cloudbox.\n"
1243  "\n"
1244  "This variable holds the value of the scattering integral for all\n"
1245  "points inside the cloudbox. For more information refer to AUG.\n"
1246  "\n"
1247  "Usage: Input to *doit_i_fieldUpdate...*. \n"
1248  "\n"
1249  "Unit: W / (m^2 Hz sr) for each Stokes component.\n"
1250  "\n"
1251  "Size: [(cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
1252  " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
1253  " (cloudbox_limits[5] - cloudbox_limits[4]) +1, \n"
1254  " N_za, N_aa, N_i ]\n"
1255  ),
1256  GROUP( "Tensor6" )));
1257 
1258  wsv_data.push_back
1259  (WsvRecord
1260  ( NAME( "doit_za_grid_opt" ),
1261  DESCRIPTION
1262  (
1263  "Optimized zenith angle grid.\n"
1264  "\n"
1265  "Output of the method *doit_za_grid_optCalc*.\n"
1266  "\n"
1267  "Usage: Output of *doit_za_grid_optCalc* \n"
1268  "\n"
1269  "Unit: degrees \n"
1270  ),
1271  GROUP( "Vector" )));
1272 
1273  wsv_data.push_back
1274  (WsvRecord
1275  ( NAME( "doit_za_grid_size" ),
1276  DESCRIPTION
1277  (
1278  "Number of equidistant grid points of the zenith angle grid, \n"
1279  "defined from 0 to 180 deg, for the scattering integral calculation. \n"
1280  "\n"
1281  "Usage: Output of *DoitAngularGridsSet*.\n"
1282  ),
1283  GROUP( "Index" )));
1284 
1285  wsv_data.push_back
1286  (WsvRecord
1287  ( NAME( "doit_za_interp" ),
1288  DESCRIPTION
1289  (
1290  "Flag for interplation method in zenith angle dimension.\n"
1291  "\n"
1292  "0 - linear interpolation \n"
1293  "1 - cubic interpolation \n"
1294  "\n"
1295  "Usage: Set by user in *doit_za_interpSet*. \n"
1296  ),
1297  GROUP( "Index" )));
1298 
1299  wsv_data.push_back
1300  (WsvRecord
1301  ( NAME( "emission" ),
1302  DESCRIPTION
1303  (
1304  "Thermal emission source term.\n"
1305  "\n"
1306  "This variable holds the emission at one position along the\n"
1307  " propagation path. Inside scattering methods, such as DOIT, the\n"
1308  "calculation of this source term can be hard coded.\n"
1309  "\n"
1310  "Usage: Set by *emission_agenda*.\n"
1311  "\n"
1312  "Unit: W / (m^2 Hz sr) or optical thickness \n"
1313  "\n"
1314  "Dimensions: [ f_grid ]\n"
1315  ),
1316  GROUP( "Vector" )));
1317 
1318  wsv_data.push_back
1319  (WsvRecord
1320  ( NAME( "emission_agenda" ),
1321  DESCRIPTION
1322  (
1323  "See agendas.cc.\n"
1324  ),
1325  GROUP( "Agenda" )));
1326 
1327  wsv_data.push_back
1328  (WsvRecord
1329  ( NAME( "ext_mat" ),
1330  DESCRIPTION
1331  (
1332  "Total extinction matrix.\n"
1333  "\n"
1334  "This variable contains the extinction coefficient matrix which\n"
1335  "is used in the RT calculation in the cloudbox . It is the physical\n"
1336  "extinction matrix which includes particles extinction for all chosen\n"
1337  "particle types and gaseous extinction for all chosen gaseous species.\n"
1338  "\n"
1339  "See further the ARTS user guide (AUG). Use the index to find where\n"
1340  "this variable is discussed. The variable is listed as a subentry to\n"
1341  "\"workspace variables\".\n"
1342  "\n"
1343  "Usage: Output of the agendas *opt_prop_gas_agenda* \n"
1344  " and *opt_prop_part_agenda* \n"
1345  "\n"
1346  "Unit: [Hz, m^2, m^2] "
1347  "\n"
1348  "Dimensions: [f_grid, stokes_dim, stokes_dim]\n"
1349  ),
1350  GROUP( "Tensor3" )));
1351 
1352  wsv_data.push_back
1353  (WsvRecord
1354  ( NAME( "ext_mat_spt" ),
1355  DESCRIPTION
1356  (
1357  "Extinction matrix for a single particle type.\n"
1358  "\n"
1359  "This variable contains the elements for extinction matrix of a \n"
1360  "single particle for a given propagation direction. It is calculated\n"
1361  "input as well as the output of the agenda *spt_calc_agenda*. \n"
1362  "\n"
1363  "Usage: Output of *spt_calc_agenda* \n"
1364  "\n"
1365  "Unit: m^2 \n"
1366  "\n"
1367  "Dimensions: [part_types, stokes_dim, stokes_dim]\n"
1368  ),
1369  GROUP( "Tensor3" )));
1370 
1371  wsv_data.push_back
1372  (WsvRecord
1373  ( NAME( "file_index" ),
1374  DESCRIPTION
1375  (
1376  "Index number for files.\n"
1377  "\n"
1378  "See *WriteXMLIndexed* for further information.\n"
1379  "\n"
1380  "Usage: Input to *WriteXMLIndexed* and *ReadXMLIndexed*. \n"
1381  ),
1382  GROUP( "Index" )));
1383 
1384  wsv_data.push_back
1385  (WsvRecord
1386  ( NAME( "forloop_agenda" ),
1387  DESCRIPTION
1388  (
1389  "See agendas.cc.\n"
1390  ),
1391  GROUP( "Agenda" )));
1392 
1393  wsv_data.push_back
1394  (WsvRecord
1395  ( NAME( "forloop_index" ),
1396  DESCRIPTION
1397  (
1398  "The index for for-loops.\n"
1399  "\n"
1400  "This is the index that is used by method *ForLoop* to loop over\n"
1401  "*forloop_agenda*. \n"
1402  ),
1403  GROUP( "Index" )));
1404 
1405  wsv_data.push_back
1406  (WsvRecord
1407  ( NAME( "f_backend" ),
1408  DESCRIPTION
1409  (
1410  "The frequency position of each backend (spectrometer) channel.\n"
1411  "\n"
1412  "Usage: Set by the user.\n "
1413  "\n"
1414  "Unit: Hz\n"
1415  ),
1416  GROUP( "Vector" )));
1417 
1418  wsv_data.push_back
1419  (WsvRecord
1420  ( NAME( "f_backend_multi" ),
1421  DESCRIPTION
1422  (
1423  "As *f_backend* but describes an instrument with muliple\n"
1424  "mixer/reciever chains.\n"
1425  "\n"
1426  "This variable is needed when e.g. the reciever has several mixers\n"
1427  "or the the reciever measures several polarisation and the channels\n"
1428  "differ in position or response function. \n"
1429  "\n"
1430  "The array has one element for each \"reciever chain\". The array\n"
1431  "length must match *backend_channel_response_multi*, and possibly\n"
1432  "also *lo_multi*.\n"
1433  "\n"
1434  "Usage: Set by the user.\n "
1435  "\n"
1436  "Unit: Hz\n"
1437  ),
1438  GROUP( "ArrayOfVector" )));
1439 
1440  wsv_data.push_back
1441  (WsvRecord
1442  ( NAME( "f_grid" ),
1443  DESCRIPTION
1444  (
1445  "The frequency grid for monochromatic pencil beam calculations.\n"
1446  "\n"
1447  "Usage: Set by the user.\n "
1448  "\n"
1449  "Unit: Hz\n"
1450  ),
1451  GROUP( "Vector" )));
1452 
1453  wsv_data.push_back
1454  (WsvRecord
1455  (NAME( "f_index" ),
1456  DESCRIPTION
1457  (
1458  "Frequency index. \n"
1459  "\n"
1460  "Not all methods handle all monochromatic frequencies (of *f_grid*) in\n"
1461  "parellel and this variable is used for communication between methods,\n"
1462  "holding the index of the frequency treated presently.\n"
1463  "\n"
1464  "In some contexts, a negative f_index means all frequencies.\n"
1465  "\n"
1466  "Usage: Method output.\n"
1467  ),
1468  GROUP( "Index" )));
1469 
1470 // wsv_data.push_back
1471 // (WsvRecord
1472 // ( NAME( "geomag_los_calc_agenda" ),
1473 // DESCRIPTION
1474 // (
1475 // "See agendas.cc.\n"
1476 // ),
1477 // GROUP( "Agenda" )));
1478 
1479 // wsv_data.push_back
1480 // (WsvRecord
1481 // ( NAME( "geomag_los" ),
1482 // DESCRIPTION
1483 // (
1484 // "Magnetic field along the line of sight\n"
1485 // "\n"
1486 // "more text by Nikolay \n"
1487 // "\n"
1488 // "Unit: ..."
1489 // "\n"
1490 // "Dimensions: [Magnetic field B, angle between B and los] \n"
1491 // ),
1492 // GROUP( "Matrix" )));
1493 
1494 
1495  wsv_data.push_back
1496  (WsvRecord
1497  (NAME( "imblock" ),
1498  DESCRIPTION
1499  (
1500  "Measurement block index. \n"
1501  "\n"
1502  "Used to tell agendas the index of present measurement block.\n"
1503  "\n"
1504  "Usage: Used internally.\n"
1505  ),
1506  GROUP( "Index" )));
1507 
1508  wsv_data.push_back
1509  (WsvRecord
1510  ( NAME( "iy" ),
1511  DESCRIPTION
1512  (
1513  "Monochromatic pencil beam radiance spectrum.\n"
1514  "\n"
1515  "This variable holds a single spectrum, with values corresponding\n"
1516  "to infinite frequency and spatial resolution (compare to *y*).\n"
1517  "\n"
1518  "The variable is used to represent spectra at all positions of the\n"
1519  "propagation path and can e.g. temporarily hold radiation entering\n"
1520  "the atmpophere from space. The unit depends on if emission is \n"
1521  "considered or not (no conversion to e.g. brightness temperature shall\n"
1522  "be applied).\n"
1523  "\n"
1524  "Usage: Used by radiative transfer methods.\n"
1525  "\n"
1526  "Unit: W / (m^2 Hz sr) or transmission.\n"
1527  "\n"
1528  "Dimensions: [ f_grid, stokes_dim ]\n"
1529  ),
1530  GROUP( "Matrix" )));
1531 
1532  wsv_data.push_back
1533  (WsvRecord
1534  ( NAME( "iy_agenda_call1" ),
1535  DESCRIPTION
1536  (
1537  "Flag to handle recursive calls of *iy_clearsky_agenda*\n"
1538  "\n"
1539  "The agenda *iy_clearsky_agenda* can be used recursively and this flag\n"
1540  "is used to tell the methods inside the agenda which is the primary\n"
1541  " call. This is handled automatically for methods using\n"
1542  "*iy_clearsky_agenda*, such as *yCalc*, but the user must set this\n"
1543  "variable to 1 if the agenda is called directly inside the control\n"
1544  "file (which should be a rare case).\n"
1545  ),
1546  GROUP( "Index" )));
1547 
1548  wsv_data.push_back
1549  (WsvRecord
1550  ( NAME( "iy_aux" ),
1551  DESCRIPTION
1552  (
1553  "Data auxilary to *iy*.\n"
1554  "\n"
1555  "This variable makes it possible to provide auxilary information for\n"
1556  "each value in *iy*. The standard usage is to provide transmission,\n"
1557  "then to complement radiance data. See the relevant WSMs for details.\n"
1558  "\n"
1559  "The data are not used for any calculations. The data are just passed\n"
1560  "on to create *y_aux*. A possibility here is to set *iy_aux* to e.g.\n"
1561  "-1000 inside *iy_cloudbox_agenda*, to obtain a way to catch\n"
1562  "interceptions with the cloudbox.\n"
1563  "\n"
1564  "Usage: Used by radiative transfer methods.\n"
1565  "\n"
1566  "Dimensions: [ f_grid, stokes_dim ]\n"
1567  ),
1568  GROUP( "Matrix" )));
1569 
1570  wsv_data.push_back
1571  (WsvRecord
1572  ( NAME( "iy_clearsky_agenda" ),
1573  DESCRIPTION
1574  (
1575  "See agendas.cc.\n"
1576  ),
1577  GROUP( "Agenda" )));
1578 
1579  wsv_data.push_back
1580  (WsvRecord
1581  ( NAME( "iy_clearsky_basic_agenda" ),
1582  DESCRIPTION
1583  (
1584  "See agendas.cc.\n"
1585  ),
1586  GROUP( "Agenda" )));
1587 
1588  wsv_data.push_back
1589  (WsvRecord
1590  ( NAME( "iy_cloudbox_agenda" ),
1591  DESCRIPTION
1592  (
1593  "See agendas.cc.\n"
1594  ),
1595  GROUP( "Agenda" )));
1596 
1597  wsv_data.push_back
1598  (WsvRecord
1599  ( NAME( "iy_error" ),
1600  DESCRIPTION
1601  (
1602  "Estimation of calculation errors in *iy*.\n"
1603  "\n"
1604  "As *y_error*, but treats *iy* and can be left empty if\n"
1605  "*iy_error_type* is 0.\n"
1606  "\n"
1607  "Usage: Used by radiative transfer methods.\n"
1608  "\n"
1609  "Unit: W / (m^2 Hz sr) or transmission.\n"
1610  "\n"
1611  "Dimensions: [ f_grid, stokes_dim ]\n"
1612  ),
1613  GROUP( "Matrix" )));
1614 
1615  wsv_data.push_back
1616  (WsvRecord
1617  ( NAME( "iy_error_type" ),
1618  DESCRIPTION
1619  (
1620  "Characteristics of error values in *iy_error*.\n"
1621  "\n"
1622  "These options are defined:\n"
1623  " 0: The error is zero. *iy_error* can then be left undefined or\n"
1624  " empty.\n"
1625  " 1: The error values are totally uncorrelated.\n"
1626  " 2: The error values are totally correlated.\n"
1627  "The distinction between case 1 and 2 is important, as the weighting\n"
1628  "with sensor response data must be performed differently for the two\n"
1629  "cases.\n"
1630  ),
1631  GROUP( "Index" )));
1632 
1633  wsv_data.push_back
1634  (WsvRecord
1635  ( NAME( "iy_space_agenda" ),
1636  DESCRIPTION
1637  (
1638  "See agendas.cc.\n"
1639  ),
1640  GROUP( "Agenda" )));
1641 
1642  wsv_data.push_back
1643  (WsvRecord
1644  ( NAME( "iy_transmission" ),
1645  DESCRIPTION
1646  (
1647  "Transmission to be included in *iy*.\n"
1648  "\n"
1649  "The calculation of *iy* can be performed over several propation path\n"
1650  "branches, and there can be recursive calls of *iy_clearsky_agenda*.\n"
1651  "This variable gives the transmission from the end point of the present\n"
1652  "branch and the sensor for such recursive cases.\n"
1653  "\n"
1654  "This variable is used purely internally. The exact usage can vary\n"
1655  "between different RT integration schemes.\n"
1656  "\n"
1657  "Usage: Internally inside iy_clearsky_agenda.\n"
1658  "\n"
1659  "Unit: 1\n"
1660  "\n"
1661  "Dimensions: [ f_grid, stokes_dim, stokes_dim ]\n"
1662  ),
1663  GROUP( "Tensor3" )));
1664 
1665  wsv_data.push_back
1666  (WsvRecord
1667  ( NAME( "iyb" ),
1668  DESCRIPTION
1669  (
1670  "Monochromatic pencil beam data for one measurement block.\n"
1671  "\n"
1672  "The data for all *iy* of a measurement block appended to a vector,\n"
1673  "following the sorting order used for *y*.\n"
1674  "\n"
1675  "Usage: Used internally.\n"
1676  "\n"
1677  "Unit: W / (m^2 Hz sr) or transmission.\n"
1678  "\n"
1679  "Dimensions: [ naa*nza*nf*stokes_dim ] where naa is length of\n"
1680  " mblock_aa_grid, za length of mblock_za_grid and nf is\n"
1681  " length of f_grid.\n"
1682  ),
1683  GROUP( "Vector" )));
1684 
1685  wsv_data.push_back
1686  (WsvRecord
1687  ( NAME( "jacobian" ),
1688  DESCRIPTION
1689  (
1690  "The Jacobian matrix.\n"
1691  "\n"
1692  "The matrix holding the Jacobians of the retrieval quantities. Each\n"
1693  "quantity, and its subdivision into atmospheric grids, are stored as\n"
1694  "columns in the matrix. The matrix has to be initialised before the\n"
1695  "quantities can be defined. Initialisation WSM is *jacobianInit*.\n"
1696  "Retrieval quantities are then added with *jacobianAdd...* methods.\n"
1697  "See the online help. Pure numerical calculation is described by\n"
1698  "*jacobian_calc_agenda* and are performed by *jacobianCalc*.\n"
1699  "\n"
1700  "Units: See the different retrieval quantities.\n"
1701  "\n"
1702  "Dimension: [ y, number of retrieval quantities and grids ]\n"
1703  ),
1704  GROUP( "Matrix" )));
1705 
1706  wsv_data.push_back
1707  (WsvRecord
1708  ( NAME( "jacobian_do" ),
1709  DESCRIPTION
1710  (
1711  "Flag to activate jacobian calculations.\n"
1712  "\n"
1713  "If this variable is set to 0, no jacobian calculations will be\n"
1714  "even if such calculations have been set-up (through the jacobianAddXxx\n"
1715  "methods).\n"
1716  ),
1717  GROUP( "Index" )));
1718 
1719  wsv_data.push_back
1720  (WsvRecord
1721  ( NAME( "jacobian_agenda" ),
1722  DESCRIPTION
1723  (
1724  "See agendas.cc.\n"
1725  ),
1726  GROUP( "Agenda" )));
1727 
1728  wsv_data.push_back
1729  (WsvRecord
1730  ( NAME( "jacobian_indices" ),
1731  DESCRIPTION
1732  (
1733  "First and last column index in *jacobian* for each retrieval quantity."
1734  "\n"
1735  "This variable tells which part of *jacobian* that corresponds to \n"
1736  "each jacobian quantity.\n"
1737  "\n"
1738  "Usage: Set by *jacobianClose*.\n"
1739  ),
1740  GROUP( "ArrayOfArrayOfIndex" )));
1741 
1742 // Keep this (PE 081113)
1743 //
1744 // wsv_data.push_back
1745 // (WsvRecord
1746 // ( NAME( "jacobian_particle_update_agenda" ),
1747 // DESCRIPTION
1748 // (
1749 // "See agendas.cc.\n"
1750 // ),
1751 // GROUP( "Agenda" )));
1752 
1753  wsv_data.push_back
1754  (WsvRecord
1755  ( NAME( "jacobian_quantities" ),
1756  DESCRIPTION
1757  (
1758  "The retrieval quantities in the Jacobian matrix.\n"
1759  "\n"
1760  "An array of retrieval quantities for which the jacobians are\n"
1761  "calculated.\n"
1762  "\n"
1763  "Usage: Quantities are added by the jacobianAdd WSMs.\n"
1764  ),
1765  GROUP( "ArrayOfRetrievalQuantity" )));
1766 
1767  wsv_data.push_back
1768  (WsvRecord
1769  ( NAME( "jacobian_y_agenda" ),
1770  DESCRIPTION
1771  (
1772  "See agendas.cc.\n"
1773  ),
1774  GROUP( "Agenda" )));
1775 
1776  wsv_data.push_back
1777  (WsvRecord
1778  ( NAME( "lat_grid" ),
1779  DESCRIPTION
1780  (
1781  "The latitude grid.\n"
1782  "\n"
1783  "The latitudes for which the atmospheric fields are defined. The\n"
1784  "atmosphere is undefined outside the range covered by the grid.\n"
1785  "The grid must be sorted in increasing order, with no repetitions.\n"
1786  "\n"
1787  "Geocentric latitudes shall be used.\n"
1788  "\n"
1789  "For 1D calculations this vector can is some cases be set to be empty.\n"
1790  "Some methods are requiring a latitude even for 1D and the latitude\n"
1791  "is then taken from this vector. That is, for 1D the length can either\n"
1792  "be 0 or 1.\n"
1793  "\n"
1794  "For 2D cases the latitudes shall be interpreted as the angular\n"
1795  "distance inside the orbit plane from an arbitrary zero point (values\n"
1796  "outside +-90 deg are allowed).\n"
1797  "\n"
1798  "For 3D, the valid latitude range is [-90,90].\n"
1799  "\n"
1800  "See further the ARTS user guide (AUG). Use the index to find where\n"
1801  "this variable is discussed. The variable is listed as a subentry to\n"
1802  "\"workspace variables\".\n"
1803  "\n"
1804  "Usage: Set by the user.\n"
1805  "\n"
1806  "Unit: degrees\n"
1807  ),
1808  GROUP( "Vector" )));
1809 
1810 
1811  wsv_data.push_back
1812  (WsvRecord
1813  ( NAME( "lo" ),
1814  DESCRIPTION
1815  (
1816  "The local oscillator frequency.\n"
1817  "\n"
1818  "A local oscillator frequency is used in a heterodyne system when\n"
1819  "the mixer folds the spectra from from radio frequencies (RF) to\n"
1820  "intermediate frequencies (IF).\n"
1821  "\n"
1822  "Unit: Hz\n"
1823  "\n"
1824  "Usage: Set by the user.\n"
1825  ),
1826  GROUP( "Numeric" )));
1827 
1828  wsv_data.push_back
1829  (WsvRecord
1830  ( NAME( "lo_multi" ),
1831  DESCRIPTION
1832  (
1833  "Local oscillator frequencies.\n"
1834  "\n"
1835  "As *lo* but describes an instrument with multiple mixers. A vector\n"
1836  "element for each LO. The size of this variable and\n"
1837  "*sideband_response_multi* shall match, and probably also\n"
1838  "*sideband_mode_multi*.\n"
1839  "\n"
1840  "Unit: Hz\n"
1841  "\n"
1842  "Usage: Set by the user.\n"
1843  ),
1844  GROUP( "Vector" )));
1845 
1846  wsv_data.push_back
1847  (WsvRecord
1848  ( NAME( "lon_grid" ),
1849  DESCRIPTION
1850  (
1851  "The longitude grid.\n"
1852  "\n"
1853  "The longitudes for which the atmospheric fields are defined. The\n"
1854  "atmosphere is undefined outside the range covered by the grid.\n"
1855  "The grid must be sorted in increasing order, with no repetitions.\n"
1856  "\n"
1857  "For 1D and 2D, some methods could expect this vector to have\n"
1858  "length 1, and holding a longitude representing the case. Otherwise\n"
1859  "the length can be 0. That is, works as *lat_grid* for 1D.\n"
1860  "\n"
1861  "Allowed values for longitudes is the range [-360,360].\n"
1862  "\n"
1863  "See further the ARTS user guide (AUG). Use the index to find where\n"
1864  "this variable is discussed. The variable is listed as a subentry to\n"
1865  "\"workspace variables\".\n"
1866  "\n"
1867  "Usage: Set by the user.\n"
1868  "\n"
1869  "Unit: degrees\n"
1870  ),
1871  GROUP( "Vector" )));
1872 
1873  wsv_data.push_back
1874  (WsvRecord
1875  ( NAME( "main_agenda" ),
1876  DESCRIPTION
1877  (
1878  "See agendas.cc.\n"
1879  ),
1880  GROUP( "Agenda" )));
1881 
1882  wsv_data.push_back
1883  (WsvRecord
1884  (NAME( "massdensity_field" ),
1885  DESCRIPTION
1886  (
1887  "The field of atmospheric scattering particle types in unit of massdensity\n"
1888  "(like IWC/LWC/Rain/Aerosol etc.).\n"
1889  "\n"
1890  "If *massdensity_field* is obtained from Chevallier91L data, the scat. particles are\n"
1891  "hydrometeors of type: CLW[kg/m^3] CIW[kg/m^3] Rain[kg/(m2*s)] Snow[kg/(m2*s)]\n"
1892  "\n"
1893  "NOTE: naming discussion: *massdensity_field* should be renamed in the future\n"
1894  "to a more general term (not limited to massdensities).\n"
1895  "\n"
1896  "Possible future extension: In the future a *massdensity_field_raw* might be needed,\n"
1897  "which contains the not-interpolated mass concentrations of scattering particles.\n"
1898  "This is not needed in the moment, since *massdensity_field* is only used with \n"
1899  "batch profile data (where all atmospheric variables are on the same grid).\n"
1900  "\n"
1901  "Usage:\tmassdensity data is used to calculate pnd_fields\n"
1902  "\n"
1903  "Unit:\tdepending on what is read, usually [kg/m3]\n"
1904  "\n"
1905  "Dimension:\t[ type, p_grid, lat_grid, lon_grid ]\n"
1906 
1907  ),
1908  GROUP( "Tensor4" )));
1909 
1910 /* wsv_data.push_back
1911  (WsvRecord
1912  (NAME( "massdensity_threshold" ),
1913  DESCRIPTION
1914  (
1915  "Threshold value for minimum massdensity concentration in *massdensity_field*.\n"
1916  "\n"
1917  "Check WSM *Massdensity_cleanup* for more information!\n"
1918  "\n"
1919  "Default value:\t1e-15\n"
1920  ),
1921  GROUP( "Numeric" )));
1922 */
1923 
1924  wsv_data.push_back
1925  (WsvRecord
1926  ( NAME( "mblock_aa_grid" ),
1927  DESCRIPTION
1928  (
1929  "The azimuthal angle grid for each measurement block.\n"
1930  "\n"
1931  "This variable should normally contain the azimuth grid of the\n"
1932  "antenna pattern. The grid is given as an angular off-set with\n"
1933  "respect to the angles in *sensor_los*.\n"
1934  "\n"
1935  "See further the ARTS user guide (AUG). Use the index to find where\n"
1936  "this variable is discussed. The variable is listed as a subentry to\n"
1937  "\"workspace variables\".\n"
1938  "\n"
1939  "Usage: Set by the user.\n"
1940  "\n"
1941  "Unit: degrees\n"
1942  ),
1943  GROUP( "Vector" )));
1944 
1945  wsv_data.push_back
1946  (WsvRecord
1947  ( NAME( "mblock_za_grid" ),
1948  DESCRIPTION
1949  (
1950  "The zenith angle grid for each measurement block.\n"
1951  "\n"
1952  "This variable should normally contain the zenith grid of the\n"
1953  "antenna pattern. The grid is given as an angular off-set with\n"
1954  "respect to the angles in *sensor_los*.\n"
1955  "\n"
1956  "See further the ARTS user guide (AUG). Use the index to find where\n"
1957  "this variable is discussed. The variable is listed as a subentry to\n"
1958  "\"workspace variables\".\n"
1959  "\n"
1960  "Usage: Set by the user.\n"
1961  "\n"
1962  "Unit: degrees\n"
1963  ),
1964  GROUP( "Vector" )));
1965 
1966  wsv_data.push_back
1967  (WsvRecord
1968  ( NAME( "mc_antenna" ),
1969  DESCRIPTION
1970  (
1971  "Antenna pattern description for dedicated MC calculaions.\n"
1972  "\n"
1973  "Usage: Input to MCGeneral. Set by *mc_antennaSetGaussian* and similar\n"
1974  " methods.\n"
1975  ),
1976  GROUP( "MCAntenna" )));
1977 
1978  wsv_data.push_back
1979  (WsvRecord
1980  ( NAME( "mc_cloud_opt_path" ),
1981  DESCRIPTION
1982  (
1983  "The cloud optical path integrated over the field of view.\n"
1984  "\n"
1985  "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
1986  ),
1987  GROUP( "Numeric" )));
1988 
1989  wsv_data.push_back
1990  (WsvRecord
1991  ( NAME( "mc_cloud_opt_path_error" ),
1992  DESCRIPTION
1993  (
1994  "Standad error in the cloud optical path integrated over the field\n"
1995  "of view.\n"
1996  "\n"
1997  "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
1998  ),
1999  GROUP( "Numeric" )));
2000 
2001  wsv_data.push_back
2002  (WsvRecord
2003  ( NAME( "mc_error" ),
2004  DESCRIPTION
2005  (
2006  "Error in simulated *y* when using a Monte Carlo approach.\n"
2007  "\n"
2008  "Usage: Output from Monte Carlo functions. \n"
2009  "\n"
2010  "Units: Depends on *y_unit*.\n"
2011  "\n"
2012  "Size: [ stokes_dim ]\n"
2013  ),
2014  GROUP( "Vector" )));
2015 
2016  wsv_data.push_back
2017  (WsvRecord
2018  ( NAME( "mc_iteration_count" ),
2019  DESCRIPTION
2020  (
2021  "Counts the number of iterations (or photons) used in the MC\n "
2022  "scattering algorithm.\n"
2023  "\n"
2024  "Usage: Set by MCGeneral and other MC methods.\n"
2025  ),
2026  GROUP( "Index" )));
2027 
2028  wsv_data.push_back
2029  (WsvRecord
2030  ( NAME( "mc_IWP" ),
2031  DESCRIPTION
2032  (
2033  "The ice water path integrated over the field of view\n"
2034  "\n"
2035  "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2036  ),
2037  GROUP( "Numeric" )));
2038 
2039  wsv_data.push_back
2040  (WsvRecord
2041  ( NAME( "mc_IWP_error" ),
2042  DESCRIPTION
2043  (
2044  "The standard error of ice water path integrated over the field of view\n"
2045  "\n"
2046  "Usage: Output from mc_IWP_cloud_opt_pathCalc \n"
2047  ),
2048  GROUP( "Numeric" )));
2049 
2050  wsv_data.push_back
2051  (WsvRecord
2052  ( NAME( "mc_points" ),
2053  DESCRIPTION
2054  (
2055  "Counts the number of MC endpoints in each grid cell.\n"
2056  "\n"
2057  "Usage: Set by MCGeneral and other MC methods.\n"
2058  ),
2059  GROUP( "Tensor3" )));
2060 
2061  wsv_data.push_back
2062  (WsvRecord
2063  ( NAME( "mc_seed" ),
2064  DESCRIPTION
2065  (
2066  "The integer seed for the random number generator used by\n"
2067  "Monte Carlo methods.\n"
2068  "\n"
2069  "Usage: Set by MCSetSeed.\n"
2070  ),
2071  GROUP( "Index" )));
2072 
2073  wsv_data.push_back
2074  (WsvRecord
2075  ( NAME( "mc_std_err" ),
2076  DESCRIPTION
2077  (
2078  "Target precision (1 std. dev.) for Monte Carlo calculations.\n"
2079  "\n"
2080  "Usage: Set by the user.\n"
2081  ),
2082  GROUP( "Numeric" )));
2083 
2084  wsv_data.push_back
2085  (WsvRecord
2086  ( NAME( "mc_max_time" ),
2087  DESCRIPTION
2088  (
2089  "The maximum time allowed for Monte Carlo calculations.\n"
2090  "\n"
2091  "Usage: Set by the user.\n"
2092  "\n"
2093  "Unit: s\n"
2094  ),
2095  GROUP( "Index" )));
2096 
2097  wsv_data.push_back
2098  (WsvRecord
2099  ( NAME( "mc_max_iter" ),
2100  DESCRIPTION
2101  (
2102  "The maximum number of iterations allowed for Monte Carlo\n"
2103  "calculations.\n"
2104  "\n"
2105  "Usage: Set by the user.\n"
2106  ),
2107  GROUP( "Index" )));
2108 
2109  wsv_data.push_back
2110  (WsvRecord
2111  ( NAME( "mc_z_field_is_1D" ),
2112  DESCRIPTION
2113  (
2114  "Flag for MCGeneral and associated methods.\n"
2115  "\n"
2116  "If fields outside the cloud box are 1D, this flag can be set to 1\n"
2117  "and the calculations will be more rapid.\n"
2118  "\n"
2119  "Usage: Set by the user.\n"
2120  ),
2121  GROUP( "Index" )));
2122 
2123  wsv_data.push_back
2124  (WsvRecord
2125  ( NAME( "met_amsu_data" ),
2126  DESCRIPTION
2127  (
2128  "The AMSU data set.\n"
2129  "\n"
2130  "This is intended as input for the method ybatchMetProfiles. It holds the\n"
2131  "latitude, longitude, satellite zenith angle and amsu-b corrected and \n"
2132  "uncorrected brightness temperatures. It also has information about \n"
2133  "the particular pixel corresponds to a land or sea point. This will be \n"
2134  "read in the method ybatchMetProfiles and the profiles corresponding to \n"
2135  "each latitude and longitude will be read in.\n"
2136  "\n"
2137  "See documentation of WSM *ybatchMetProfiles* for more information.\n"
2138  ),
2139  GROUP( "Matrix" )));
2140 
2141  wsv_data.push_back
2142  (WsvRecord
2143  ( NAME( "nelem" ),
2144  DESCRIPTION
2145  (
2146  "This variable is used by the VectorSet workspace method.\n"
2147  ),
2148  GROUP( "Index" )));
2149 
2150  wsv_data.push_back
2151  (WsvRecord
2152  ( NAME( "ncols" ),
2153  DESCRIPTION
2154  (
2155  "This variable is used by the MatrixSet, Tensor3Set, etc. \n"
2156  "workspace methods.\n"
2157  ),
2158  GROUP( "Index" )));
2159 
2160  wsv_data.push_back
2161  (WsvRecord
2162  ( NAME( "nrows" ),
2163  DESCRIPTION
2164  (
2165  "See *ncols*.\n"
2166  ),
2167  GROUP( "Index" )));
2168 
2169  wsv_data.push_back
2170  (WsvRecord
2171  ( NAME( "npages" ),
2172  DESCRIPTION
2173  (
2174  "See *ncols*.\n"
2175  ),
2176  GROUP( "Index" )));
2177 
2178  wsv_data.push_back
2179  (WsvRecord
2180  ( NAME( "nbooks" ),
2181  DESCRIPTION
2182  (
2183  "See *ncols*.\n"
2184  ),
2185  GROUP( "Index" )));
2186 
2187  wsv_data.push_back
2188  (WsvRecord
2189  ( NAME( "nshelves" ),
2190  DESCRIPTION
2191  (
2192  "See *ncols*.\n"
2193  ),
2194  GROUP( "Index" )));
2195 
2196  wsv_data.push_back
2197  (WsvRecord
2198  ( NAME( "nvitrines" ),
2199  DESCRIPTION
2200  (
2201  "See *ncols*.\n"
2202  ),
2203  GROUP( "Index" )));
2204 
2205  wsv_data.push_back
2206  (WsvRecord
2207  ( NAME( "nlibraries" ),
2208  DESCRIPTION
2209  (
2210  "See *ncols*.\n"
2211  ),
2212  GROUP( "Index" )));
2213 
2214  wsv_data.push_back
2215  (WsvRecord
2216  ( NAME( "met_profile_calc_agenda" ),
2217  DESCRIPTION
2218  (
2219  "See agendas.cc.\n"
2220  ),
2221  GROUP( "Agenda" )));
2222 
2223  wsv_data.push_back
2224  (WsvRecord
2225  ( NAME( "opt_prop_gas_agenda" ),
2226  DESCRIPTION
2227  (
2228  "See agendas.cc.\n"
2229  ),
2230  GROUP( "Agenda" )));
2231 
2232  wsv_data.push_back
2233  (WsvRecord
2234  ( NAME( "opt_prop_part_agenda" ),
2235  DESCRIPTION
2236  (
2237  "See agendas.cc.\n"
2238  ),
2239  GROUP( "Agenda" )));
2240 
2241  wsv_data.push_back
2242  (WsvRecord
2243  (NAME( "output_file_format" ),
2244  DESCRIPTION
2245  (
2246  "Output file format. \n"
2247  "\n"
2248  "This variable sets the format for output files. It could be set to\n"
2249  "\"ascii\" for plain xml files, \"zascii\" for zipped xml files, or\n"
2250  "\"binary\".\n"
2251  "\n"
2252  "To change the value of this variable use the workspace methods\n"
2253  "*output_file_formatSetAscii*, *output_file_formatSetZippedAscii*, and\n"
2254  "*output_file_formatSetBinary*\n"
2255  ),
2256  GROUP( "String" )));
2257 
2258  wsv_data.push_back
2259  (WsvRecord
2260  (NAME( "particle_masses" ),
2261  DESCRIPTION
2262  (
2263  "The mass of each particle type stored in a vector \n"
2264  "\n"
2265  "Usage: Set by the user.\n"
2266  ),
2267  GROUP( "Vector" )));
2268 
2269  wsv_data.push_back
2270  (WsvRecord
2271  ( NAME( "part_species" ),
2272  DESCRIPTION
2273  (
2274  "*part_species* is an Array of Strings containing user defined input,\n"
2275  "for particle number density calculations performed by *pnd_fieldSetup*.\n"
2276  "\n"
2277  "Each single String must contain:\n"
2278  "scattering particle type [*String*]:\t e.g. 'LWC', 'IWC', 'Rain'\n"
2279  "particle size distribution [*String*]:\t e.g. 'MH97', 'liquid', 'H11'\n"
2280  "sizerange-start [*Numeric*]:\tthe first particle radius(liquid)/melted radius(ice)\n"
2281  " \tthe calculations shall start with.\n"
2282  "sizerange-end [*Numeric*]:\tthe last particle radius(liquid)/melted radius(ice)\n"
2283  " \tthe calculations shall end with.\n"
2284  "\n"
2285  "NOTE: the sizerange inputs must be given in MICRONS!\n"
2286  "\n"
2287  "The Array needs to looks like this: [''IWC-MH97-2-1000'', ''LWC-liquid-0.1-10'', ...]\n"
2288  ),
2289  GROUP( "ArrayOfString" )));
2290 
2291  wsv_data.push_back
2292  (WsvRecord
2293  ( NAME( "pha_mat" ),
2294  DESCRIPTION
2295  (
2296  "Ensemble averaged phase matrix.\n"
2297  "\n"
2298  "This workspace variable represents the actual physical phase\n"
2299  "matrix (averaged over all particle types) for given propagation\n"
2300  "directions. It is calculated in the method *pha_matCalc*\n"
2301  "\n"
2302  "ARTS user guide (AUG) gives the formula used for computing this\n"
2303  "variable. Use the index to find where this variable is discussed.\n"
2304  "The variable is listed as a subentry to \"workspace variables\".\n"
2305  "\n"
2306  "Usage: Output of the method *pha_matCalc*\n"
2307  "\n"
2308  "Unit: m^2\n"
2309  "\n"
2310  "Dimensions: [ scat_za_grid, scat_aa_grid, stokes_dim, stokes_dim ]\n"
2311  ),
2312  GROUP( "Tensor4" )));
2313 
2314  wsv_data.push_back
2315  (WsvRecord
2316  ( NAME( "pha_mat_spt" ),
2317  DESCRIPTION
2318  (
2319  "Phase matrix for a single particle type.\n"
2320  "\n"
2321  "This variable contains the elements of phase matrix for a single \n"
2322  "particle for given propagation direction. \n"
2323  "It is the calculated in the agenda *pha_mat_spt_agenda*. \n"
2324  "The elements of the phase matrix are calculated from \n"
2325  "the single scattering data. "
2326  "ARTS user guide (AUG) gives the formulas used for computing all \n"
2327  "elements of the phase matrix for a given particle type.\n"
2328 // Commented out by Gerrit 2011-04-12, this is incorrect and I cannot
2329 // correct it.
2330 //
2331 // "\n"
2332 // "Usage: Input and Output of the method pha_mat_sptCalc\n"
2333  "\n"
2334  "Unit: m^2\n"
2335  "\n"
2336  "Dimensions: [part_types, *scat_za_grid*, *scat_aa_grid*, *stokes_dim*, *stokes_dim*]\n"
2337  ),
2338  GROUP( "Tensor5" )));
2339 
2340  wsv_data.push_back
2341  (WsvRecord
2342  ( NAME( "pha_mat_spt_agenda" ),
2343  DESCRIPTION
2344  (
2345  "See agendas.cc.\n"
2346  ),
2347  GROUP( "Agenda" )));
2348 
2349  wsv_data.push_back
2350  (WsvRecord
2351  ( NAME( "pha_mat_sptDOITOpt" ),
2352  DESCRIPTION
2353  (
2354  "Interpolated phase matrix.\n"
2355  "\n"
2356  "This variable contains the data of the phase matrix in the \n"
2357  "scattering frame interpolated on the actual frequency (the variable\n"
2358  "is used inside *doit_mono_agenda*) and also interpolated on all \n"
2359  "possible scattering angles following from all combinations of \n"
2360  "*scat_za_grid* and *scat_aa_grid*. \n"
2361  "\n"
2362  "Usage: Input of the method *pha_mat_sptFromDataDOITOpt*\n"
2363  "\n"
2364  "Unit: m^2\n"
2365  "\n"
2366  "Dimensions: \n"
2367  "[particle types]\n"
2368  "[T, scat_za_grid,scat_aa_grid, scat_za_grid, scat_aa_grid,\n"
2369  "stokes_dim, stokes_dim]\n"
2370  ),
2371  GROUP( "ArrayOfTensor7" )));
2372 
2373  wsv_data.push_back
2374  (WsvRecord
2375  ( NAME( "pnd_field" ),
2376  DESCRIPTION
2377  (
2378  "Particle number density field.\n"
2379  "\n"
2380  "This veriable corresponds to the particle number density fields \n"
2381  "for all particle types being read in the WSMs *ParticleTypeAdd* \n"
2382  "or *ParticleTypeAddAll*. \n"
2383  "Another alternative is to create *pnd_field* with *pnd_fieldSetup*.\n"
2384  "\n"
2385  "Usage: Calculated internally.\n"
2386  "\n"
2387  "Unit: m^-3\n"
2388  "\n"
2389  "Size: [N_part_types, \n"
2390  " (cloudbox_limits[1] - cloudbox_limits[0]) +1, \n"
2391  " (cloudbox_limits[3] - cloudbox_limits[2]) +1, \n"
2392  " (cloudbox_limits[5] - cloudbox_limits[4]) +1 ] \n"
2393  ),
2394  GROUP( "Tensor4" )));
2395 
2396 // wsv_data.push_back
2397 // (WsvRecord
2398 // ( NAME( "pnd_field_perturb" ),
2399 // DESCRIPTION
2400 // (
2401 // "The field representing particle number density perturbations.\n"
2402 // "\n"
2403 // "This variable gives the perturbation of particle number density\n"
2404 // "of the chosen particle types as a function of p_grid, lat_grid,\n"
2405 // "lon_grid for each retrieval quantity. The variable has to be\n"
2406 // "prepared outside ARTS and it has to be setup prior to calling\n"
2407 // "*jacobianAddParticle*. Since it is added to *pnd_field* during\n"
2408 // "the calculation of the Jacobian, the perturbations are absolute\n"
2409 // "and as such should have the same unit as *pnd_field*\n"
2410 // "\n"
2411 // "See further the ARTS user guide (AUG). Use the index to find where\n"
2412 // "this variable is discussed. The variable is listed as a subentry to\n"
2413 // "\"workspace variables\".\n"
2414 // "\n"
2415 // "Usage: Set by the user.\n"
2416 // "\n"
2417 // "Unit: m^-3\n"
2418 // "\n"
2419 // "Dimensions: [N_retrieval_quantities, as *pnd_field* ]\n"
2420 // ),
2421 // GROUP( "Tensor5" )));
2422 
2423  wsv_data.push_back
2424  (WsvRecord
2425  ( NAME( "pnd_field_raw" ),
2426  DESCRIPTION
2427  (
2428  "The particle number density field data.\n"
2429  "\n"
2430  "This variable contains the particle number density data for all \n"
2431  "chosen particle types. It includes the grids corresponding to the \n"
2432  "grids in the database. \n"
2433  "*pnd_field_raw* is an Array of GriddedField3. It includes a\n"
2434  "GriddedField3 for each particle type which contains the data and \n"
2435  "also the grids.\n"
2436  "\n"
2437  "Usage: Used in the methods *ParticleTypeAdd* and \n"
2438  " *ParticleTypeAddAll*\n"
2439  "\n"
2440  "Unit: m^-3\n"
2441  "\n"
2442  "Size: Array[N_pt]\n"
2443  " GriddedField3 \n "
2444  " [N_p] \n"
2445  " [N_lat] \n"
2446  " [N_lon] \n"
2447  " [N_p, N_lat, N_lon] \n"
2448  ),
2449  GROUP( "ArrayOfGriddedField3" )));
2450 
2451  wsv_data.push_back
2452  (WsvRecord
2453  ( NAME( "ppath" ),
2454  DESCRIPTION
2455  (
2456  "The propagation path for one line-of-sight.\n"
2457  "\n"
2458  "This variable describes the total (pencil beam) propagation path for\n"
2459  "a given combination of starting point and line-of-sight. The path is\n"
2460  "described by a data structure of type Ppath. This structure contains\n"
2461  "also additional fields to faciliate the calculation of spectra and\n"
2462  "interpolation of the atmospheric fields.\n"
2463  "\n"
2464  "The data struture is too extensive to be described here, but it is\n"
2465  "described carefully in the ARTS user guide (AUG). Use the index to\n"
2466  "find where the data structure, Ppath, for propagation paths is \n"
2467  "discussed. It is listed as a subentry to \"data structures\".\n"
2468  "\n"
2469  "Usage: Output from the method *ppathCalc*.\n"
2470  ),
2471  GROUP( "Ppath" )));
2472 
2473  wsv_data.push_back
2474  (WsvRecord
2475  ( NAME( "ppath_lmax" ),
2476  DESCRIPTION
2477  (
2478  "Maximum length between points describing propagation paths.\n"
2479  "\n"
2480  "See *ppath_stepGeometric* for a description of this variable.\n"
2481  "\n"
2482  "Usage: Ppath methods such as *ppath_stepGeometric*.\n"
2483  ),
2484  GROUP( "Numeric" )));
2485 
2486  wsv_data.push_back
2487  (WsvRecord
2488  ( NAME( "ppath_lraytrace" ),
2489  DESCRIPTION
2490  (
2491  "Maximum length of ray tracing steps when determining propagation\n"
2492  "paths.\n"
2493  "\n"
2494  "See *ppath_stepRefractionEuler* for a description of this variable.\n"
2495  "\n"
2496  "Usage: Refraction ppath methods such as *ppath_stepRefractionEuler*.\n"
2497  ),
2498  GROUP( "Numeric" )));
2499 
2500  wsv_data.push_back
2501  (WsvRecord
2502  ( NAME( "ppath_step" ),
2503  DESCRIPTION
2504  (
2505  "A propagation path step.\n"
2506  "\n"
2507  "The main intention of this variable is communication with the agenda\n"
2508  "*ppath_step_agenda*.\n"
2509  "\n"
2510  "See *ppathCalc* for more information on this variable and\n"
2511  "the calculation of propagation paths. Or read the chapter on\n"
2512  "propagation paths in the ARTS user guide.\n"
2513  "\n"
2514  "Usage: In/output to/from *ppath_step_agenda*.\n"
2515  "\n"
2516  "Members: See AUG.\n"
2517  ),
2518  GROUP( "Ppath" )));
2519 
2520  wsv_data.push_back
2521  (WsvRecord
2522  ( NAME( "ppath_step_agenda" ),
2523  DESCRIPTION
2524  (
2525  "See agendas.cc.\n"
2526  ),
2527  GROUP( "Agenda" )));
2528 
2529  wsv_data.push_back
2530  (WsvRecord
2531  ( NAME( "p_grid" ),
2532  DESCRIPTION
2533  (
2534  "The pressure grid.\n"
2535  "\n"
2536  "The pressure levels on which the atmospheric fields are defined.\n"
2537  "This variable must always be defined. The grid must be sorted in\n"
2538  "decreasing order, with no repetitions.\n"
2539  "\n"
2540  "No gap between the lowermost pressure level and the surface is \n"
2541  "allowed. The uppermost pressure level defines the practical upper\n"
2542  "limit of the atmosphere as vacuum is assumed above.\n"
2543  "\n"
2544  "See further the ARTS user guide (AUG). Use the index to find where\n"
2545  "this variable is discussed. The variable is listed as a subentry to\n"
2546  "\"workspace variables\".\n"
2547  "\n"
2548  "Usage: Set by the user.\n"
2549  "\n"
2550  "Unit: Pa\n"
2551  ),
2552  GROUP( "Vector" )));
2553 
2554  wsv_data.push_back
2555  (WsvRecord
2556  ( NAME( "p_hse" ),
2557  DESCRIPTION
2558  (
2559  "Reference pressure calculation of hydrostatic equilibrium.\n"
2560  "\n"
2561  "The altitude specified by this pressure is used as the reference\n"
2562  "when calculating hydrostatic equilibrium. That is, the geometrical\n"
2563  "altitude at this pressure is not changed.\n"
2564  "\n"
2565  "Usage: Set by the user.\n"
2566  "\n"
2567  "Unit: Pa\n"
2568  ),
2569  GROUP( "Numeric" )));
2570 
2571  wsv_data.push_back
2572  (WsvRecord
2573  ( NAME( "refr_index" ),
2574  DESCRIPTION
2575  (
2576  "Refractive index of air (only real part).\n"
2577  "\n"
2578  "This variable contains the refractive index summed over all relevant\n"
2579  "constituents, at one position in the atmosphere. The standard set of\n"
2580  "functions assumes that all frequency components propagate along the\n"
2581  "same path. That is, dispersion is neglected and this variable has no\n"
2582  "frequency dimension.\n"
2583  "\n"
2584  "Unit: 1\n"
2585  ),
2586  GROUP( "Numeric" )));
2587 
2588  wsv_data.push_back
2589  (WsvRecord
2590  ( NAME( "refr_index_agenda" ),
2591  DESCRIPTION
2592  (
2593  "See agendas.cc.\n"
2594  ),
2595  GROUP( "Agenda" )));
2596 
2597  wsv_data.push_back
2598  (WsvRecord
2599  ( NAME( "rte_doppler" ),
2600  DESCRIPTION
2601  (
2602  "A doppler shift for radiative transfer calculations.\n"
2603  "\n"
2604  "This scalar variable can hold the local doppler shift. It is intended\n"
2605  "mainly for communication with various methods and agendas, such as\n"
2606  "methods and agendas calculating absorption coefficients.\n"
2607  "\n"
2608  "Positive values mean that the spectrum is shifted towards higher\n"
2609  "frequencies\n"
2610  "\n"
2611  "Usage: Communication variable.\n"
2612  "\n"
2613  "Units: [ Hz ]\n"
2614  ),
2615  GROUP( "Numeric" )));
2616 
2617  wsv_data.push_back
2618  (WsvRecord
2619  ( NAME( "rte_do_vmr_jacs" ),
2620  DESCRIPTION
2621  (
2622  "Index of gas species for which *rte_agenda* shall calculate "
2623  "VMR jacobians (with respect to changes along the propagation path).\n"
2624  "\n"
2625  "These indexes refer to the position in *abs_species*.\n"
2626  "\n"
2627  "Usage: Set internally, by *RteCalc*.\n"
2628  ),
2629  GROUP( "ArrayOfIndex" )));
2630 
2631  wsv_data.push_back
2632  (WsvRecord
2633  ( NAME( "rte_do_t_jacs" ),
2634  DESCRIPTION
2635  (
2636  "Flag to *rte_agenda* to calculate jacobians for temperature.\n"
2637  "\n"
2638  "Usage: Set internally, by *RteCalc*.\n"
2639  ),
2640  GROUP( "Index" )));
2641 
2642  wsv_data.push_back
2643  (WsvRecord
2644  ( NAME( "rte_gp_p" ),
2645  DESCRIPTION
2646  (
2647  "The pressure grid position of *rte_pos*.\n"
2648  "\n"
2649  "This variable is used to give the grid position for an end point\n"
2650  "of the propagation path to some workspace method part of the\n"
2651  "radiative transfer calculations.\n"
2652  "\n"
2653  "Usage: Set internally.\n"
2654  ),
2655  GROUP( "GridPos" )));
2656 
2657  wsv_data.push_back
2658  (WsvRecord
2659  ( NAME( "rte_gp_lat" ),
2660  DESCRIPTION
2661  (
2662  "The latitude grid position of *rte_pos*.\n"
2663  "\n"
2664  "This variable is used to give the grid position for an end point\n"
2665  "of the propagation path to some workspace method part of the\n"
2666  "radiative transfer calculations.\n"
2667  "\n"
2668  "Usage: Set internally.\n"
2669  ),
2670  GROUP( "GridPos" )));
2671 
2672  wsv_data.push_back
2673  (WsvRecord
2674  ( NAME( "rte_gp_lon" ),
2675  DESCRIPTION
2676  (
2677  "The longitude grid position of *rte_pos*.\n"
2678  "\n"
2679  "This variable is used to give the grid position for an end point\n"
2680  "of the propagation path to some workspace method part of the\n"
2681  "radiative transfer calculations.\n"
2682  "\n"
2683  "Usage: Set internally.\n"
2684  ),
2685  GROUP( "GridPos" )));
2686 
2687  wsv_data.push_back
2688  (WsvRecord
2689  ( NAME( "rte_los" ),
2690  DESCRIPTION
2691  (
2692  "A line-of-sight for radiative transfer calculations.\n"
2693  "\n"
2694  "The main purpose of this WSV and *rte_pos* is communication with \n"
2695  "different agendas involved in the RTE calculations. These variables \n"
2696  "can also be used to enable calling of *ppathCalc* (and maybe other \n"
2697  "methods) from the workspace. \n"
2698  "\n"
2699  "For 1D and 2D cases, *rte_los* is a vector of length 1 holding the \n"
2700  "zenith angle. For 3D, the length of the vector is 2, where the\n"
2701  "additional element is the azimuthal angle. These angles are defined\n"
2702  "in the ARTS user guide (AUG). Look in the index for \"zenith angle\"\n"
2703  "and \"azimuthal angle\".\n"
2704  "\n"
2705  "Usage: See above.\n"
2706  "\n"
2707  "Units: [ degree, degree ]\n"
2708  "\n"
2709  "Size: [ 1 or 2 ]\n"
2710  ),
2711  GROUP( "Vector" )));
2712 
2713  wsv_data.push_back
2714  (WsvRecord
2715  ( NAME( "rte_pos" ),
2716  DESCRIPTION
2717  (
2718  "A geographical position for radiative transfer calculations.\n"
2719  "\n"
2720  "The main purpose of this WSV and *rte_los* is communication with \n"
2721  "different agendas involved in the RTE calculations. These variables \n"
2722  "can also be used to enable calling of *ppathCalc* (and maybe other \n"
2723  "methods) from the workspace. \n"
2724  "\n"
2725  "This variable is a vector with a length equalling the atmospheric\n"
2726  "dimensionality. The first element is the radius (from the coordinate\n"
2727  "system centre) of the position. Element 2 is the latitude and \n"
2728  "element 3 is the longitude. Please note that the vertical position \n"
2729  "is given as the radius, not the altitude above the geoid.\n"
2730  "\n"
2731  "Usage: See above. \n"
2732  "\n"
2733  "Units: [ m, degree, degree ]\n"
2734  "\n"
2735  "Size: [ atmosphere_dim ]\n"
2736  ),
2737  GROUP( "Vector" )));
2738 
2739  wsv_data.push_back
2740  (WsvRecord
2741  ( NAME( "rte_pressure" ),
2742  DESCRIPTION
2743  (
2744  "A pressure for radiative transfer calculations.\n"
2745  "\n"
2746  "This scalar variable can hold the local pressure. It is intended\n"
2747  "mainly for communication with various methods and agendas, such as\n"
2748  "methods and agendas calculating absorption coefficients.\n"
2749  "\n"
2750  "Usage: Communication variable.\n"
2751  "\n"
2752  "Units: [ Pa ]\n"
2753  ),
2754  GROUP( "Numeric" )));
2755 
2756  wsv_data.push_back
2757  (WsvRecord
2758  ( NAME( "rte_temperature" ),
2759  DESCRIPTION
2760  (
2761  "A temperature for radiative transfer calculations.\n"
2762  "\n"
2763  "This scalar variable can hold the local temperature. It is intended\n"
2764  "mainly for communication with various methods and agendas, such as\n"
2765  "methods and agendas calculating absorption coefficients.\n"
2766  "\n"
2767  "Usage: Communication variable.\n"
2768  "\n"
2769  "Units: [ K ]\n"
2770  ),
2771  GROUP( "Numeric" )));
2772 
2773  wsv_data.push_back
2774  (WsvRecord
2775  ( NAME( "rte_vmr_list" ),
2776  DESCRIPTION
2777  (
2778  "A list of VMR values for radiative transfer calculations.\n"
2779  "\n"
2780  "This vector variable holds the local VMR value for all used species\n"
2781  "(as given by *abs_species*). It is intended mainly for communication\n"
2782  "with various methods and agendas, such as methods and agendas \n"
2783  "calculating absorption coefficients.\n"
2784  "\n"
2785  "Usage: Communication variable.\n"
2786  "\n"
2787  "Units: [ Absolute value ]\n"
2788  "\n"
2789  "Size: Should match abs_species.nelem()\n"
2790  ),
2791  GROUP( "Vector" )));
2792 
2793  wsv_data.push_back
2794  (WsvRecord
2795  ( NAME( "r_geoid" ),
2796  DESCRIPTION
2797  (
2798  "Geoid radius.\n"
2799  "\n"
2800  "Geometrical altitudes are defined as the vertical distance above the\n"
2801  "geoid, and the geoid is the reference surface used when giving, for\n"
2802  "example, *z_surface* and *z_field*. \n"
2803  "\n"
2804  "The geoid is defined by giving the radius from the coordinate centre\n"
2805  "to the geoid surface for each crossing of the latitude and longitude\n"
2806  "grids. The geoid should normally be selected to be an ellipsoid but\n"
2807  "any shape is allowed. For 1D calculations, the geoid is by\n"
2808  "definition a sphere.\n"
2809  "\n"
2810  "The radius for a point between the grid crossings is obtained by\n"
2811  "linear (2D) or bi-linear (3D) interpolation of the *r_geoid*. For 1D\n"
2812  "cases the geoid radius is constant.\n"
2813  "\n"
2814  "See further the ARTS user guide (AUG). Use the index to find where\n"
2815  "this variable is discussed. The variable is listed as a subentry to\n"
2816  "\"workspace variables\".\n"
2817  "\n"
2818  "Usage: Set by using a method for a geodetic datum.\n"
2819  "\n"
2820  "Unit: m\n"
2821  "\n"
2822  "Dimensions: [ lat_grid, lon_grid ]\n"
2823  ),
2824  GROUP( "Matrix" )));
2825 
2826  wsv_data.push_back
2827  (WsvRecord
2828  ( NAME( "scat_aa_grid" ),
2829  DESCRIPTION
2830  (
2831  "Azimuthal angle grid.\n"
2832  "\n"
2833  "The azimutal angle grid, on which the intensity field is stored. \n"
2834  "This grid is used for RT calculations inside the cloudbox, \n"
2835  "therefore one has to define it if the cloudbox is activated by \n"
2836  "the flag *cloudbox_on*.\n"
2837  "The grid must be sorted in increasing order, with no repetitions.\n"
2838  "\n"
2839  "Usage: Set by the user.\n"
2840  "\n"
2841  "Unit: degrees \n"
2842  ),
2843  GROUP( "Vector" )));
2844 
2845  wsv_data.push_back
2846  (WsvRecord
2847  ( NAME( "scat_aa_index" ),
2848  DESCRIPTION
2849  (
2850  "Azimuth angle index for scattering calculations.\n"
2851  "\n"
2852  "This variable is used in methods used for computing scattering\n"
2853  "properties. \n"
2854  "It holds the information about the azimuth angles for which the \n"
2855  "scattering calculations are done. The angles used for computing \n"
2856  "scattering properties of particles can be different from that used \n"
2857  "for radiative transfer calculation. \n"
2858  "\n"
2859  "Usage: Method output.\n"
2860  ),
2861  GROUP( "Index" )));
2862 
2863  wsv_data.push_back
2864  (WsvRecord
2865  ( NAME( "scat_data_meta" ),
2866  DESCRIPTION
2867  (
2868  "Structure for the scattering meta data.\n"
2869  "\n"
2870  "This variable holds the scattering meta data for a single particle.\n"
2871  "This data is needed for particle size distribution calculations.\n"
2872  "\n"
2873  "Currently some of the meta data entries are not used by ARTS,\n"
2874  "but were included for future extensions of pnd calculations in ARTS.\n"
2875  "This applies to: \"shape\", \"A_proje\", \"asratio\"\n"
2876  "\n"
2877  "Usage: Set by the user.\n"
2878  "\n"
2879  "Dimensions/Units:\n"
2880  "\tString[description]\t[particle description]\n"
2881  "\tString[type]\t\t[''Ice'', ''Water''...]\n"
2882  "\tString[shape]\t\t[''Droxtal'', ''Aggregate'', ''Spherical'', ...]\n"
2883  "\tNumeric[density]\t[kg/m3]\n"
2884  "\tNumeric[d_max]\t\t[m]\n"
2885  "\tNumeric[V]\t\t[m3]\n"
2886  "\tNumeric[A_proje]\t[m2]\n"
2887  "\tNumeric[asratio]\t[]\n"
2888  ),
2889  GROUP( "ScatteringMetaData" )));
2890 
2891  wsv_data.push_back
2892  (WsvRecord
2893  ( NAME( "scat_data_meta_array" ),
2894  DESCRIPTION
2895  (
2896  "An Array of ScatteringMetaData.\n"
2897  "\n"
2898  "The elements of the array hold the scattering meta data for a single particle.\n"
2899  "This data is needed for particle size distribution calculations, with *pnd_fieldSetup*.\n"
2900  "\n"
2901  "Currently some of the meta data entries are not used by ARTS, but were included for \n"
2902  "future extensions of pnd calculations in ARTS.\n"
2903  "This applies to: \"shape\", \"A_proje\", \"asratio\"\n"
2904  "\n"
2905  "Note: This array must contain as many elements as *scat_data_raw*\n"
2906  "\n"
2907  "Usage: Set by the user.\n"
2908  "\n"
2909  "Dimensions/Units: Array[particle types]\n"
2910  "\tString[description]\t[particle description]\n"
2911  "\tString[type]\t\t[''Ice'', ''Water''...]\n"
2912  "\tString[shape]\t\t[''Droxtal'', ''Aggregate'', ''Spherical'', ...]\n"
2913  "\tNumeric[density]\t[kg/m3]\n"
2914  "\tNumeric[d_max]\t\t[m]\n"
2915  "\tNumeric[V]\t\t[m3]\n"
2916  "\tNumeric[A_proje]\t[m2]\n"
2917  "\tNumeric[asratio]\t[]\n"
2918  ),
2919  GROUP( "ArrayOfScatteringMetaData" )));
2920 
2921 
2922  wsv_data.push_back
2923  (WsvRecord
2924  ( NAME( "scat_data_mono" ),
2925  DESCRIPTION
2926  (
2927  "Monochromatic single scattering data.\n"
2928  "\n"
2929  "This variable holds the single scattering properties for all \n"
2930  "hydrometeor species. It is calculated from *scat_data_raw* by \n"
2931  "*scat_data_monoCalc*, which interpolates *scat_data_raw* for the \n"
2932  "required frequency.\n"
2933  ),
2934  GROUP( "ArrayOfSingleScatteringData" )));
2935 
2936  wsv_data.push_back
2937  (WsvRecord
2938  ( NAME( "scat_data_nelem" ),
2939  DESCRIPTION
2940  (
2941  "This Array has the same size as *part_species*. \n"
2942  "\n"
2943  "Each element holds the number of scattering data files, associated\n"
2944  "with the criteria given by *part_species*.\n"
2945  "\n"
2946  "Usage: WSM *ScatteringParticlesSelect* creates *scat_data_nelem*.\n"
2947  ),
2948  GROUP( "ArrayOfIndex" )));
2949 
2950  wsv_data.push_back
2951  (WsvRecord
2952  ( NAME( "scat_data_raw" ),
2953  DESCRIPTION
2954  (
2955  "Raw data of single scattering data.\n"
2956  "\n"
2957  "This variable holds the single scattering properties for all \n"
2958  "hydrometeor species included in a calculation by using the \n"
2959  "methods *ParticleTypeAdd* or *ParticleTypeAddAll*. \n"
2960  "For more information refer to ArtsWiki.\n"
2961  "\n"
2962  "Option: See also *ScatteringParticleTypeAndMetaRead* for reading \n"
2963  "*SingleScatteringData* and *ScatteringMetaData*.\n"
2964  "\n"
2965  "The unit of the single scattering properties is m^2.\n"
2966  "\n"
2967  "This may be used in combination with *scat_data_meta_array*\n"
2968  "\n"
2969  "Usage: Method ouput.\n"
2970  "\n"
2971  "Dimensions: Array[particle types] \n"
2972  " SingleScatteringData \n"
2973  " Enum[particle type attribute]\n"
2974  " String[description] \n"
2975  " Vector[f_grid]\n"
2976  " Vector[T_grid]\n"
2977  " Vector[za_grid]\n"
2978  " Vector[aa_grid]\n"
2979  " Tensor7[pha_mat_data]\n"
2980  " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
2981  " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
2982  " scattered incoming\n"
2983  " Tensor5[ext_mat_data]\n"
2984  " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
2985  " Tensor5[abs_vec_data]\n"
2986  " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
2987  ),
2988  GROUP( "ArrayOfSingleScatteringData" )));
2989 
2990  wsv_data.push_back
2991  (WsvRecord
2992  ( NAME( "scat_i_lat" ),
2993  DESCRIPTION
2994  (
2995  "Intensity field on cloudbox boundary (constant latitude slice).\n"
2996  "\n"
2997  "This variable gives the intensity field from all directions defined \n"
2998  "in *scat_aa_grid* and *scat_za_grid* on each grid point on the two \n"
2999  "equal \n"
3000  "latitude levels of the cloudbox boundary. It contains all four \n"
3001  "components of the Stokes vector.\n"
3002  "\n"
3003  "This variable is used as interface between the clear sky and the \n"
3004  "scattering calculations. \n"
3005  "\n"
3006  "See further the ARTS user guide (AUG). Use the index to find where\n"
3007  "this variable is discussed. The variable is listed as a subentry to\n"
3008  "\"workspace variables\".\n"
3009  "\n"
3010  "Usage: In/Output from/to *ScatteringDoit* and *ScatteringDisort*\n"
3011  "\n"
3012  "Unit: W / (m^2 Hz sr) \n"
3013  "\n"
3014  "Dimensions: [ f_grid, p_grid, 2, lon_grid, \n"
3015  " scat_za_grid \n scat_aa_grid, stokes_dim ]\n"
3016  ),
3017  GROUP( "Tensor7" )));
3018 
3019  wsv_data.push_back
3020  (WsvRecord
3021  ( NAME( "scat_i_lon" ),
3022  DESCRIPTION
3023  (
3024  "Intensity field on cloudbox boundary (equal longitude slice).\n"
3025  "\n"
3026  "This variable gives the intensity field from all directions defined \n"
3027  "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
3028  "longitude level of the boundary of the cloudbox, which is defined \n"
3029  "by the workspace variable *cloudbox_limits*. It contains all four \n"
3030  "components of the Stokes vector.\n"
3031  "\n"
3032  "This variable is used as interface between the clear sky and the \n"
3033  "scattering calculations. \n"
3034  "\n"
3035  "See further the ARTS user guide (AUG). Use the index to find where\n"
3036  "this variable is discussed. The variable is listed as a subentry to\n"
3037  "\"workspace variables\".\n"
3038  "\n"
3039  "Usage: Output from *ScatteringDoit* and *ScatteringDisort* \n"
3040  "\n"
3041  "Unit: W / (m^2 Hz sr) \n"
3042  "\n"
3043  "Dimensions: [ f_grid, p_grid, lat_grid, 2, \n"
3044  " scat_za_grid, scat_aa_grid, stokes_dim]\n"
3045  ),
3046  GROUP( "Tensor7" )));
3047 
3048  wsv_data.push_back
3049  (WsvRecord
3050  ( NAME( "scat_i_p" ),
3051  DESCRIPTION
3052  (
3053  "Intensity field on cloudbox boundary (equal pressure slice).\n"
3054  "\n"
3055  "This variable gives the intensity field from all directions defined \n"
3056  "in *scat_aa_grid* and *scat_za_grid* on each grid point on the equal\n"
3057  "pressure levels of the cloudbox boundary. It contains all four \n"
3058  "components of the Stokes vector.\n"
3059  "\n"
3060  "This variable is used as interface between the clear sky and the \n"
3061  "scattering calculations. \n"
3062  "\n"
3063  "See further the ARTS user guide (AUG). Use the index to find where\n"
3064  "this variable is discussed. The variable is listed as a subentry to\n"
3065  "\"workspace variables\".\n"
3066  "\n"
3067  "Usage: In/Output from *ScatteringDoit* and *ScatteringDisort* \n"
3068  "\n"
3069  "Unit: W / (m^2 Hz sr) \n"
3070  "\n"
3071  "Dimensions: [ f_grid, 2, lat_grid, lon_grid, \n"
3072  " scat_za_grid, scat_aa_grid, stokes_dim]\n"
3073  ),
3074  GROUP( "Tensor7" )));
3075 
3076  wsv_data.push_back
3077  (WsvRecord
3078  ( NAME( "scat_lat_index" ),
3079  DESCRIPTION
3080  (
3081  "Latitude index for scattering calculations.\n"
3082  "\n"
3083  "This variable is used in methods used for computing scattering\n"
3084  "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3085  "It holds the information about the position for which the \n"
3086  "scattering calculations are done. \n"
3087  "\n"
3088  "Usage: Input to the methods *spt_calc_agenda*,\n"
3089  " *pha_mat_spt_agenda*\n"
3090  ),
3091  GROUP( "Index" )));
3092 
3093  wsv_data.push_back
3094  (WsvRecord
3095  ( NAME( "scat_lon_index" ),
3096  DESCRIPTION
3097  (
3098  "Longitude index for scattering calculations.\n"
3099  "\n"
3100  "This variable is used in methods used for computing scattering\n"
3101  "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3102  "It holds the information about the position for which the \n"
3103  "scattering calculations are done. \n"
3104  "\n"
3105  "Usage: Input to the methods *spt_calc_agenda*,\n"
3106  " *pha_mat_spt_agenda*\n"
3107  ),
3108  GROUP( "Index" )));
3109 
3110  wsv_data.push_back
3111  (WsvRecord
3112  ( NAME( "scat_p_index" ),
3113  DESCRIPTION
3114  (
3115  "Pressure index for scattering calculations.\n"
3116  "\n"
3117  "This variable is used in methods used for computing scattering\n"
3118  "properties of particles like *opt_prop_sptFromData* and *pha_matCalc*.\n"
3119  "It holds the information about the location for which the \n"
3120  "scattering calculations are done.\n"
3121  "\n"
3122  "Usage: Input to the methods *spt_calc_agenda*,\n"
3123  " *pha_mat_spt_agenda*\n"
3124  ),
3125  GROUP( "Index" )));
3126 
3127  wsv_data.push_back
3128  (WsvRecord
3129  ( NAME( "scat_za_grid" ),
3130  DESCRIPTION
3131  (
3132  "Zenith angle grid.\n"
3133  "\n"
3134  "The zenith angle grid, on which the intensity field is stored. \n"
3135  "This grid is used for RT calculations inside the cloudbox, therefore\n"
3136  "the grid has to be defined\n"
3137  "if the cloudbox is activated by the flag *cloudbox_on*.\n"
3138  "The grid must be sorted in increasing order, with no repetitions.\n"
3139  "\n"
3140  "Usage: Set by the user.\n"
3141  "\n"
3142  "Unit: degrees \n"
3143  ),
3144  GROUP( "Vector" )));
3145 
3146  wsv_data.push_back
3147  (WsvRecord
3148  ( NAME( "scat_za_index" ),
3149  DESCRIPTION
3150  (
3151  "Zenith angle index for scattering calculations.\n"
3152  " \n"
3153  "This variable is used internally in WSMs for computing scattering \n"
3154  "properties. \n"
3155  "\n"
3156  "Usage: Input to the agendas *spt_calc_agenda*, \n "
3157  " *pha_mat_spt_agenda*.\n"
3158  ),
3159  GROUP( "Index" )));
3160 
3161  wsv_data.push_back
3162  (WsvRecord
3163  ( NAME( "sensor_description_amsu" ),
3164  DESCRIPTION
3165  (
3166  "Sensor description for simple AMSU setup.\n"
3167  "\n"
3168  "This is a compact description of an AMSU-type sensor. The matrix\n"
3169  "contains one row for each instrument channel. Each row contains three\n"
3170  "elements: LO position [Hz], offset of the channel center from the LO\n"
3171  "[Hz], and channel width [Hz].\n"
3172  "\n"
3173  "Usage: Set by the user.\n"
3174  "\n"
3175  "Unit: All entries in Hz.\n"
3176  "\n"
3177  "Size: [number of channels, 3]\n"
3178  ),
3179  GROUP( "Matrix" )));
3180 
3181  wsv_data.push_back
3182  (WsvRecord
3183  ( NAME( "sensor_los" ),
3184  DESCRIPTION
3185  (
3186  "The sensor line-of-sight (LOS) for each measurement block.\n"
3187  "\n"
3188  "Line-of-sights are specified by giving the zenith and azimuth angles.\n"
3189  "Column 1 holds the zenith angle. This angle is simply the angle \n"
3190  "between the zenith and LOS directions. For 1D and 3D the valid\n"
3191  "range is [0 180], while for 2D angles down to -180 degrees are\n"
3192  "allowed. Negative angles signifies for 2D observations towards\n"
3193  "lower latitudes, while positive angles means observations towards\n"
3194  "higher latitudes. Nadir corresponds throughout to 180 degrees.\n"
3195  "\n"
3196  "The azimuth angle is given with respect to the meridian plane. That\n"
3197  "is, the plane going through the north and south poles. The valid \n"
3198  "range is [-180,180] where angles are counted clockwise; 0 means\n"
3199  "that the viewing or propagation direction is north-wise and +90 means\n"
3200  "that the direction of concern goes eastward.\n"
3201  "\n"
3202  "See further the ARTS user guide (AUG). Use the index to find where\n"
3203  "this variable is discussed. The variable is listed as a subentry to\n"
3204  "\"workspace variables\".\n"
3205  "\n"
3206  "Usage: Set by the user.\n"
3207  "\n"
3208  "Unit: [ degrees, degrees ]\n"
3209  "\n"
3210  "Size: [ number of measurement blocks, 1 or 2 ]\n"
3211  ),
3212  GROUP( "Matrix" )));
3213 
3214  wsv_data.push_back
3215  (WsvRecord
3216  ( NAME( "sensor_norm" ),
3217  DESCRIPTION
3218  (
3219  "Flag if sensor response should be normalised or not (0 or 1).\n"
3220  "\n"
3221  "If the flag is set to 1 each sensor response is normalised (where\n"
3222  "applicable). If set to 0 the sensor responses are left as provided.\n"
3223  "\n"
3224  "See further the ARTS user guide (AUG). Use the index to find where\n"
3225  "this variable is discussed. The variable is listed as a sub-entry to\n"
3226  "\"workspace variables\".\n"
3227  "\n"
3228  "Usage: Set by the user.\n"
3229  ),
3230  GROUP( "Index" )));
3231 
3232  wsv_data.push_back
3233  (WsvRecord
3234  ( NAME( "sensor_pol" ),
3235  DESCRIPTION
3236  (
3237  "Sensor polarisations.\n"
3238  "\n"
3239  "The default for output is to give data for the selected Stokes\n"
3240  "elements (1:stokes_dim). This variable defines the polarisations\n"
3241  "that are actually measured (= or just what shall be outputted).\n"
3242  "This variable is used as input for WSM that handles the extraction\n"
3243  "of polarisation components. This in contrast to *sensor_response_pol*\n"
3244  "and that are used for internal bookkeeping\n"
3245  "\n"
3246  "The polarisation states/components are coded as\n"
3247  " 0 = Undefined.\n"
3248  " 1 = I, total intensity.\n"
3249  " 2 = Q, second Stokes component, Iv - Ih.\n"
3250  " 3 = U, third Stokes component, I+45 - I-45.\n"
3251  " 4 = V, forth Stokes component, Irc - Ilc\n"
3252  " 5 = Iv, intensity of vertically polarised component.\n"
3253  " 6 = Ih, intensity of horizontally polarised component.\n"
3254  " 7 = I+45, intensity of +45 deg linearly polarised component.\n"
3255  " 8 = I-45, intensity of -45 deg linearly polarised component.\n"
3256  " 9 = Irhc, intensity of right-hand circularly polarised component.\n"
3257  " 10 = Ilhc, intensity of left-hand circularly polarised component.\n"
3258  "\n"
3259  "See the documentation for definition of the Stokes vector and the\n"
3260  "different components.\n"
3261  "\n"
3262  "If the sensor measures the vertical and horisontal componenets, this\n"
3263  "variable shall accordingly be set to [5,6].\n"
3264  "\n"
3265  "The conversion to Planck-BT of components 2-4 requires that component\n"
3266  "1 is kept, and is put as first element.\n"
3267  "\n"
3268  "The shift from the Stokes vector can be made at any stage when of the\n"
3269  "sensor response set-up. The responses used must of course be adopted\n"
3270  "correspondingly. Or reversed, if the antenna response is defined for\n"
3271  "Iv and Ih it could be useful to shift polarisation as first sensor\n"
3272  "operation.\n"
3273  "\n"
3274  "Usage: Set by the user.\n"
3275  ),
3276  GROUP( "ArrayOfIndex" )));
3277 
3278  wsv_data.push_back
3279  (WsvRecord
3280  ( NAME( "sensor_pos" ),
3281  DESCRIPTION
3282  (
3283  "The sensor position for each measurement block.\n"
3284  "\n"
3285  "The sensor positions are specified as a matrix, where the number of\n"
3286  "columns shall be equal to *atmosphere_dim*. Column 1 shall contain\n"
3287  "the radius of observation posotion, column 2 the latitude and the \n"
3288  "last column the longitude. The number of rows corresponds to the\n"
3289  "number of measurement blocks.\n"
3290  "\n"
3291  "Valid range for latitudes in 3D is [-90,90], while for 2D any value\n"
3292  "is accepted. Accepted range for longitudes are [-360,360].\n"
3293  "\n"
3294  "See further the ARTS user guide (AUG). Use the index to find where\n"
3295  "this variable is discussed. The variable is listed as a subentry to\n"
3296  "\"workspace variables\".\n"
3297  "\n"
3298  "Usage: Set by the user.\n"
3299  "\n"
3300  "Unit: [ m, degrees, degrees ]\n"
3301  "\n"
3302  "Size: [ number of measurement blocks, atmosphere_dim ]\n"
3303  ),
3304  GROUP( "Matrix" )));
3305 
3306  wsv_data.push_back
3307  (WsvRecord
3308  ( NAME( "sensor_response" ),
3309  DESCRIPTION
3310  (
3311  "The matrix modelling the total sensor response.\n"
3312  "\n"
3313  "This matrix describes the sensor respons for one measurement block\n"
3314  "The response is assumed to be identical for each such block.\n"
3315  "\n"
3316  "The matrix is the product of all the individual sensor response\n"
3317  "matrices. Therefore its dimensions are depending on the total sensor\n"
3318  "configuration. The *sensor_response* has to initialised by the \n"
3319  "*sensor_responseInit* method.\n"
3320  "\n"
3321  "Usage: Output/input to the *sensor_response...* methods.\n"
3322  "\n"
3323  "Units: -\n"
3324  "\n"
3325  "Dimension: See the individual *sensor_response...* method. \n"
3326  ),
3327  GROUP( "Sparse" )));
3328 
3329  wsv_data.push_back
3330  (WsvRecord
3331  ( NAME( "sensor_response_aa" ),
3332  DESCRIPTION
3333  (
3334  "The relative azimuth angles associated with the output of\n"
3335  "*sensor_response*.\n"
3336  "\n"
3337  "Definition of angle matches *mblock_aa_grid*. Works otherwise as\n"
3338  "*sensor_response_f*.\n"
3339  "\n"
3340  "The variable shall not be set manually, it will be set together with\n"
3341  "*sensor_response* by sensor response WSMs.\n"
3342  "\n"
3343  "Usage: Set by sensor response methods.\n"
3344  "\n"
3345  "Unit: [ degrees ]\n"
3346  ),
3347  GROUP( "Vector" )));
3348 
3349  wsv_data.push_back
3350  (WsvRecord
3351  ( NAME( "sensor_response_aa_array" ),
3352  DESCRIPTION
3353  (
3354  "As *sensor_response_aa* refers to *sensor_response_array*.\n"
3355  ),
3356  GROUP( "ArrayOfVector" )));
3357 
3358  wsv_data.push_back
3359  (WsvRecord
3360  ( NAME( "sensor_response_aa_grid" ),
3361  DESCRIPTION
3362  (
3363  "The azimuth angle grid associated with *sensor_response*.\n"
3364  "\n"
3365  "A variable for communication between sensor response WSMs. Matches\n"
3366  "initially *mblock_aa_grid*, but is later adjusted according to the\n"
3367  "sensor specifications. Only defined when a common grid exists. Values\n"
3368  "are here not repeated as in *sensor_response_aa*\n"
3369  "\n"
3370  "The zenith and azimuth dimensions are joined into a single dimension\n"
3371  "after the antenna. The variables *sensor_response_za_grid* and \n"
3372  "*sensor_response_aa_grid* have then the same length after the antenna\n"
3373  "(if antenna_dim = 2), holding data taken from the columns of \n"
3374  "*antenna_los*.\n"
3375  "\n"
3376  "Usage: Set by sensor response methods.\n"
3377  "\n"
3378  "Unit: [ degrees ]\n"
3379  ),
3380  GROUP( "Vector" )));
3381 
3382  wsv_data.push_back
3383  (WsvRecord
3384  ( NAME( "sensor_response_agenda" ),
3385  DESCRIPTION
3386  (
3387  "See agendas.cc.\n"
3388  ),
3389  GROUP( "Agenda" )));
3390 
3391  wsv_data.push_back
3392  (WsvRecord
3393  ( NAME( "sensor_response_array" ),
3394  DESCRIPTION
3395  (
3396  "A set of *sensor_response* matrices.\n"
3397  "\n"
3398  "The main application of this variable should be to describe the\n"
3399  "sensor characterstics for different measurement blocks (then\n"
3400  "together with *sensor_response_index*.)\n"
3401  ),
3402  GROUP( "ArrayOfSparse" )));
3403 
3404  wsv_data.push_back
3405  (WsvRecord
3406  ( NAME( "sensor_response_f" ),
3407  DESCRIPTION
3408  (
3409  "The frequencies associated with the output of *sensor_response*.\n"
3410  "\n"
3411  "This vector gives the frequency for each element of the measurement\n"
3412  "vector produced inside one measurement block. The frequencies of\n"
3413  "the total measurement vector, *y*, are obtained by repeating these\n"
3414  "frequencies n times, where n is the number of measurement blocks\n"
3415  "(e.g. the number of rows in *sensor_pos*).\n"
3416  "\n"
3417  "The variable shall not be set manually, it will be set together with\n"
3418  "*sensor_response* by sensor response WSMs.\n"
3419  "\n"
3420  "Usage: Set by sensor response methods.\n"
3421  "\n"
3422  "Unit: [ Hz ]\n"
3423  ),
3424  GROUP( "Vector" )));
3425 
3426  wsv_data.push_back
3427  (WsvRecord
3428  ( NAME( "sensor_response_f_array" ),
3429  DESCRIPTION
3430  (
3431  "As *sensor_response_f* refers to *sensor_response_array*.\n"
3432  ),
3433  GROUP( "ArrayOfVector" )));
3434 
3435  wsv_data.push_back
3436  (WsvRecord
3437  ( NAME( "sensor_response_f_grid" ),
3438  DESCRIPTION
3439  (
3440  "The frequency grid associated with *sensor_response*.\n"
3441  "\n"
3442  "A variable for communication between sensor response WSMs. Matches\n"
3443  "initially *f_grid*, but is later adjusted according to the sensor\n"
3444  "specifications. Only defined when a common grid exists. Values are\n"
3445  "here not repeated as in *sensor_response_f*\n"
3446  "\n"
3447  "Usage: Set by sensor response methods.\n"
3448  "\n"
3449  "Unit: [ Hz ]\n"
3450  ),
3451  GROUP( "Vector" )));
3452 
3453  wsv_data.push_back
3454  (WsvRecord
3455  ( NAME( "sensor_response_index" ),
3456  DESCRIPTION
3457  (
3458  "Identification of *sensor_response* for each measurement block.\n"
3459  "\n"
3460  "This variable shall hold an index number for each measurement block.\n"
3461  "Typically this index identifies which element of\n"
3462  "*sensor_response_array* that shall be applied.\n"
3463  "\n"
3464  "Zero based indexing is applied.\n"
3465  ),
3466  GROUP( "ArrayOfIndex" )));
3467 
3468  wsv_data.push_back
3469  (WsvRecord
3470  ( NAME( "sensor_response_pol" ),
3471  DESCRIPTION
3472  (
3473  "The polarisation states associated with the output of\n"
3474  "*sensor_response*.\n"
3475  "\n"
3476  "Works basically as *sensor_response_f*.\n"
3477  "\n"
3478  "See *sensor_pol* for coding of polarisation states.\n"
3479  "\n"
3480  "The variable shall not be set manually, it will be set together with\n"
3481  "*sensor_response* by sensor response WSMs.\n"
3482  "\n"
3483  "Usage: Set by sensor response methods.\n"
3484  "\n"
3485  "Unit: [ - ]\n"
3486  ),
3487  GROUP( "ArrayOfIndex" )));
3488 
3489  wsv_data.push_back
3490  (WsvRecord
3491  ( NAME( "sensor_response_pol_array" ),
3492  DESCRIPTION
3493  (
3494  "As *sensor_response_pol* refers to *sensor_response_array*.\n"
3495  ),
3496  GROUP( "ArrayOfArrayOfIndex" )));
3497 
3498  wsv_data.push_back
3499  (WsvRecord
3500  ( NAME( "sensor_response_pol_grid" ),
3501  DESCRIPTION
3502  (
3503  "The \"polarisation grid\" associated with *sensor_response*.\n"
3504  "\n"
3505  "A variable for communication between sensor response WSMs. It is\n"
3506  "initially 1:stokes_dim, but can later adjusted according to the \n"
3507  "sensor specifications. Only defined when a common grid exists. \n"
3508  "\n"
3509  "See *sensor_pol* for coding of polarisation states.\n"
3510  "\n"
3511  "Usage: Set by sensor response methods.\n"
3512  "\n"
3513  "Unit: [ - ]\n"
3514  ),
3515  GROUP( "ArrayOfIndex" )));
3516 
3517  wsv_data.push_back
3518  (WsvRecord
3519  ( NAME( "sensor_response_za" ),
3520  DESCRIPTION
3521  (
3522  "The relative zenith angles associated with the output of\n"
3523  "*sensor_response*.\n"
3524  "\n"
3525  "Definition of angle matches *mblock_za_grid*. Works otherwise as\n"
3526  "*sensor_response_f*.\n"
3527  "\n"
3528  "The variable shall not be set manually, it will be set together with\n"
3529  "*sensor_response* by sensor response WSMs.\n"
3530  "\n"
3531  "Usage: Set by sensor response methods.\n"
3532  "\n"
3533  "Unit: [ degrees ]\n"
3534  ),
3535  GROUP( "Vector" )));
3536 
3537  wsv_data.push_back
3538  (WsvRecord
3539  ( NAME( "sensor_response_za_array" ),
3540  DESCRIPTION
3541  (
3542  "As *sensor_response_za* refers to *sensor_response_array*.\n"
3543  ),
3544  GROUP( "ArrayOfVector" )));
3545 
3546  wsv_data.push_back
3547  (WsvRecord
3548  ( NAME( "sensor_response_za_grid" ),
3549  DESCRIPTION
3550  (
3551  "The zenith angle grid associated with *sensor_response*.\n"
3552  "\n"
3553  "A variable for communication between sensor response WSMs. Matches\n"
3554  "initially *mblock_za_grid*, but is later adjusted according to the\n"
3555  "sensor specifications. Only defined when a common grid exists. Values\n"
3556  "are here not repeated as in *sensor_response_za*\n"
3557  "\n"
3558  "The zenith and azimuth dimensions are joined into a single dimension\n"
3559  "after the antenna. The variables *sensor_response_za_grid* and \n"
3560  "*sensor_response_aa_grid* have then the same length after the antenna\n"
3561  "(if antenna_dim = 2), holding data taken from the columns of \n"
3562  "*antenna_los*.\n"
3563  "\n"
3564  "Usage: Set by sensor response methods.\n"
3565  "\n"
3566  "Unit: [ degrees ]\n"
3567  ),
3568  GROUP( "Vector" )));
3569 
3570  /* Sensor rotation not yet updated
3571  wsv_data.push_back
3572  (WsvRecord
3573  ( NAME( "sensor_rot" ),
3574  DESCRIPTION
3575  (
3576  "The rotation of the sensor for each antenna line-of-sight.\n"
3577  "\n"
3578  "The rotation is the angle between the atmospheric and sensor frames\n"
3579  "for polarisation. The angle increases with clockwise rotation of the\n"
3580  "sensor when looking along the line-of-sight of the sensor. \n"
3581  "\n"
3582  "If the purpose of the simulations is to extract the polarisation\n"
3583  "of the radiation coming from the atmosphere (no sensor), the angles\n"
3584  "shall be set to 0.\n"
3585  "\n"
3586  "The size of the vector shall either be equal to the number of rows in\n"
3587  "*antenna_los* or be one. In the latter case the constant rotation\n"
3588  "will be applied for all antennae line-of-sight.\n"
3589  "\n"
3590  "See further the ARTS user guide (AUG). Use the index to find where\n"
3591  "this variable is discussed. The variable is listed as a subentry to\n"
3592  "\"workspace variables\".\n"
3593  "\n"
3594  "Usage: Set by the user.\n"
3595  "\n"
3596  "Unit: [ degrees ]\n"
3597  "\n"
3598  "Size: [ number of antennae or one ]\n"
3599  ),
3600  GROUP( "Vector" )));
3601  */
3602 
3603  wsv_data.push_back
3604  (WsvRecord
3605  ( NAME( "sensor_time" ),
3606  DESCRIPTION
3607  (
3608  "The time for each measurement block.\n"
3609  "\n"
3610  "This WSV is used when a time must be assigned to the measurements.\n"
3611  "No specific time format has (yet) been specified.\n"
3612  "\n"
3613  "Usage: Set by the user.\n"
3614  "\n"
3615  "Unit: [ arbitrary ]\n"
3616  "\n"
3617  "Size: [ number of measurement blocks ]\n"
3618  ),
3619  GROUP( "Vector" )));
3620 
3621  wsv_data.push_back
3622  (WsvRecord
3623  ( NAME( "sideband_mode" ),
3624  DESCRIPTION
3625  (
3626  "Description of target sideband.\n"
3627  "\n"
3628  "A text string describing which of the two sidebands (of a heterodyne\n"
3629  "instrument) that can be seen as \"main\" band. Possible choices are:\n"
3630  " \"lower\" : Low frequency sideband shall be considered as target.\n"
3631  " \"upper\" : High frequency sideband shall be considered as target.\n"
3632  "\n"
3633  "Usage: Set by the user.\n"
3634  ),
3635  GROUP( "String" )));
3636 
3637  wsv_data.push_back
3638  (WsvRecord
3639  ( NAME( "sideband_mode_multi" ),
3640  DESCRIPTION
3641  (
3642  "Description of target sideband for a multiple LO reciever.\n"
3643  "\n"
3644  "As *sideband_mode* but handles an instrument with several LO chains.\n"
3645  "See further *lo_multi* and *sideband_response_multi*. This length of\n"
3646  "this array must match the size of those WSVs.\n"
3647  "\n"
3648  "Usage: Set by the user.\n"
3649  ),
3650  GROUP( "ArrayOfString" )));
3651 
3652 
3653  wsv_data.push_back
3654  (WsvRecord
3655  ( NAME( "sideband_response" ),
3656  DESCRIPTION
3657  (
3658  "Description of (mixer) sideband response.\n"
3659  "\n"
3660  "This variable describes the response of each sideband of a heterodyne\n"
3661  "receiver. The response is given as a GriddedField1, with frequency as the\n"
3662  "grid. The actual data describe the sideband filter function at each\n"
3663  "frequency grid point. An interpolation is applied to obtain the\n"
3664  "response for other frequencies.\n"
3665  "\n"
3666  "The frequency grid should be given in terms of IF, with end points\n"
3667  "symmetrically placed around zero. That is, the grid must contain\n"
3668  "both negative and positive values. The sideband response (after \n"
3669  "summation with *lo*) is not allowed to extend outside the range\n"
3670  "for which spectral data exist (normally determined by *f_grid*).\n"
3671  "\n"
3672  "Usage: Set by the user.\n"
3673  "\n"
3674  "Dimensions: \n"
3675  " GriddedField1:\n"
3676  " Vector f_grid[N_f]\n"
3677  " Vector data[N_f]\n"
3678  ),
3679  GROUP( "GriddedField1" )));
3680 
3681  wsv_data.push_back
3682  (WsvRecord
3683  ( NAME( "sideband_response_multi" ),
3684  DESCRIPTION
3685  (
3686  "Description of multiple (mixer) sideband responses.\n"
3687  "\n"
3688  "As *sideband_response* but describes an instrument with multiple\n"
3689  "mixers. An array element for each LO. The size of this variable and\n"
3690  "*lo_multi* shall match.\n"
3691  "\n"
3692  "Unit: Hz\n"
3693  "\n"
3694  "Usage: Set by the user.\n"
3695  ),
3696  GROUP( "ArrayOfGriddedField1" )));
3697 
3698  wsv_data.push_back
3699  (WsvRecord
3700  ( NAME( "single_scattering_data" ),
3701  DESCRIPTION
3702  (
3703  "Structure for the single scattering data.\n"
3704  "\n"
3705  "See futher the ArtsWiki documentation were the SingleScatteringData\n"
3706  "structure is disussed.\n"
3707  "\n"
3708  "Usage: Set by the user.\n"
3709  "\n"
3710  "Dimensions: SingleScatteringData \n"
3711  " Enum[particle type attribute]\n"
3712  " String[description] \n"
3713  " Vector[f_grid]\n"
3714  " Vector[T_grid]\n"
3715  " Vector[za_grid]\n"
3716  " Vector[aa_grid]\n"
3717  " Tensor7[pha_mat_data]\n"
3718  " [f_grid, T_grid, za_grid, aa_grid, za_grid, aa_grid, matrix_element]\n"
3719  " ^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^\n"
3720  " scattered incoming\n"
3721  " Tensor5[ext_mat_data]\n"
3722  " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3723  " Tensor5[abs_vec_data]\n"
3724  " [f_grid, T_grid, za_grid, aa_grid, matrix_element]\n"
3725  ),
3726  GROUP( "SingleScatteringData" )));
3727 
3728  wsv_data.push_back
3729  (WsvRecord
3730  ( NAME( "stokes_dim" ),
3731  DESCRIPTION
3732  (
3733  "The dimensionality of the Stokes vector (1-4).\n"
3734  "\n"
3735  "Usage: Set by the user.\n"
3736  ),
3737  GROUP( "Index" )));
3738 
3739  wsv_data.push_back
3740  (WsvRecord
3741  ( NAME( "spt_calc_agenda" ),
3742  DESCRIPTION
3743  (
3744  "See agendas.cc.\n"
3745  ),
3746  GROUP( "Agenda" )));
3747 
3748  wsv_data.push_back
3749  (WsvRecord
3750  ( NAME( "surface_emission" ),
3751  DESCRIPTION
3752  ( "The emission from the surface.\n"
3753  "\n"
3754  "See specific methods generating *surface_emission* and the user guide\n"
3755  "for more information.\n"
3756  "\n"
3757  "Unit: W / (m^2 Hz sr)\n"
3758  "\n"
3759  "Dimensions: [ f_grid, stokes_dim ]\n"
3760  ),
3761  GROUP( "Matrix" )));
3762 
3763  wsv_data.push_back
3764  (WsvRecord
3765  ( NAME( "surface_emissivity_DISORT" ),
3766  DESCRIPTION
3767  ( "The surface emissivity specified on lat_grid and lon_grid.\n"
3768  "\n"
3769  "Remnant from a first solution for surface emissivity fields.\n"
3770  "Should be replaced with more flexible solution allowing emissivity\n"
3771  "to vary with incidence angle.\n"
3772  "\n"
3773  "Dimensions: [ lat_grid, lon_grid ]\n"
3774  ),
3775  GROUP( "Matrix" )));
3776 
3777  wsv_data.push_back
3778  (WsvRecord
3779  ( NAME( "surface_los" ),
3780  DESCRIPTION
3781  (
3782  "Directions for which to calculate downwelling radiation when \n"
3783  "considering a surface reflection.\n"
3784  "\n"
3785  "See further the user guide.\n"
3786  "\n"
3787  "Units: degrees\n"
3788  "\n"
3789  "Size: [ any number, 1 or 2 ]\n"
3790  ),
3791  GROUP( "Matrix" )));
3792 
3793  wsv_data.push_back
3794  (WsvRecord
3795  ( NAME( "surface_prop_agenda" ),
3796  DESCRIPTION
3797  (
3798  "See agendas.cc.\n"
3799  ),
3800  GROUP( "Agenda" )));
3801 
3802  wsv_data.push_back
3803  (WsvRecord
3804  ( NAME( "surface_rmatrix" ),
3805  DESCRIPTION
3806  (
3807  "The reflection coefficients for the directions given by\n"
3808  "*surface_los* to the direction of interest.\n"
3809  "\n"
3810  "The rows and columns of this tensor holds the reflection\n"
3811  "coefficient matrix for one frequency and one LOS. The reflection\n"
3812  "coefficients shall take into accound the angular weighting if the\n"
3813  "downwelling radiation.\n"
3814  "\n"
3815  "See specific methods generating *surface_rmatrix* and the user guide\n"
3816  "for more information.\n"
3817  "\n"
3818  "Usage: Input to methods for *surface_prop_agenda*."
3819  "\n"
3820  "Units: -\n"
3821  "\n"
3822  "Dimensions: [ surface_los, f_grid, stokes_dim, stokes_dim ]\n"
3823  ),
3824  GROUP( "Tensor4" )));
3825 
3826  wsv_data.push_back
3827  (WsvRecord
3828  ( NAME( "surface_skin_t" ),
3829  DESCRIPTION
3830  (
3831  "Surface skin temperature.\n"
3832  "\n"
3833  "This temperature shall be selected considering the radiative\n"
3834  "properties of the surface, and can differ from the \"bulk\"\n"
3835  "temperature.\n"
3836  "\n"
3837  "Usage: Input to methods for *surface_prop_agenda*.\n"
3838  ),
3839  GROUP( "Numeric" )));
3840 
3841  wsv_data.push_back
3842  (WsvRecord
3843  ( NAME( "surface_scalar_reflectivity" ),
3844  DESCRIPTION
3845  (
3846  "Surface reflectivity, assuming it can be described as a scalar value.\n"
3847  "\n"
3848  "This variable describes the surface reflectivity at one position.\n"
3849  "\n"
3850  "The variable is primarily intended for scalar radiative transfer.\n"
3851  "The assumptions made, when using this variable with values of\n"
3852  "*stokes_dim* above 1, are described in the methods using this\n"
3853  "variable as input.\n"
3854  "\n"
3855  "The length of the vector shall either match *f_grid* or be 1. The \n"
3856  "later case is interpreted as the reflectivity is the same for all\n"
3857  "frequencies (ie. matches a constant vector).\n"
3858  "\n"
3859  "Usage: Input to some surface properties methods.\n"
3860  "\n"
3861  "Dimensions: [ f_grid or 1]\n"
3862  ),
3863  GROUP( "Vector" )));
3864 
3865  wsv_data.push_back
3866  (WsvRecord
3867  ( NAME( "test_agenda" ),
3868  DESCRIPTION
3869  (
3870  "See agendas.cc.\n"
3871  ),
3872  GROUP( "Agenda" )));
3873 
3874  wsv_data.push_back
3875  (WsvRecord
3876  ( NAME( "timer" ),
3877  DESCRIPTION
3878  (
3879  "Stores the starting time for time measurements.\n"
3880  ),
3881  GROUP( "Timer" )));
3882 
3883  wsv_data.push_back
3884  (WsvRecord
3885  ( NAME( "t_field" ),
3886  DESCRIPTION
3887  (
3888  "The field of atmospheric temperatures.\n"
3889  "\n"
3890  "This variable gives the atmospheric temperature at each crossing of\n"
3891  "the pressure, latitude and longitude grids.\n"
3892  "\n"
3893  "The temperature for a point between the grid crossings is obtained \n"
3894  "by (multi-)linear interpolation of the *t_field*.\n"
3895  "\n"
3896  "See further the ARTS user guide (AUG). Use the index to find where\n"
3897  "this variable is discussed. The variable is listed as a subentry to\n"
3898  "\"workspace variables\".\n"
3899  "\n"
3900  "Usage: Output of *AtmFieldsCalc*.\n"
3901  "\n"
3902  "Unit: K\n"
3903  "\n"
3904  "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
3905  ),
3906  GROUP( "Tensor3" )));
3907 
3908  wsv_data.push_back
3909  (WsvRecord
3910  ( NAME( "t_field_raw" ),
3911  DESCRIPTION
3912  (
3913  "Raw data for atmospheric temperatures.\n"
3914  "\n"
3915  "This variable gives the atmospheric temperature as stored in the \n"
3916  "database for the atmospheric scenarios.\n"
3917  "\n"
3918  "See further the ARTS user guide (AUG). Use the index to find where\n"
3919  "this variable is discussed. The variable is listed as a subentry to\n"
3920  "\"workspace variables\".\n"
3921  "\n"
3922  "Usage: Set by the user by choosing a climatology.\n"
3923  "\n"
3924  "Unit: K\n"
3925  "\n"
3926  "Size GriddedField3 \n "
3927  " [N_p] \n"
3928  " [N_lat] \n"
3929  " [N_lon] \n"
3930  " [N_p, N_lat, N_lon] \n"
3931  ),
3932  GROUP( "GriddedField3" )));
3933 
3934  wsv_data.push_back
3935  (WsvRecord
3936  ( NAME( "t_surface" ),
3937  DESCRIPTION
3938  (
3939  "The surface temperature.\n"
3940  "\n"
3941  "This variable holds the temperature of the surface at each latitude\n"
3942  "and longitude grid crossing. The normal case should be that this \n"
3943  "temperature field is interpolated to obtain *surface_skin_t*.\n"
3944  "Accordingly, for 1D cases it could be a better idea to specify\n"
3945  "*surface_skin_t* directly.\n"
3946  "\n"
3947  "These temperature shall be selected considering the radiative\n"
3948  "properties of the surface, and can differ from the \"bulk\"\n"
3949  "temperatures.\n"
3950  "\n"
3951  "Usage: Set by user.\n"
3952  "\n"
3953  "Unit: K\n"
3954  "\n"
3955  "Dimensions: [ lat_grid, lon_grid ]\n"
3956  ),
3957  GROUP( "Matrix" )));
3958 
3959  wsv_data.push_back
3960  (WsvRecord
3961  ( NAME( "use_mean_scat_data" ),
3962  DESCRIPTION
3963  (
3964  "Flag to use same scattering properties for all frequencies.\n"
3965  "\n"
3966  "This flag is not considered y all scattering methods, but (at least)\n"
3967  "by *iyFOS* and *iyBeerLambertStandardCloudbox*.\n"
3968  "\n"
3969  "If set to 1, the scattering properties are extracted for a single\n"
3970  "frequency, and these properties are applied for all frequncies when\n"
3971  "performing the actual radiative transfer calculations. This can save\n"
3972  "considerable time. The option can be when the width of the band is\n"
3973  "small comapred to the mean frequency. The properties are extracted\n"
3974  "for the mean of min and max of *f_grid*.\n"
3975  "\n"
3976  "If set to 0, standard calculations are made (scattering properties\n"
3977  "extracted for each frequency).\n"
3978  "\n"
3979  "Usage: Set by user.\n"
3980  ),
3981  GROUP( "Index" )));
3982 
3983  wsv_data.push_back
3984  (WsvRecord
3985  ( NAME( "verbosity" ),
3986  DESCRIPTION
3987  (
3988  "ARTS verbosity.\n"
3989  "\n"
3990  "!!! UNDER CONSTRUCTION !!! Currently unused\n"
3991  "\n"
3992  "Usage: Set by user.\n"
3993  ),
3994  GROUP( "Verbosity" )));
3995 
3996  wsv_data.push_back
3997  (WsvRecord
3998  ( NAME( "vmr_field" ),
3999  DESCRIPTION
4000  (
4001  "VMR field.\n"
4002  "\n"
4003  "This variable gives the volume mixing ratio of the chosen gaseous \n"
4004  "species as a function of p_grid, lat_grid, lon_grid. \n"
4005  "\n"
4006  "See further the ARTS user guide (AUG). Use the index to find where\n"
4007  "this variable is discussed. The variable is listed as a subentry to\n"
4008  "\"workspace variables\".\n"
4009  "\n"
4010  "\n"
4011  "Usage: Calculated internally.\n"
4012  "\n"
4013  "Unit: absolute numbers \n"
4014  "\n"
4015  "Dimensions: [species, p_grid, lat_grid, lon_grid]\n"
4016  ),
4017  GROUP( "Tensor4" )));
4018 
4019  wsv_data.push_back
4020  (WsvRecord
4021  ( NAME( "vmr_field_raw" ),
4022  DESCRIPTION
4023  (
4024  "VMR data for the chosen gaseous species.\n"
4025  "\n"
4026  "This variable contains the volume mixing ratios (VMR) for all \n"
4027  "chosen gaseous species. It includes the grids corresponding to the \n"
4028  "grids in the database. \n"
4029  "*vmr_field_raw* is an Array of Array of Tensor3. It contains one \n"
4030  "gridded field for each species which contains the data and \n"
4031  "also the grids.\n"
4032  "For the calculation the data is \n"
4033  "interpolated on *p_grid*, *lat_grid* and *lon_grid*\n"
4034  "\n"
4035  "Usage: Output of *AtmRawRead*\n"
4036  " Input to *AtmFieldsCalc*.\n"
4037  "\n"
4038  "Unit: absolute number\n"
4039  "\n"
4040  "Size: Array[N_pt]\n"
4041  " GriddedField3 \n "
4042  " [N_p] \n"
4043  " [N_lat] \n"
4044  " [N_lon] \n"
4045  " [N_p, N_lat, N_lon] \n"
4046  ),
4047  GROUP( "ArrayOfGriddedField3" )));
4048 
4049  wsv_data.push_back
4050  (WsvRecord
4051  ( NAME( "wmrf_channels" ),
4052  DESCRIPTION
4053  (
4054  "Channel selection for WMRF fast calculation.\n"
4055  "\n"
4056  "This variable can be used to select one or several instrument channels\n"
4057  "from the list of all possible channels. Zero-based indexing is used, so\n"
4058  "Channel 0 is the first instrument channel!\n"
4059  ),
4060  GROUP( "ArrayOfIndex" )));
4061 
4062  wsv_data.push_back
4063  (WsvRecord
4064  ( NAME( "wind_u_field" ),
4065  DESCRIPTION
4066  (
4067  "Meridional (second horizontal wind) component field for 3D.\n"
4068  "\n"
4069  "The east-west wind component. Air moving towards higher\n"
4070  "longitudes is a positive wind.\n"
4071  "\n"
4072  "Can be set to be empty, which is interpreted as zero wind speed\n"
4073  "everywhere.\n"
4074  "\n"
4075  "Unit: m/s\n"
4076  "\n"
4077  "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ].\n"
4078  ),
4079  GROUP( "Tensor3" )));
4080 
4081  wsv_data.push_back
4082  (WsvRecord
4083  ( NAME( "wind_v_field" ),
4084  DESCRIPTION
4085  (
4086  "Horizontal 1D, 2D or 3D wind components.\n"
4087  "\n"
4088  "This wind component is defined differently for the atmospheric\n"
4089  "dimensionalities.\n"
4090  "\n"
4091  " 1D: Complete vertical wind. The wind is treated to always be aligned\n"
4092  "azimuthally with the observation direction. That is, the vertical\n"
4093  "winds converge/start at geographical position of the sensor. A wind\n"
4094  "going away from the sensor is treated as positive.\n"
4095  "\n"
4096  " 2D: Complete vertical wind. The wind is treated to be aligned with\n"
4097  "the 2D cross-section the atmosphere represents. Air moving towards\n"
4098  "higher latitudes is considered as a positive wind.\n"
4099  "\n"
4100  " 3D: The north-south wind component. Air moving towards higher\n"
4101  "latitudes is a positive wind.\n"
4102  "\n"
4103  "Can be set to be empty, which is interpreted as zero wind speed\n"
4104  "everywhere.\n"
4105  "\n"
4106  "Unit: m/s\n"
4107  "\n"
4108  "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"
4109  ),
4110  GROUP( "Tensor3" )));
4111 
4112  wsv_data.push_back
4113  (WsvRecord
4114  ( NAME( "wind_w_field" ),
4115  DESCRIPTION
4116  (
4117  "Vertical wind component field.\n"
4118  "\n"
4119  "Upward moving air corresponds to a positive wind speed.\n"
4120  "\n"
4121  "Can be set to be empty, which is interpreted as zero wind speed\n"
4122  "everywhere.\n"
4123  "\n"
4124  "Unit: m/s\n"
4125  "\n"
4126  "Dimensions: [ p_grid, lat_grid, lon_grid ] or [ 0 0 0 ]\n"
4127  ),
4128  GROUP( "Tensor3" )));
4129 
4130  wsv_data.push_back
4131  (WsvRecord
4132  ( NAME( "wmrf_weights" ),
4133  DESCRIPTION
4134  (
4135  "The weights for a WMRF fast calculation.\n"
4136  "\n"
4137  "Weights are stored in a sparse matrix. This can be used as a\n"
4138  "sensor_response matrix.\n"
4139  "\n"
4140  "The dimension of the matrix is (nchan, nfreq), where nchan\n"
4141  "is the number of instrument channels and nfreq is the number\n"
4142  "of monochromatic frequencies.\n"
4143  ),
4144  GROUP( "Sparse" )));
4145 
4146  wsv_data.push_back
4147  (WsvRecord
4148  ( NAME( "xml_output_type" ),
4149  DESCRIPTION
4150  (
4151  "Flag to determine whether XML output shall be binary or ascii.\n"
4152  "\n"
4153  "This flag has to be set using the workspace method\n"
4154  "*output_file_formatSetAscii* or *output_file_formatSetBinary*.\n"
4155  "One of these methods MUST be called before writing the first\n"
4156  "output file.\n"
4157  "\n"
4158  "Usage: Set by user.\n"
4159  ),
4160  GROUP( "Index" )));
4161 
4162  wsv_data.push_back
4163  (WsvRecord
4164  ( NAME( "y" ),
4165  DESCRIPTION
4166  (
4167  "The measurement vector.\n"
4168  "\n"
4169  "This vector holds radiances averaged in frequency and spatially,\n"
4170  "and can contain many spectra appended. \n"
4171  "\n"
4172  "Usage: Output from radiative transfer calculations considering\n"
4173  " sensor response.\n"
4174  "\n"
4175  "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
4176  " optical thickness.\n"
4177  ),
4178  GROUP( "Vector" )));
4179 
4180  wsv_data.push_back
4181  (WsvRecord
4182  ( NAME( "y_aux" ),
4183  DESCRIPTION
4184  (
4185  "Data auxilary to *y*\n"
4186  "\n"
4187  "A general variable to provide data auxilary to *y*. The content of\n"
4188  "this variable depends on method selected for *iy_clearsky_agenda*\n"
4189  "and *iy_cloudbox_agenda*. For methods dealing with radiance data,\n"
4190  "this variable is used to report the transmission of the atmosphere.\n"
4191  "This transmission can be calculated in a simplified manner, or be\n"
4192  "set to special values to indicate e.g. an interception with the\n"
4193  "cloudbox. See the relevant WSMs for details, and also *iy_aux*. \n"
4194  "\n"
4195  "If created through *yCalc*, the weighting with *sensor_response*\n"
4196  "is included. A value of 999 indicates that no data have been\n"
4197  "provided by the agenda methods.\n"
4198  ),
4199  GROUP( "Vector" )));
4200 
4201  wsv_data.push_back
4202  (WsvRecord
4203  ( NAME( "y_error" ),
4204  DESCRIPTION
4205  (
4206  "Estimate of calculation errors in *y*.\n"
4207  "\n"
4208  "This variable is used for providing an error estimate. The estimate\n"
4209  "covers only the actual calculation approach, and e.g. uncertainties\n"
4210  "in spectroscopic data or representation errors due to coarse grids\n"
4211  "are not considered. This means that the error should normally be\n"
4212  "zero for clear-sky cases where calculations are performed for the\n"
4213  "complete propagation path.\n"
4214  ),
4215  GROUP( "Vector" )));
4216 
4217  wsv_data.push_back
4218  (WsvRecord
4219  ( NAME( "y_f" ),
4220  DESCRIPTION
4221  (
4222  "The frequencies associated with *y*.\n"
4223  "\n"
4224  "A value is returned for each element of *y*. Depending on the sensor\n"
4225  "set-up and number of measurement blocks, this can be a copy of\n"
4226  "*sensor_response_f*, sveral copies of this vector appended, or some\n"
4227  "other frequenices.\n"
4228  "\n"
4229  "Usage: Output from radiative transfer calculations considering\n"
4230  " sensor response.\n"
4231  "\n"
4232  "Unit: [ Hz ]\n"
4233  ),
4234  GROUP( "Vector" )));
4235 
4236  wsv_data.push_back
4237  (WsvRecord
4238  ( NAME( "y_los" ),
4239  DESCRIPTION
4240  (
4241  "The line-of-sights associated with *y*.\n"
4242  "\n"
4243  "Definition of angles matches *sensor_los* (such as first column holds\n"
4244  "zenith angles), but gives actual observed LOS. That is, the values of\n"
4245  "both *sensor_los* and *antenna_los* are considered. Data are provided\n"
4246  "for each element of *y*, following y_f, and the number of rows equals\n"
4247  "the length of *y*.\n"
4248  "\n"
4249  "Usage: Output from radiative transfer calculations considering\n"
4250  " sensor response.\n"
4251  "\n"
4252  "Unit: [ degrees, degrees ]\n"
4253  ),
4254  GROUP( "Matrix" )));
4255 
4256  wsv_data.push_back
4257  (WsvRecord
4258  ( NAME( "y_pol" ),
4259  DESCRIPTION
4260  (
4261  "The polarisation states associated with *y*.\n"
4262  "\n"
4263  "Data are provided for each element of *y*, following y_f, and the\n"
4264  "length of this variable and *y* is equal.\n"
4265  "\n"
4266  "See *sensor_pol* for coding of polarisation components.\n"
4267  "\n"
4268  "Usage: Output from radiative transfer calculations considering\n"
4269  " sensor response.\n"
4270  "\n"
4271  "Unit: [ - ]\n"
4272  ),
4273  GROUP( "ArrayOfIndex" )));
4274 
4275  wsv_data.push_back
4276  (WsvRecord
4277  ( NAME( "y_pos" ),
4278  DESCRIPTION
4279  (
4280  "The sensor positions associated with *y*.\n"
4281  "\n"
4282  "Definition of positions matches *sensor_pos* (such as first column\n"
4283  "holds the radius). Data are provided for each element of *y*,\n"
4284  "following y_f, and the number of rows equals the length of *y*.\n"
4285  "\n"
4286  "Usage: Output from radiative transfer calculations considering\n"
4287  " sensor response.\n"
4288  "\n"
4289  "Unit: [ degrees, degrees ]\n"
4290  ),
4291  GROUP( "Matrix" )));
4292 
4293  wsv_data.push_back
4294  (WsvRecord
4295  ( NAME( "y_unit" ),
4296  DESCRIPTION
4297  (
4298  "Unit for spectral values returned by radiative transfer methods.\n"
4299  "\n"
4300  "The basic unit is determined by the definition of background\n"
4301  "radiation and atmospheric and surface source terms. The standard\n"
4302  "choices give radiances in unit of [W/m2/Hz/sr]. This variable\n"
4303  "allows conversion to other units.\n"
4304  "\n"
4305  "Please note that there is no way for ARTS to check the actual unit\n"
4306  "of a spectral value. In principle, the unit can differ between the\n"
4307  "elements. The user must makes sure that any unit conversion is\n"
4308  "applied correctly, and in accordance with the calibration of the\n"
4309  "instrument of concern. Note especially that the brightness\n"
4310  "temperature of pure Stokes elements is obtained with a common power\n"
4311  "reference. In short, the ratio is Q/I is not changed by the\n"
4312  "conversion (beside a non-linear effect for PlanckBT). This in\n"
4313  "contrast to Iv and other single \"measurement\" single polarisation\n"
4314  "componenets, where a Tb of e.g. Iv=200K corresponds to half of the\n"
4315  "power for I=200K (total power). See further the documentation.\n"
4316  "See *y_pol* for defined polarisation componenets.\n"
4317  "\n"
4318  "Possible choices are:\n"
4319  " \"1\" : No conversion.\n"
4320  " \"RJBT\" : Conversion to Rayleigh-Jean brightness temperature.\n"
4321  " \"PlanckBT\" : Conversion to Planck brightness temperature.\n"
4322  " \"W/(m^2 m sr)\" : Conversion to [W/(m^2 m sr)] (radiance per wavelength unit).\n"
4323  " \"W/(m^2 m-1 sr)\": Conversion to [W/(m^2 m-1 sr)] (radiance per wavenumber unit).\n"
4324  "\n"
4325  "Usage: Set by the user.\n"
4326  ),
4327  GROUP( "String" )));
4328 
4329  wsv_data.push_back
4330  (WsvRecord
4331  ( NAME( "yb" ),
4332  DESCRIPTION
4333  (
4334  "The measurement vector for a single measurement block.\n"
4335  "\n"
4336  "Exactly as *y*, but holds data only for a single measurement block.\n"
4337  "\n"
4338  "Usage: Used internally.\n"
4339  ),
4340  GROUP( "Vector" )));
4341 
4342  wsv_data.push_back
4343  (WsvRecord
4344  ( NAME( "ybatch" ),
4345  DESCRIPTION
4346  (
4347  "Batch of spectra.\n"
4348  "\n"
4349  "Each column of *ybatch* corresponds to a spectrum vector *y*. \n"
4350  "See further *ybatchCalc*.\n"
4351  "\n"
4352  "Usage: Most commonly produced by *ybatch*.\n"
4353  "\n"
4354  "Unit: Undefined. Possibilities include: K, W/(m^2 Hz sr) and\n "
4355  " optical thickness.\n"
4356  "\n"
4357  "Dimensions: (length(y), number of batch cases)\n"
4358  ),
4359  GROUP( "Matrix" )));
4360 
4361  wsv_data.push_back
4362  (WsvRecord
4363  ( NAME( "ybatch_calc_agenda" ),
4364  DESCRIPTION
4365  (
4366  "See agendas.cc.\n"
4367  ),
4368  GROUP( "Agenda" )));
4369 
4370  wsv_data.push_back
4371  (WsvRecord
4372  ( NAME( "ybatch_index" ),
4373  DESCRIPTION
4374  (
4375  "Index of batch case.\n"
4376  "\n"
4377  "See further *ybatchCalc*.\n"
4378  "\n"
4379  "Usage: Set by *ybatchCalc*, for communication with\n"
4380  " *ybatch_calc_agenda*.\n"
4381  ),
4382  GROUP( "Index" )));
4383 
4384  wsv_data.push_back
4385  (WsvRecord
4386  ( NAME( "ybatch_jacobians" ),
4387  DESCRIPTION
4388  (
4389  "All the Jacobians associated with ybatch.\n"
4390  "\n"
4391  "The batch index here is the array dimension.\n"
4392  "\n"
4393  "Usage: Most commonly produced by *ybatch*.\n"
4394  "\n"
4395  "Unit: Depends on unit of y and on Jacobian type.\n"
4396  "\n"
4397  "Dimensions: [number of batch cases] \n"
4398  " (length(y), \n"
4399  " number of retrieval quantities and grids)\n"
4400  ),
4401  GROUP( "ArrayOfMatrix" )));
4402 
4403  wsv_data.push_back
4404  (WsvRecord
4405  ( NAME( "ybatch_n" ),
4406  DESCRIPTION
4407  (
4408  "Number of batch cases for *ybatchCalc*.\n"
4409  "\n"
4410  "See further *ybatchCalc*.\n"
4411  "\n"
4412  "Usage: Input to *ybatchCalc*.\n"
4413  ),
4414  GROUP( "Index" )));
4415 
4416  wsv_data.push_back
4417  (WsvRecord
4418  ( NAME( "ybatch_start" ),
4419  DESCRIPTION
4420  (
4421  "Start index for *ybatchCalc*.\n"
4422  "\n"
4423  "This is set to a default of zero in *general.arts*.\n"
4424  "\n"
4425  "See further *ybatchCalc*.\n"
4426  "\n"
4427  "Usage: Input to *ybatchCalc*.\n"
4428  ),
4429  GROUP( "Index" )));
4430 
4431  wsv_data.push_back
4432  (WsvRecord
4433  ( NAME( "z_field" ),
4434  DESCRIPTION
4435  (
4436  "The field of geometrical altitudes.\n"
4437  "\n"
4438  "This variable gives the geometrical altitude, above the geoid, of\n"
4439  "each crossing of the pressure, latitude and longitude grids. For 1D\n"
4440  "cases the altitudes give the geometrical position of the pressure\n"
4441  "levels.\n"
4442  "\n"
4443  "For each geographical position (lat,lon), the values must be sorted\n"
4444  "in increasing order, with no repetitions. Otherwise the altitudes\n"
4445  "can be set to arbitrary values. Hydrostatic equilibrium is not\n"
4446  "applied automatically. If hydrostatic equilibrium applies, *z_field*\n"
4447  "must be set by a method ensuring that this criterium is fulfilled.\n"
4448  "\n"
4449  "The radius (from the coordinate centre) for a point between the grid\n"
4450  "crossings is obtained by a (multi-)linear interpolation of the sum\n"
4451  "of *r_geoid* and *z_field*.\n"
4452  "\n"
4453  "See further the ARTS user guide (AUG). Use the index to find where\n"
4454  "this variable is discussed. The variable is listed as a subentry to\n"
4455  "\"workspace variables\".\n"
4456  "\n"
4457  "Usage: Output of *AtmFieldsCalc*\n"
4458  "\n"
4459  "Unit: m\n"
4460  "\n"
4461  "Dimensions: [ p_grid, lat_grid, lon_grid ]\n"
4462  ),
4463  GROUP( "Tensor3" )));
4464 
4465 // wsv_data.push_back
4466 // (WsvRecord
4467 // ( NAME( "gfield3" ),
4468 // DESCRIPTION
4469 // (
4470 // "Variable for testing the new gridded fields implementation.\n"
4471 // ),
4472 // GROUP( "GriddedField3" )));
4473 
4474  wsv_data.push_back
4475  (WsvRecord
4476  ( NAME( "z_field_raw" ),
4477  DESCRIPTION
4478  (
4479  "Raw data for geometrical altitudes.\n"
4480  "\n"
4481  "This variable gives the geometrical altitudes as stored in the \n"
4482  "database for atmospheric scenarios.\n"
4483  "\n"
4484  "See further the ARTS user guide (AUG). Use the index to find where\n"
4485  "this variable is discussed. The variable is listed as a subentry to\n"
4486  "\"workspace variables\".\n"
4487  "\n"
4488  "Usage: Set by the user by choosing a climatology.\n"
4489  "\n"
4490  "Unit: K\n"
4491  "\n"
4492  "Size GriddedField3 \n "
4493  " [N_p] \n"
4494  " [N_lat] \n"
4495  " [N_lon] \n"
4496  " [N_p, N_lat, N_lon] \n"
4497  ),
4498  GROUP( "GriddedField3" )));
4499 
4500  wsv_data.push_back
4501  (WsvRecord
4502  ( NAME( "z_hse_accuracy" ),
4503  DESCRIPTION
4504  (
4505  "Minimum accuracy for calculation of hydrostatic equilibrium.\n"
4506  "\n"
4507  "Usage: Set by the user.\n"
4508  "\n"
4509  "Unit: m\n"
4510  ),
4511  GROUP( "Numeric" )));
4512 
4513  wsv_data.push_back
4514  (WsvRecord
4515  ( NAME( "z_surface" ),
4516  DESCRIPTION
4517  (
4518  "The surface altitude.\n"
4519  "\n"
4520  "This variable defines the shape of the surface, by giving the\n"
4521  "geometrical altitude above the geiod for each crossing of the \n"
4522  "latitude and longitude grids. Any shape of the surface is accepted.\n"
4523  "No gap between the surface and the lowermost pressure level is \n"
4524  "allowed.\n"
4525  "\n"
4526  "The radius (from the coordinate centre) for a point between the grid\n"
4527  "crossings is obtained by a linear (1D) or bi-linear (2D) \n"
4528  "interpolation of the sum of *r_geoid* and *z_surface*. With other \n"
4529  "words, the radius for the surface is assumed to vary linear along \n"
4530  "the latitudes and longitudes in *lat_grid* and *lon_grid*.\n"
4531  "\n"
4532  "See further the ARTS user guide (AUG). Use the index to find where\n"
4533  "this variable is discussed. The variable is listed as a subentry to\n"
4534  "\"workspace variables\".\n"
4535  "\n"
4536  "Usage: Set by user.\n"
4537  "\n"
4538  "Unit: m\n"
4539  "\n"
4540  "Dimensions: [ lat_grid, lon_grid ]\n"
4541  ),
4542  GROUP( "Matrix" )));
4543 }
4544 
4545 
4547 
4555 Index get_wsv_id(const String& name)
4556 {
4557  map<String, Index>::const_iterator it = Workspace::WsvMap.find (name);
4558  if (it == Workspace::WsvMap.end())
4559  return -1;
4560  else
4561  return it->second;
4562 }
4563 
4564 
4566 
4577 Index get_wsv_id(const char *name)
4578 {
4579  return get_wsv_id(String(name));
4580 }
Workspace::wsv_data
static Array< WsvRecord > wsv_data
Definition: workspace_ng.h:59
array.h
This file contains the definition of Array.
matpackI.h
my_basic_string
The implementation for String, the ARTS string class.
Definition: mystring.h:62
Workspace::define_wsv_data
static void define_wsv_data()
Definition: workspace.cc:50
matpackIII.h
ppath.h
Propagation path structure and functions.
WsvRecord
This class contains all static information for one workspace variable.
Definition: wsv_aux.h:49
NAME
#define NAME(x)
Definition: workspace.cc:45
workspace_ng.h
This file contains the declaration and partly the implementation of the workspace class.
String
my_basic_string< char > String
The String type for ARTS.
Definition: mystring.h:305
Workspace::WsvMap
static map< String, Index > WsvMap
Definition: workspace_ng.h:62
matpackII.h
Header file for sparse matrices.
get_wsv_id
Index get_wsv_id(const String &name)
Get index of WSV.
Definition: workspace.cc:4555
Index
INDEX Index
The type to use for all integer numbers and indices.
Definition: matpack.h:39
GROUP
#define GROUP(x)
Definition: workspace.cc:47
wsv_aux.h
Auxiliary header stuff related to workspace variable groups.
matpackVI.h
DESCRIPTION
#define DESCRIPTION(x)
Definition: workspace.cc:46
arts.h
The global header file for ARTS.