ARTS  2.4.0(git:4fb77825)
agendas.cc
Go to the documentation of this file.
1 /* Copyright (C) 2002-2012 Stefan Buehler <sbuehler@ltu.se>
2 
3  This program is free software; you can redistribute it and/or modify it
4  under the terms of the GNU General Public License as published by the
5  Free Software Foundation; either version 2, or (at your option) any
6  later version.
7 
8  This program is distributed in the hope that it will be useful,
9  but WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  GNU General Public License for more details.
12 
13  You should have received a copy of the GNU General Public License
14  along with this program; if not, write to the Free Software
15  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
16  USA. */
17 
29 #include "agenda_record.h"
30 
31 // Some #defines and typedefs to make the records better readable:
32 #define NAME(x) x
33 #define DESCRIPTION(x) x
34 #define OUTPUT(...) \
35  { __VA_ARGS__ }
36 #define INPUT(...) \
37  { __VA_ARGS__ }
38 
40 namespace global_data {
42 }
43 
46 
47  // Initialize to zero, just in case:
48  agenda_data.resize(0);
49 
50  /*----------------------------------------------------------------------
51  Agendas must be put in in alphabetical order.
52  No distinction is made between uppercase and lowercase letters.
53  The sign "_" comes after all letters.
54  ----------------------------------------------------------------------*/
55 
56  agenda_data.push_back(AgRecord(
57  NAME("propmat_clearsky_agenda"),
59  "Calculate the absorption coefficient matrix.\n"
60  "\n"
61  "This agenda calculates the absorption coefficient matrix for all\n"
62  "absorption species as a function of the given atmospheric state for\n"
63  "one point in the atmosphere. The result is returned in\n"
64  "*propmat_clearsky*. The atmospheric state has to be specified by\n"
65  "*rtp_pressure*, *rtp_temperature*, *rtp_mag*, and *rtp_vmr*.\n"
66  "\n"
67  "The methods inside this agenda may require a lot of additional\n"
68  "input variables, such as *abs_species*, etc.\n"
69  "\n"
70  "The include file 'agendas.arts' predefines some possible agendas\n"
71  "that can be used here.\n"),
72  OUTPUT("propmat_clearsky",
73  "nlte_source",
74  "dpropmat_clearsky_dx",
75  "dnlte_dx_source",
76  "nlte_dsource_dx"),
77  INPUT("jacobian_quantities",
78  "f_grid",
79  "rtp_mag",
80  "rtp_los",
81  "rtp_pressure",
82  "rtp_temperature",
83  "rtp_nlte",
84  "rtp_vmr")));
85 
86  agenda_data.push_back(AgRecord(
87  NAME("abs_xsec_agenda"),
89  "Calculate scalar gas absorption cross sections.\n"
90  "\n"
91  "Basically, this agenda calculates absorption for all the tags defined\n"
92  "in abs_species. It is used both in the calculation of an absorption\n"
93  "lookup table, and in on-the-fly calculations. Typical effects to\n"
94  "include here are:\n"
95  "\n"
96  "Explicit line-by-line calculation (*abs_xsec_per_speciesAddLines*),\n"
97  "\n"
98  "Continua and complete absorption models (*abs_xsec_per_speciesAddConts*), and\n"
99  "\n"
100  "HITRAN style CIA continua (*abs_xsec_per_speciesAddCIA*)\n"
101  "\n"
102  "The only kind of absorption tag not handled here are Zeeman tags\n"
103  "and free electron density tags, because they need additional input\n"
104  "and because they return an absorption matrix, rather than a scalar.\n"
105  "\n"
106  "The include file 'agendas.arts' predefines a number of agendas that\n"
107  "should be useful for most users.\n"),
108  OUTPUT("abs_xsec_per_species",
109  "src_xsec_per_species",
110  "dabs_xsec_per_species_dx",
111  "dsrc_xsec_per_species_dx"),
112  INPUT("abs_species",
113  "jacobian_quantities",
114  "abs_species_active",
115  "f_grid",
116  "abs_p",
117  "abs_t",
118  "abs_nlte",
119  "abs_vmrs")));
120 
121  agenda_data.push_back(
122  AgRecord(NAME("dobatch_calc_agenda"),
123  DESCRIPTION("Calculations to perform for each batch case.\n"
124  "\n"
125  "See further *DOBatchCalc*.\n"),
126  OUTPUT("spectral_radiance_field",
127  "radiance_field",
128  "irradiance_field",
129  "spectral_irradiance_field"),
130  INPUT("ybatch_index")));
131 
132  agenda_data.push_back(AgRecord(
133  NAME("doit_conv_test_agenda"),
134  DESCRIPTION(
135  "Compute the convergence test.\n"
136  "\n"
137  "The method *cloudbox_field_monoIterate* solves the VRTE iteratively."
138  "This method requires \n"
139  "a convergence test. The user can choose different convergence tests\n"
140  "which are to be defined in this agenda.\n"
141  "\n"
142  "Possible workspace methods are:\n"
143  "*doit_conv_flagAbs*: Calculates the absolute differences \n"
144  " for each Stokes component separately.\n"
145  "*doit_conv_flagAbsBT*: Same as above, but the convergence limit\n"
146  " can be specified in Kelvin BT (Rayleigh Jeans).\n"
147  "*doit_conv_flagLsq*: Least square convergence test. Not recommended\n"
148  " because result can be inaccurate.\n"),
149  OUTPUT("doit_conv_flag", "doit_iteration_counter"),
150  INPUT("doit_conv_flag",
151  "doit_iteration_counter",
152  "cloudbox_field_mono",
153  "cloudbox_field_mono_old")));
154 
155  agenda_data.push_back(AgRecord(
156  NAME("doit_mono_agenda"),
157  DESCRIPTION(
158  "Performs monochromatic DOIT calculation."
159  "\n"
160  "This agenda includes for example the following methods:\n"
161  " 1. *DoitScatteringDataPrepare* \n"
162  " 2. *cloudbox_field_monoIterate*\n"
163  "\n"
164  "The result of the agenda is the radiation field inside the \n"
165  "cloudbox and on the cloudbox boundary, which can be used \n"
166  "as radiative background for a clearsky radiative transfer \n"
167  "calculation. \n"
168  "\n"
169  "See the Arts online documentation\n"
170  "for more information about the methods.\n"),
171  OUTPUT("cloudbox_field_mono"),
172  INPUT("cloudbox_field_mono", "f_grid", "f_index")));
173 
174  agenda_data.push_back(AgRecord(
175  NAME("doit_scat_field_agenda"),
176  DESCRIPTION(
177  "Calculation of the scattering integral field (DOIT). \n"
178  "\n"
179  "This agenda is called repeatedly in each DOIT iteration.\n"
180  "The following methods can be used for calculating the \n"
181  "scattering integral field: \n"
182  "\n"
183  "*doit_scat_fieldCalc*: This method calculates the scattering \n"
184  " integral field by using the angular grids *za_grid* \n"
185  " and *aa_grid*, which are also used in the update of the \n"
186  " radiation field (*doit_rte_agenda*).\n"
187  "\n"
188  "*doit_scat_fieldCalcLimb*: This method calculates the scattering \n"
189  " integral field. The difference to the previous method is that \n"
190  " the data is interpolated on equidistant angular grids. \n"
191  " Especially for limb, where a very fine zenith angle grid \n"
192  " resolution is required for the RT transfer part, this method \n"
193  " is much faster than *doit_scat_fieldCalc*. \n"),
194  OUTPUT("doit_scat_field"),
195  INPUT("doit_scat_field", "cloudbox_field_mono")));
196 
197  agenda_data.push_back(AgRecord(
198  NAME("doit_rte_agenda"),
199  DESCRIPTION(
200  "Radiative transfer calculations in cloudbox.\n"
201  "\n"
202  "Agenda for radiative transfer step calculations with \n"
203  "fixed scattering integral term shoul be specified here.\n"
204  "Output is the updated radiation field in the cloudbox. \n"
205  "This agenda is called repeatedly in each DOIT iteration.\n"
206  "\n"
207  "Normally one should use\n"
208  "*cloudbox_fieldUpdateSeq1D* or *cloudbox_fieldUpdateSeq3D*:\n"
209  "Seqential update of the radiation field.\n"
210  " This method is the fastest and most accurate method.\n"
211  "\n"
212  "A very similar method in plane parallel approximation is\n"
213  "*cloudbox_fieldUpdateSeq1DPP*:\n"
214  " This method also includes the sequential update and is slightly\n"
215  " faster than the above one. The drawback is that it is less\n"
216  " accurate, especially for limb geometries and large off-nadir\n"
217  " viewing angles.\n"
218  "\n"
219  "The following method was used before the sequential update\n"
220  "was invented. It is very slow and should therefore only \n"
221  "be used for test cases.\n"
222  "*cloudbox_fieldUpdate1D*: Old method.\n"),
223  OUTPUT("cloudbox_field_mono"),
224  INPUT("cloudbox_field_mono", "doit_scat_field")));
225 
226  agenda_data.push_back(AgRecord(
227  NAME("forloop_agenda"),
228  DESCRIPTION(
229  "The body for a for loop.\n"
230  "\n"
231  "This agenda contains the body of the for loop to be execute by the\n"
232  "method *ForLoop*.\n"),
233  OUTPUT(),
234  INPUT("forloop_index")));
235 
236  /*
237  agenda_data.push_back
238  (AgRecord
239  ( NAME( "fos_y_agenda" ),
240  DESCRIPTION
241  (
242  "Calculation of incoming radiation field for FOS method.\n"
243  "\n"
244  "The direct task of the agenda is to determine the incoming radiation\n"
245  "field, to evaluate of the scattering integral, for each angle in\n"
246  "*fos_angle*. The data are packed into *fos_y*.\n"
247  "\n"
248  "The underlying purpose of this agenda is to allow different\n"
249  "shortcuts for estimating the incoming radiation field. For example,\n"
250  "calculations can be performed for a few directions and then an\n"
251  "interpolation is performed to obtain the intensity for other\n"
252  "directions. The data could also be taken from a pre-calculated\n"
253  "database.\n"
254  ),
255  OUTPUT( "fos_y" ),
256  INPUT( "rte_pos", "fos_angles", "fos_n", "fos_i" )));
257  */
258 
259  agenda_data.push_back(
260  AgRecord(NAME("g0_agenda"),
261  DESCRIPTION("Calculation of the gravity at zero altitude.\n"
262  "\n"
263  "Returns *g0* for given geographical position.\n"),
264  OUTPUT("g0"),
265  INPUT("lat", "lon")));
266 
267  agenda_data.push_back(AgRecord(
268  NAME("geo_pos_agenda"),
269  DESCRIPTION(
270  "Geo-positioning of a pencil beam calculation.\n"
271  "\n"
272  "The task of this agenda is to set *geo_pos*. The standard choices are\n"
273  "to set that WSV to be empty or select a position along the propagation\n"
274  "path (described by *ppath*).\n"),
275  OUTPUT("geo_pos"),
276  INPUT("ppath")));
277 
278  agenda_data.push_back(AgRecord(
279  NAME("inversion_iterate_agenda"),
280  DESCRIPTION(
281  "Work in progress ...\n"
282  "\n"
283  "The WSV *jacobian* is both in- and output. As input variable, *jacobian*\n"
284  "is assumed to be valid for the previous iteration. For the first iteration\n"
285  "the input *jacobian* shall be set to have size zero, to flag that there\n"
286  "is not yet any calculated Jacobian.\n"),
287  OUTPUT("yf", "jacobian"),
288  INPUT("x", "jacobian_do", "inversion_iteration_counter")));
289 
290  agenda_data.push_back(AgRecord(
291  NAME("iy_cloudbox_agenda"),
292  DESCRIPTION(
293  "Intensity at boundary or interior of the cloudbox.\n"
294  "\n"
295  "The task of the agenda is to determine the intensity at some point\n"
296  "at the boundary of or inside the cloudbox. The actual calculations\n"
297  "inside the agenda differ depending on scattering solution method.\n"
298  "If DOIT is used, an interpolating of the intensity field should be\n"
299  "performed. Another option is to start backward Monte Carlo \n"
300  "calculations from this point.\n"
301  "\n"
302  "A function calling this agenda shall set *rte_pos* and *rte_los* to\n"
303  "the position and line-of-sight for which the scattered radiation\n"
304  "shall be determined.\n"
305  "\n"
306  "The include-file 'agendas.arts' pre-defines some agendas that can\n"
307  "either be used directly, or serve as examples.\n"),
308  OUTPUT("iy"),
309  INPUT("f_grid", "rtp_pos", "rtp_los")));
310 
311  agenda_data.push_back(AgRecord(
312  NAME("iy_independent_beam_approx_agenda"),
313  DESCRIPTION(
314  "Agenda dedicated to *iyIndependentBeamApproximation*.\n"
315  "\n"
316  "If *iyIndependentBeamApproximation* is used, this agenda basically\n"
317  "replaces *iy_main_agenda*. Accordingly, this agenda has exactly the\n"
318  "same output as *iy_main_agenda*.\n"),
319  OUTPUT("iy", "iy_aux", "ppath", "diy_dx"),
320  INPUT("diy_dx",
321  "iy_agenda_call1",
322  "iy_unit",
323  "iy_transmission",
324  "iy_aux_vars",
325  "iy_id",
326  "atmosphere_dim",
327  "p_grid",
328  "lat_grid",
329  "lon_grid",
330  "lat_true",
331  "lon_true",
332  "t_field",
333  "z_field",
334  "vmr_field",
335  "z_surface",
336  "ppath_lmax",
337  "ppath_lraytrace",
338  "cloudbox_on",
339  "cloudbox_limits",
340  "pnd_field",
341  "jacobian_do",
342  "f_grid",
343  "rte_pos",
344  "rte_los",
345  "rte_pos2")));
346 
347  agenda_data.push_back(AgRecord(
348  NAME("iy_loop_freqs_agenda"),
349  DESCRIPTION(
350  "Agenda dedicated to *iyLoopFrequencies*.\n"
351  "\n"
352  "If *iyLoopFrequencies* is used, this agenda basically replaces\n"
353  "*iy_main_agenda*.Accordingly, this agenda has exactly the same\n"
354  "output as *iy_main_agenda*.\n"),
355  OUTPUT("iy", "iy_aux", "ppath", "diy_dx"),
356  INPUT("diy_dx",
357  "iy_agenda_call1",
358  "iy_transmission",
359  "iy_aux_vars",
360  "iy_id",
361  "f_grid",
362  "rte_pos",
363  "rte_los",
364  "rte_pos2")));
365 
366  agenda_data.push_back(AgRecord(
367  NAME("iy_main_agenda"),
368  DESCRIPTION(
369  "Calculation of a single monochromatic pencil beam spectrum.\n"
370  "\n"
371  "The task of the agenda is to calculate the monochromatic pencil beam\n"
372  "spectrum for the position specified by *rte_pos* and the viewing\n"
373  "direction specified by *rte_los*.\n"
374  "\n"
375  "Methods for this agenda can either handle the complete calculation,\n"
376  "make use of e.g. *iy_cloudbox_agenda* or be restricted to special\n"
377  "cases. See the documentation for the different methods.\n"
378  "\n"
379  "The include-file 'agendas.arts' predefines some typical alternatives\n"
380  "that can be used directly, or adapted for specific applications.\n"),
381  OUTPUT("iy", "iy_aux", "ppath", "diy_dx"),
382  INPUT("diy_dx",
383  "iy_agenda_call1",
384  "iy_transmission",
385  "iy_aux_vars",
386  "iy_id",
387  "iy_unit",
388  "cloudbox_on",
389  "jacobian_do",
390  "f_grid",
391  "nlte_field",
392  "rte_pos",
393  "rte_los",
394  "rte_pos2")));
395 
396  agenda_data.push_back(AgRecord(
397  NAME("iy_space_agenda"),
398  DESCRIPTION(
399  "Downwelling radiation at the top of the atmosphere.\n"
400  "\n"
401  "Possible terms to include in this agenda include cosmic background\n"
402  "radiation and solar radiation.\n"
403  "\n"
404  "A function calling this agenda shall set *rtp_pos* and *rtp_los* to\n"
405  "the position and line-of-sight for which the entering radiation \n"
406  "shall be determined. The position and line-of-sight must be known, \n"
407  "for example, when radiation from the sun is considered.\n"
408  "\n"
409  "The include-file 'agendas.arts' predefines an agenda that can be\n"
410  "applied directly for most users.\n"),
411  OUTPUT("iy"),
412  INPUT("f_grid", "rtp_pos", "rtp_los")));
413 
414  agenda_data.push_back(AgRecord(
415  NAME("iy_surface_agenda"),
416  DESCRIPTION(
417  "Upwelling radiation from the surface.\n"
418  "\n"
419  "The task of the agenda is to determine the upwelling intensity from\n"
420  "the surface, for given point and direction.\n"
421  "\n"
422  "The standard choice should be to make use of *surface_rtprop_agenda*\n"
423  "through the WSM *iySurfaceRtpropAgenda*.\n"
424  "\n"
425  "A function calling this agenda shall set *rtp_pos* and *rtp_los* to\n"
426  "the position and line-of-sight for which the upwelling radiation\n"
427  "shall be determined.\n"
428  "\n"
429  "See also the include-file 'agendas.arts' for a predefined agenda\n"
430  "suitable to be used in most applications.\n"),
431  OUTPUT("iy", "diy_dx", "dsurface_rmatrix_dx", "dsurface_emission_dx"),
432  INPUT("diy_dx",
433  "dsurface_rmatrix_dx",
434  "dsurface_emission_dx",
435  "iy_unit",
436  "iy_transmission",
437  "iy_id",
438  "cloudbox_on",
439  "jacobian_do",
440  "iy_main_agenda",
441  "f_grid",
442  "nlte_field",
443  "rtp_pos",
444  "rtp_los",
445  "rte_pos2",
446  "surface_props_data",
447  "dsurface_names")));
448 
449  agenda_data.push_back(AgRecord(
450  NAME("iy_surface_agenda_array"),
451  DESCRIPTION(
452  "Upwelling radiation from the surface, divided into surface types.\n"
453  "\n"
454  "Each agenda element shall treat the radiative properties of a surface\n"
455  "type. The task of these agendas match directly *iy_surface_agenda*.\n"
456  "This with one exception, these agendas have one additional input:\n"
457  "*surface_type_aux*.\n"
458  "\n"
459  "See *surface_type_mask* for comments on the surface type coding\n"
460  "scheme. Note the parallel agenda array: surface_rtprop_agenda_array.\n"),
461  OUTPUT("iy", "diy_dx"),
462  INPUT("agenda_array_index",
463  "diy_dx",
464  "iy_unit",
465  "iy_transmission",
466  "iy_id",
467  "cloudbox_on",
468  "jacobian_do",
469  "iy_main_agenda",
470  "f_grid",
471  "rtp_pos",
472  "rtp_los",
473  "rte_pos2",
474  "surface_type_aux")));
475 
476  agenda_data.push_back(AgRecord(
477  NAME("iy_transmitter_agenda"),
478  DESCRIPTION(
479  "Transmitter signal.\n"
480  "\n"
481  "This agenda describes the signal at the start of the propagation\n"
482  "path for calculations of transmission type. That is, the agenda\n"
483  "describes a transmitter, which either can be a natural source or\n"
484  "an artificial device.\n"
485  "\n"
486  "The include-file 'agendas.arts' defines an example agenda that\n"
487  "can be used for transmission calculations\n"),
488  OUTPUT("iy"),
489  INPUT("f_grid", "rtp_pos", "rtp_los")));
490 
491  agenda_data.push_back(AgRecord(
492  NAME("jacobian_agenda"),
493  DESCRIPTION(
494  "Pure numerical Jacobian calculations.\n"
495  "\n"
496  "Parts of the Jacobian matrix can be determined by (semi-)analytical\n"
497  "expressions, while other parts are calculated in a pure numerical\n"
498  "manner (by perturbations). This agenda describes the calculations to\n"
499  "be performed in the later case.\n"
500  "\n"
501  "This agenda is normally not set directly by the user, but is created\n"
502  "by calling the the jacobianAdd set of methods.\n"),
503  OUTPUT("jacobian"),
504  INPUT("jacobian", "mblock_index", "iyb", "yb")));
505 
506  agenda_data.push_back(AgRecord(
507  NAME("main_agenda"),
508  DESCRIPTION(
509  "The agenda corresponding to the entire controlfile. This is\n"
510  "executed when ARTS is run.\n"),
511  OUTPUT(),
512  INPUT()));
513 
514  agenda_data.push_back(AgRecord(
515  NAME("met_profile_calc_agenda"),
516  DESCRIPTION(
517  "This agenda is used for metoffice profile calculations.\n"
518  "\n"
519  "This agenda is called inside the method *ybatchMetProfiles* which is\n"
520  "used to make a batch calculation for the metoffice profiles. \n"
521  "See the documentation of *ybatchMetProfiles* for more information.\n"
522  "\n"
523  "This agenda can be, for example, set up like this:\n"
524  "\n"
525  "*AtmFieldsCalc*\n"
526  "*abs_lookupAdapt*\n"
527  "*DoitInit*\n"
528  "*DoitGetIncoming*\n"
529  "*cloudbox_fieldSetClearsky*\n"
530  "*DoitCalc*\n"
531  "*yCalc*\n"),
532  OUTPUT("y"),
533  INPUT("t_field_raw",
534  "vmr_field_raw",
535  "z_field_raw",
536  "pnd_field_raw",
537  "p_grid",
538  "sensor_los",
539  "cloudbox_on",
540  "cloudbox_limits",
541  "z_surface")));
542 
543  agenda_data.push_back(AgRecord(
544  NAME("pha_mat_spt_agenda"),
545  DESCRIPTION(
546  "Calculates the phase matrix for individual scattering elements.\n"
547  "\n"
548  "Different options are possible for the usage of this agenda: \n"
549  "*pha_mat_sptFromData* or *pha_mat_sptFromDataDOITOpt*. \n"),
550  OUTPUT("pha_mat_spt"),
551  INPUT("pha_mat_spt",
552  "za_index",
553  "scat_lat_index",
554  "scat_lon_index",
555  "scat_p_index",
556  "aa_index",
557  "rtp_temperature")));
558 
559  agenda_data.push_back(AgRecord(
560  NAME("pnd_agenda_array"),
561  DESCRIPTION(
562  "Returns particle number density data for each scattering species.\n"
563  "\n"
564  "This variable is used when mapping data in *particle_bulkprop_field*\n"
565  "to *pnd_field*. The variable is also necessary when calculating\n"
566  "scattering species weighting functions.\n"
567  "\n"
568  "Note that content of this agenda array, *scat_species* and\n"
569  "*pnd_agenda_array_input_names* must be consistent.\n"),
570  OUTPUT("pnd_data", "dpnd_data_dx"),
571  INPUT("agenda_array_index",
572  "pnd_agenda_input_t",
573  "pnd_agenda_input",
574  "pnd_agenda_input_names",
575  "dpnd_data_dx_names")));
576 
577  agenda_data.push_back(AgRecord(
578  NAME("ppath_agenda"),
579  DESCRIPTION(
580  "Calculation of complete propagation paths.\n"
581  "\n"
582  "In contrast to *ppath_step_agenda* that controls the ray tracing\n"
583  "inside each grid box, this agenda determines how complete paths are\n"
584  "determined. The standard choice is to do this in a step-by-step\n"
585  "manner using *ppath_step_agenda*, with this agenda set to call\n"
586  "*ppathStepByStep*.\n"
587  "\n"
588  "The WSV *rte_los* is both input and output as in some cases it is\n"
589  "determined as part of the propagation path calculations (such as\n"
590  "radio link calculations).\n"),
591  OUTPUT("ppath"),
592  INPUT("ppath_lmax",
593  "ppath_lraytrace",
594  "rte_pos",
595  "rte_los",
596  "rte_pos2",
597  "cloudbox_on",
598  "ppath_inside_cloudbox_do",
599  "f_grid")));
600 
601  agenda_data.push_back(AgRecord(
602  NAME("ppath_step_agenda"),
603  DESCRIPTION(
604  "Calculation of a propagation path step.\n"
605  "\n"
606  "A propagation path step is defined as the path between some point \n"
607  "to a crossing with either the pressure, latitude or longitude grid,\n"
608  "and this agenda performs the calculations to determine such a \n"
609  "partial propagation path. The starting point is normally a grid \n"
610  "crossing point, but can also be an arbitrary point inside the \n"
611  "atmosphere, such as the sensor position. Only points inside the \n"
612  "model atmosphere are handled.\n"
613  "\n"
614  "The communication between this agenda and the calling method is \n"
615  "handled by *ppath_step*. That variable is used both as input and \n"
616  "output to *ppath_step_agenda*. The agenda gets back *ppath_step* \n"
617  "as returned to the calling method and the last path point hold by \n"
618  "the structure is accordingly the starting point for the new \n"
619  "calculations. If a total propagation path shall be determined, this\n"
620  "agenda is called repeatedly until the starting point of the \n"
621  "propagation path is found and *ppath_step* will hold all path \n"
622  "steps that together make up *ppath*. The starting point is included\n"
623  "in the returned structure. \n"
624  "\n"
625  "The path is determined by starting at the end point and moving \n"
626  "backwards to the starting point. The calculations are initiated by \n"
627  "filling *ppath_step* with the practical end point of the path. \n"
628  "This is either the position of the sensor (true or hypothetical), \n"
629  "or some point at the top of the atmosphere (determined by\n"
630  "geometrical calculations starting at the sensor). This \n"
631  "initialisation is not handled by *ppath_step_agenda* (but by \n"
632  "the internal function ppath_start_stepping). \n"
633  "\n"
634  "The *ppath_step_agenda* put in points along the propagation path \n"
635  "at all crossings with the grids, tangent points and points of \n"
636  "surface reflection. It is also allowed to make agendas that put in \n"
637  "additional points to fulfil some criterion, such as a maximum \n"
638  "distance along the path between the points. Accordingly, the \n"
639  "number of new points of each step can exceed one.\n"
640  "\n"
641  "The include file 'agendas.arts' defines some agendas that can be\n"
642  "used here."),
643  OUTPUT("ppath_step"),
644  INPUT("ppath_step", "ppath_lmax", "ppath_lraytrace", "f_grid")));
645 
646  agenda_data.push_back(AgRecord(
647  NAME("refr_index_air_agenda"),
648  DESCRIPTION(
649  "Calculation of the refractive index of air.\n"
650  "\n"
651  "This agenda should calculate the summed refractive index for all\n"
652  "relevant atmospheric constituents, with respect to both phase and\n"
653  "group velocity.\n"
654  "\n"
655  "The include file 'agendas.arts' predefines several agendas that\n"
656  "may either be used directly, or serve as inspiration.\n"),
657  OUTPUT("refr_index_air", "refr_index_air_group"),
658  INPUT("rtp_pressure", "rtp_temperature", "rtp_vmr", "f_grid")));
659 
660  agenda_data.push_back(AgRecord(
661  NAME("sensor_response_agenda"),
662  DESCRIPTION(
663  "This agenda shall provide *sensor_response* and associated variables.\n"
664  "\n"
665  "So far only required when doing inversions involving some sensor variables.\n"),
666  OUTPUT("sensor_response",
667  "sensor_response_f",
668  "sensor_response_f_grid",
669  "sensor_response_pol",
670  "sensor_response_pol_grid",
671  "sensor_response_dlos",
672  "sensor_response_dlos_grid",
673  "mblock_dlos_grid"),
674  INPUT("f_backend")));
675 
676  agenda_data.push_back(AgRecord(
677  NAME("spt_calc_agenda"),
678  DESCRIPTION(
679  "Calculates single scattering properties for individual scattering\n"
680  "elements from the amplitude matrix.\n"
681  "\n"
682  "This agenda sets up the methods, which should be used to calculate \n"
683  "the single scattering properties, i.e. the extinction matrix and the \n"
684  "absorbtion vector.\n "
685  "\n"
686  "Normally you use:\n"
687  "*opt_prop_sptFromMonoData*\n"),
688  OUTPUT("ext_mat_spt", "abs_vec_spt"),
689  INPUT("ext_mat_spt",
690  "abs_vec_spt",
691  "scat_p_index",
692  "scat_lat_index",
693  "scat_lon_index",
694  "rtp_temperature",
695  "za_index",
696  "aa_index")));
697 
698  agenda_data.push_back(AgRecord(
699  NAME("surface_rtprop_agenda"),
700  DESCRIPTION(
701  "Provides radiative properties of the surface. \n"
702  "\n"
703  "Provides surface emission and surface reflection coefficient matrix\n"
704  "(see user guide for closer definitions of the respective variables\n"
705  "*surface_emission*, *surface_los*, and *surface_rmatrix*) according\n"
706  "to the characteristics of the surface specified by the methods called\n"
707  "within the agenda. Typical meyhods include *surfaceBlackbody*,\n"
708  "*surfaceFlatScalarReflectivity*, *surfaceFlatReflectivity*,\n"
709  "*surfaceFlatRefractiveIndex*, and *surfaceLambertianSimple*.\n"),
710  OUTPUT("surface_skin_t",
711  "surface_emission",
712  "surface_los",
713  "surface_rmatrix"),
714  INPUT("f_grid", "rtp_pos", "rtp_los")));
715 
716  agenda_data.push_back(AgRecord(
717  NAME("surface_rtprop_agenda_array"),
718  DESCRIPTION(
719  "Description of surface radiative properties, divided into surface types.\n"
720  "\n"
721  "Each of these agendas shall treat the radiative properties of a\n"
722  " surface type. The task of these agendas is equivalent to that of\n"
723  "*surface_rtprop_agenda*. This with one exception, these agendas\n"
724  "have one additional input: *surface_type_aux*.\n"
725  "\n"
726  "See *surface_type_mask* for comments on the surface type coding\n"
727  "scheme. Note the parallel agenda series: iy_surface_sub_agendaX.\n"),
728  OUTPUT("surface_skin_t",
729  "surface_emission",
730  "surface_los",
731  "surface_rmatrix"),
732  INPUT("agenda_array_index",
733  "f_grid",
734  "rtp_pos",
735  "rtp_los",
736  "surface_type_aux")));
737 
738  agenda_data.push_back(AgRecord(
739  NAME("surface_rtprop_sub_agenda"),
740  DESCRIPTION(
741  "Has exact same functionality as *surface_rtprop_sub_agenda*.\n"
742  "\n"
743  "This agenda complements *surface_rtprop_sub_agenda*, to allow\n"
744  "specifying the surface properties using two levels of agendas.\n"
745  "For example, this agenda can describe the properties for pure specular\n"
746  "reflections, and *surface_rtprop_agenda* can call this agenda for several\n"
747  "angles to build up a more complex surface model.\n"),
748  OUTPUT("surface_skin_t",
749  "surface_emission",
750  "surface_los",
751  "surface_rmatrix"),
752  INPUT("f_grid", "rtp_pos", "rtp_los")));
753 
754  agenda_data.push_back(
755  AgRecord(NAME("test_agenda"),
756  DESCRIPTION("Dummy agenda for testing purposes.\n"),
757  OUTPUT(),
758  INPUT()));
759 
760  agenda_data.push_back(
761  AgRecord(NAME("test_agenda_array"),
762  DESCRIPTION("Agenda array for TestArrayOfAgenda test case.\n"),
763  OUTPUT(),
764  INPUT("agenda_array_index", "iy_unit")));
765 
766  agenda_data.push_back(AgRecord(
767  NAME("water_p_eq_agenda"),
768  DESCRIPTION("Calculation of the saturation pressure of water.\n"),
769  OUTPUT("water_p_eq_field"),
770  INPUT("t_field")));
771 
772  agenda_data.push_back(AgRecord(
773  NAME("ybatch_calc_agenda"),
774  DESCRIPTION(
775  "Calculations to perform for each batch case.\n"
776  "\n"
777  "Must produce a new spectrum vector (*y*) and Jacobi matrix (*jacobian*).\n"
778  "See further *ybatchCalc*.\n"),
779  OUTPUT("y", "y_aux", "jacobian"),
780  INPUT("ybatch_index")));
781 }
agenda_record.h
Declarations for AgRecord, storing lookup information for one agenda.
NAME
#define NAME(x)
Definition: agendas.cc:32
INPUT
#define INPUT(...)
Definition: agendas.cc:36
OUTPUT
#define OUTPUT(...)
Definition: agendas.cc:34
Array
This can be used to make arrays out of anything.
Definition: array.h:108
AgRecord
Lookup information for one agenda.
Definition: agenda_record.h:43
DESCRIPTION
#define DESCRIPTION(x)
Definition: agendas.cc:33
define_agenda_data
void define_agenda_data()
Definition: agendas.cc:44
global_data
Definition: agenda_record.cc:33
global_data::agenda_data
const Array< AgRecord > agenda_data
The lookup information for the agendas.
Definition: agendas.cc:41