ARTS  2.0.49
nc_io_types.h
Go to the documentation of this file.
1 /* Copyright (C) 2003-2008 Oliver Lemke <olemke@core-dump.info>
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 
18 
20 // File description
22 
32 #include "arts.h"
33 
34 #ifdef ENABLE_NETCDF
35 
36 #ifndef nc_io_types_h
37 #define nc_io_types_h
38 
39 #include <stdexcept>
40 #include <cfloat>
41 #include "nc_io.h"
42 #include "absorption.h"
43 #include "agenda_class.h"
44 #include "array.h"
45 #include "bifstream.h"
46 #include "bofstream.h"
47 #include "gas_abs_lookup.h"
48 #include "gridded_fields.h"
49 #include "jacobian.h"
50 #include "m_general.h"
51 #include "mc_antenna.h"
52 #include "mc_interp.h"
53 #include "matpackII.h"
54 #include "matpackVII.h"
55 #include "messages.h"
56 #include "optproperties.h"
57 #include "ppath.h"
58 
59 
60 #define TMPL_NC_READ_WRITE_FILE(what) \
61  void nc_write_to_file (const int, const what&); \
62  void nc_read_from_file (const int, what&);
63 
64 
66 // Overloaded reading/writing routines for NetCDF streams
68 
69 //=== Basic Types ==========================================================
70 
71 TMPL_NC_READ_WRITE_FILE( Index )
72 TMPL_NC_READ_WRITE_FILE( Matrix )
73 TMPL_NC_READ_WRITE_FILE( Numeric )
74 TMPL_NC_READ_WRITE_FILE( Sparse )
75 TMPL_NC_READ_WRITE_FILE( String )
76 TMPL_NC_READ_WRITE_FILE( Tensor3 )
77 TMPL_NC_READ_WRITE_FILE( Tensor4 )
78 TMPL_NC_READ_WRITE_FILE( Tensor5 )
79 TMPL_NC_READ_WRITE_FILE( Tensor6 )
80 TMPL_NC_READ_WRITE_FILE( Tensor7 )
81 TMPL_NC_READ_WRITE_FILE( Timer )
82 TMPL_NC_READ_WRITE_FILE( Vector )
83 
84 //=== Compound Types =======================================================
85 
86 TMPL_NC_READ_WRITE_FILE( Agenda )
87 TMPL_NC_READ_WRITE_FILE( GriddedField1 )
88 TMPL_NC_READ_WRITE_FILE( GriddedField2 )
89 TMPL_NC_READ_WRITE_FILE( GriddedField3 )
90 TMPL_NC_READ_WRITE_FILE( GriddedField4 )
91 TMPL_NC_READ_WRITE_FILE( GasAbsLookup )
92 TMPL_NC_READ_WRITE_FILE( GridPos )
93 TMPL_NC_READ_WRITE_FILE( IsotopeRecord )
94 TMPL_NC_READ_WRITE_FILE( MCAntenna )
95 TMPL_NC_READ_WRITE_FILE( Ppath )
96 TMPL_NC_READ_WRITE_FILE( RetrievalQuantity )
97 TMPL_NC_READ_WRITE_FILE( SLIData2 )
98 TMPL_NC_READ_WRITE_FILE( SingleScatteringData )
99 TMPL_NC_READ_WRITE_FILE( SpeciesRecord )
100 TMPL_NC_READ_WRITE_FILE( SpeciesTag )
101 
102 //=== Array Types ==========================================================
103 
104 TMPL_NC_READ_WRITE_FILE( Array<IsotopeRecord> )
105 TMPL_NC_READ_WRITE_FILE( Array<SpeciesRecord> )
106 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfArrayOfArrayOfGridPos )
107 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfGriddedField1 )
108 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfGriddedField3 )
109 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfGridPos )
110 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfArrayOfGridPos )
111 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfIndex )
112 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfLineRecord )
113 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfMatrix )
114 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfSpeciesTag )
115 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfTensor3 )
116 TMPL_NC_READ_WRITE_FILE( ArrayOfArrayOfTensor6 )
117 TMPL_NC_READ_WRITE_FILE( ArrayOfGriddedField1 )
118 TMPL_NC_READ_WRITE_FILE( ArrayOfGriddedField2 )
119 TMPL_NC_READ_WRITE_FILE( ArrayOfGriddedField3 )
120 TMPL_NC_READ_WRITE_FILE( ArrayOfGriddedField4 )
121 TMPL_NC_READ_WRITE_FILE( ArrayOfGridPos )
122 TMPL_NC_READ_WRITE_FILE( ArrayOfIndex )
123 TMPL_NC_READ_WRITE_FILE( ArrayOfLineRecord )
124 TMPL_NC_READ_WRITE_FILE( ArrayOfLineshapeSpec )
125 TMPL_NC_READ_WRITE_FILE( ArrayOfMatrix )
126 TMPL_NC_READ_WRITE_FILE( ArrayOfPpath )
127 TMPL_NC_READ_WRITE_FILE( ArrayOfRetrievalQuantity )
128 TMPL_NC_READ_WRITE_FILE( ArrayOfSingleScatteringData )
129 TMPL_NC_READ_WRITE_FILE( ArrayOfSpeciesTag )
130 TMPL_NC_READ_WRITE_FILE( ArrayOfString )
131 TMPL_NC_READ_WRITE_FILE( ArrayOfTensor3 )
132 TMPL_NC_READ_WRITE_FILE( ArrayOfTensor4 )
133 TMPL_NC_READ_WRITE_FILE( ArrayOfTensor6 )
134 TMPL_NC_READ_WRITE_FILE( ArrayOfTensor7 )
135 TMPL_NC_READ_WRITE_FILE( ArrayOfVector )
136 
137 //==========================================================================
138 
139 // Undefine the macro to avoid it being used anywhere else
140 #undef TMPL_NC_READ_WRITE_FILE
141 
142 /*void
143 xml_parse_from_stream (istream&, Vector&, bifstream *, ArtsXMLTag&, const Verbosity&);
144 
145 void
146 xml_read_from_stream (istream&, ArrayOfLineRecord&,
147  const Numeric, const Numeric, bifstream * = NULL, const Verbosity&);
148 
149 void
150 xml_parse_from_stream (istream&, ArrayOfString&, bifstream *, ArtsXMLTag&, const Verbosity&);*/
151 
152 #endif /* nc_io_types_h */
153 
154 #endif /* ENABLE_NETCDF */
155 
GriddedField2
Definition: gridded_fields.h:230
Matrix
The Matrix class.
Definition: matpackI.h:767
Timer
Definition: m_general.h:54
gridded_fields.h
Implementation of gridded fields.
absorption.h
Declarations required for the calculation of absorption coefficients.
Tensor3
The Tensor3 class.
Definition: matpackIII.h:340
mc_interp.h
Interpolation classes and functions created for use within Monte Carlo scattering simulations.
nc_io.h
This file contains basic functions to handle NetCDF data files.
Sparse
The Sparse class.
Definition: matpackII.h:55
MCAntenna
An Antenna object used by MCGeneral.
Definition: mc_antenna.h:56
Tensor4
The Tensor4 class.
Definition: matpackIV.h:375
array.h
This file contains the definition of Array.
Ppath
The structure to describe a propagation path and releated quantities.
Definition: ppath.h:59
Agenda
The Agenda class.
Definition: agenda_class.h:44
GriddedField3
Definition: gridded_fields.h:274
SingleScatteringData
Structure which describes the single scattering properties of a.
Definition: optproperties.h:74
GasAbsLookup
An absorption lookup table.
Definition: gas_abs_lookup.h:44
Array< IsotopeRecord >
SpeciesTag
A tag group can consist of the sum of several of these.
Definition: abs_species_tags.h:45
agenda_class.h
Declarations for agendas.
messages.h
Declarations having to do with the four output streams.
my_basic_string
The implementation for String, the ARTS string class.
Definition: mystring.h:62
IsotopeRecord
Contains the lookup data for one isotope.
Definition: absorption.h:181
optproperties.h
Scattering database structure and functions.
jacobian.h
Declarations required for the calculation of jacobians.
Numeric
NUMERIC Numeric
The type to use for all floating point numbers.
Definition: matpack.h:33
GriddedField4
Definition: gridded_fields.h:328
mc_antenna.h
Workspace functions for the solution of cloud-box radiative transfer by Monte Carlo methods....
bifstream.h
This file contains the class declaration of bifstream.
bofstream.h
This file contains the class declaration of bofstream.
SpeciesRecord
Contains the lookup data for one species.
Definition: absorption.h:307
TMPL_NC_READ_WRITE_FILE
#define TMPL_NC_READ_WRITE_FILE(what)
Definition: nc_io_instantiation.h:40
Tensor5
The Tensor5 class.
Definition: matpackV.h:443
GridPos
Structure to store a grid position.
Definition: interpolation.h:74
ppath.h
Propagation path structure and functions.
SLIData2
A 2D sequential linear interpolation (SLI) lookup table.
Definition: mc_interp.h:58
GriddedField1
Definition: gridded_fields.h:189
matpackII.h
Header file for sparse matrices.
Index
INDEX Index
The type to use for all integer numbers and indices.
Definition: matpack.h:39
RetrievalQuantity
Contains the data for one retrieval quantity.
Definition: jacobian.h:45
Tensor6
The Tensor6 class.
Definition: matpackVI.h:937
Vector
The Vector class.
Definition: matpackI.h:555
gas_abs_lookup.h
Declarations for the gas absorption lookup table.
Tensor7
The Tensor7 class.
Definition: matpackVII.h:1912
matpackVII.h
arts.h
The global header file for ARTS.
m_general.h
Template functions for general supergeneric ws methods.