ARTS 2.5.11 (git: 6827797f)
cloudbox.h
Go to the documentation of this file.
1
10#ifndef cloudbox_h
11#define cloudbox_h
12
13#include "array.h"
14#include "gridded_fields.h"
15#include "interpolation.h"
16#include "matpack_data.h"
17#include "messages.h"
18#include "optproperties.h"
19#include "ppath.h"
20
21namespace Cloudbox {
26 inline constexpr Numeric LAT_LON_MIN = 20;
27} // namespace Cloudbox
28
29void chk_pnd_data(const GriddedField3& pnd_field_raw,
30 const String& pnd_field_file,
31 const Index& atmosphere_dim,
32 const Verbosity& verbosity);
33
34void chk_pnd_raw_data(const ArrayOfGriddedField3& pnd_field_raw,
35 const String& pnd_field_file,
36 const Index& atmosphere_dim,
37 const Verbosity& verbosity);
38
40 const Index& dim,
41 const ArrayOfGriddedField3& pnd_field_raw,
42 ConstVectorView p_grid,
43 ConstVectorView lat_grid,
44 ConstVectorView lon_grid,
45 const ArrayOfIndex& cloudbox_limits);
46
47void chk_scat_species(const ArrayOfString& scat_species, const String& delim);
48
50 const ArrayOfScatteringMetaData& scat_meta,
51 const Verbosity& verbosity);
52
53void chk_scattering_meta_data(const ScatteringMetaData& scat_meta_single,
54 const String& scat_meta_file,
55 const Verbosity& verbosity);
56
57void chk_scat_data(const SingleScatteringData& scat_data,
58 const Verbosity& verbosity);
59
60bool is_gp_inside_cloudbox(const GridPos& gp_p,
61 const GridPos& gp_lat,
62 const GridPos& gp_lon,
63 const ArrayOfIndex& cloudbox_limits,
64 const bool& include_boundaries,
65 const Index& atmosphere_dim = 3);
66
67bool is_inside_cloudbox(const Ppath& ppath_step,
68 const ArrayOfIndex& cloudbox_limits,
69 const bool include_boundaries);
70
71void bin_quadweights(Vector& w, const Vector& x, const Index& order = 1);
72
73void chk_scat_species_field(bool& empty_flag,
74 const Tensor3& scat_species_field,
75 const String& fieldname,
76 const Index& dim,
77 const Vector& p_grid,
78 const Vector& lat_grid,
79 const Vector& lon_grid);
80
81void find_cloudlimits(Index& lower,
82 Index& upper,
83 const Tensor3& scat_species_field,
84 const Index& atmosphere_dim,
85 const Numeric& cloudbox_margin);
86
87void parse_atmcompact_speciestype(String& species_type,
88 const String& field_name,
89 const String& delim);
90
91void parse_atmcompact_speciesname(String& species_name,
92 const String& field_name,
93 const String& delim);
94
95void parse_atmcompact_scattype(String& scat_type,
96 const String& field_name,
97 const String& delim);
98
99void parse_partfield_name(String& partfield_name,
100 const String& part_string,
101 const String& delim);
102
103#endif //cloudbox_h
This file contains the definition of Array.
This can be used to make arrays out of anything.
Definition: array.h:31
void parse_atmcompact_speciesname(String &species_name, const String &field_name, const String &delim)
Definition: cloudbox.cc:812
void chk_scat_species(const ArrayOfString &scat_species, const String &delim)
Check validity of scat_species setting.
Definition: cloudbox.cc:198
void chk_scat_species_field(bool &empty_flag, const Tensor3 &scat_species_field, const String &fieldname, const Index &dim, const Vector &p_grid, const Vector &lat_grid, const Vector &lon_grid)
Check whether field of a specific scattering species zero everywhere.
Definition: cloudbox.cc:590
bool is_gp_inside_cloudbox(const GridPos &gp_p, const GridPos &gp_lat, const GridPos &gp_lon, const ArrayOfIndex &cloudbox_limits, const bool &include_boundaries, const Index &atmosphere_dim=3)
Definition: cloudbox.cc:443
void chk_scattering_meta_data(const ScatteringMetaData &scat_meta_single, const String &scat_meta_file, const Verbosity &verbosity)
Check scattering data meta.
Definition: cloudbox.cc:243
void find_cloudlimits(Index &lower, Index &upper, const Tensor3 &scat_species_field, const Index &atmosphere_dim, const Numeric &cloudbox_margin)
Adjust uppermost and lowermost cloudy level for one scat_species_*_*_field.
Definition: cloudbox.cc:649
void bin_quadweights(Vector &w, const Vector &x, const Index &order=1)
Definition: cloudbox.cc:555
void chk_pnd_field_raw_only_in_cloudbox(const Index &dim, const ArrayOfGriddedField3 &pnd_field_raw, ConstVectorView p_grid, ConstVectorView lat_grid, ConstVectorView lon_grid, const ArrayOfIndex &cloudbox_limits)
chk_pnd_field_raw_only_in_cloudbox
Definition: cloudbox.cc:123
void parse_partfield_name(String &partfield_name, const String &part_string, const String &delim)
Definition: cloudbox.cc:874
void chk_pnd_raw_data(const ArrayOfGriddedField3 &pnd_field_raw, const String &pnd_field_file, const Index &atmosphere_dim, const Verbosity &verbosity)
Check particle number density files (pnd_field_raw)
Definition: cloudbox.cc:93
void parse_atmcompact_speciestype(String &species_type, const String &field_name, const String &delim)
Definition: cloudbox.cc:781
bool is_inside_cloudbox(const Ppath &ppath_step, const ArrayOfIndex &cloudbox_limits, const bool include_boundaries)
Definition: cloudbox.cc:523
void parse_atmcompact_scattype(String &scat_type, const String &field_name, const String &delim)
Definition: cloudbox.cc:843
void chk_scattering_data(const ArrayOfSingleScatteringData &scat_data, const ArrayOfScatteringMetaData &scat_meta, const Verbosity &verbosity)
Check scattering data general.
Definition: cloudbox.cc:224
void chk_pnd_data(const GriddedField3 &pnd_field_raw, const String &pnd_field_file, const Index &atmosphere_dim, const Verbosity &verbosity)
Check particle number density files.
Definition: cloudbox.cc:50
void chk_scat_data(const SingleScatteringData &scat_data, const Verbosity &verbosity)
Check single scattering data.
Definition: cloudbox.cc:275
Implementation of gridded fields.
Header file for interpolation.cc.
Declarations having to do with the four output streams.
constexpr Numeric LAT_LON_MIN
Global constant, minimum distance of cloudbox to lat/lon_grid edges.
Definition: cloudbox.h:26
Scattering database structure and functions.
Propagation path structure and functions.
Structure to store a grid position.
Definition: interpolation.h:56
The structure to describe a propagation path and releated quantities.
Definition: ppath_struct.h:17
#define w