arts-docs-2.2/doxygen/cloudbox_8h_source.html

/* Copyright (C) 2002-2012 Claudia Emde <claudia.emde@dlr.de>


   This program is free software; you can redistribute it and/or modify it

   under the terms of the GNU General Public License as published by the

   Free Software Foundation; either version 2, or (at your option) any

   later version.


   This program is distributed in the hope that it will be useful,

   but WITHOUT ANY WARRANTY; without even the implied warranty of

   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

   GNU General Public License for more details.


   You should have received a copy of the GNU General Public License

   along with this program; if not, write to the Free Software

   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,

   USA.

*/


#ifndef cloudbox_h

#define cloudbox_h


#include "matpackVII.h"

#include "interpolation.h"

#include "optproperties.h"

#include "array.h"

#include "gridded_fields.h"

#include "ppath.h"

#include "messages.h"


void chk_if_pnd_zero_p (const Index& i_p,

                        const GriddedField3& pnd_field_raw,

                        const String& pnd_field_file,

                        const Verbosity& verbosity);


void chk_if_pnd_zero_lat (const Index& i_lat,

                          const GriddedField3& pnd_field_raw,

                          const String& pnd_field_file,

                          const Verbosity& verbosity);


void chk_if_pnd_zero_lon (const Index& i_lon,

                          const GriddedField3& pnd_field_raw,

                          const String& pnd_field_file,

                          const Verbosity& verbosity);


void chk_pnd_data (const GriddedField3& pnd_field_raw,

                   const String& pnd_field_file,

                   const Index& atmosphere_dim,

                   const Verbosity& verbosity);


void chk_pnd_raw_data (const ArrayOfGriddedField3& pnd_field_raw,

                       const String& pnd_field_file,

                       const Index& atmosphere_dim,

                       const Verbosity& verbosity);


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);


void chk_part_species (const ArrayOfString& part_species,

                       const String& delim);


void chk_scattering_data (const ArrayOfSingleScatteringData& scat_data_array,

                          const ArrayOfScatteringMetaData& scat_meta_array,

                          const Verbosity& verbosity);


void chk_scattering_meta_data (const ScatteringMetaData& scat_meta,

                               const String& scat_meta_file,

                               const Verbosity& verbosity);


void chk_scat_data (const SingleScatteringData& scat_data_array,

                                 const String& scat_data_file,

                                 ConstVectorView f_grid,

                                 const Verbosity& verbosity);


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 );


bool is_inside_cloudbox (const Ppath& ppath_step,

                         const ArrayOfIndex& cloudbox_limits,

                         const bool include_boundaries);


void pnd_fieldMH97 (Tensor4View pnd_field,

                    const Tensor3& IWC_field,

                    const Tensor3& t_field,

                    const ArrayOfIndex& limits,

                    const ArrayOfScatteringMetaData& scat_meta_array,

                    const Index& scat_data_start,

                    const Index& npart,

                    const String& part_string,

                    const String& delim,

                    const Verbosity& verbosity);


void pnd_fieldH11 (Tensor4View pnd_field,

                   const Tensor3& IWC_field,

                   const Tensor3& t_field,

                   const ArrayOfIndex& limits,

                   const ArrayOfScatteringMetaData& scat_meta_array,

                   const Index& scat_data_start,

                   const Index& npart,

                   const String& part_string,

                   const String& delim,

                   const Verbosity& verbosity);


void pnd_fieldH13 (Tensor4View pnd_field,

                   const Tensor3& IWC_field,

                   const Tensor3& t_field,

                   const ArrayOfIndex& limits,

                   const ArrayOfScatteringMetaData& scat_meta_array,

                   const Index& scat_data_start,

                   const Index& npart,

                   const String& part_string,

                   const String& delim,

                   const Verbosity& verbosity);


void pnd_fieldH13Shape (Tensor4View pnd_field,

                   const Tensor3& IWC_field,

                   const Tensor3& t_field,

                   const ArrayOfIndex& limits,

                   const ArrayOfScatteringMetaData& scat_meta_array,

                   const Index& scat_data_start,

                   const Index& npart,

                   const String& part_string,

                   const String& delim,

                   const Verbosity& verbosity);


void pnd_fieldF07TR (Tensor4View pnd_field,

                     const Tensor3& SWC_field,

                     const Tensor3& t_field,

                     const ArrayOfIndex& limits,

                     const ArrayOfScatteringMetaData& scat_meta_array,

                     const Index& scat_data_start,

                     const Index& npart,

                     const String& part_string,

                     const String& delim,

                     const Verbosity& verbosity);


void pnd_fieldF07ML (Tensor4View pnd_field,

                     const Tensor3& SWC_field,

                     const Tensor3& t_field,

                     const ArrayOfIndex& limits,

                     const ArrayOfScatteringMetaData& scat_meta_array,

                     const Index& scat_data_start,

                     const Index& npart,

                     const String& part_string,

                     const String& delim,

                     const Verbosity& verbosity);


void pnd_fieldMGD_LWC (Tensor4View pnd_field,

                       const Tensor3& LWC_field,

                       const ArrayOfIndex& limits,

                       const ArrayOfScatteringMetaData& scat_meta_array,

                       const Index& scat_data_start,

                       const Index& npart,

                       const String& part_string,

                       const String& delim,

                       const Verbosity& verbosity);


void pnd_fieldMGD_IWC (Tensor4View pnd_field,

                       const Tensor3& IWC_field,

                       const ArrayOfIndex& limits,

                       const ArrayOfScatteringMetaData& scat_meta_array,

                       const Index& scat_data_start,

                       const Index& npart,

                       const String& part_string,

                       const String& delim,

                       const Verbosity& verbosity);


void pnd_fieldGM58 (Tensor4View pnd_field,

                    const Tensor3& PR_field,

                    const ArrayOfIndex& limits,

                    const ArrayOfScatteringMetaData& scat_meta_array,

                    const Index& scat_data_start,

                    const Index& npart,

                    const String& part_string,

                    const String& delim,

                    const Verbosity& verbosity);


void pnd_fieldSS70 (Tensor4View pnd_field,

                    const Tensor3& PR_field,

                    const ArrayOfIndex& limits,

                    const ArrayOfScatteringMetaData& scat_meta_array,

                    const Index& scat_data_start,

                    const Index& npart,

                    const String& part_string,

                    const String& delim,

                    const Verbosity& verbosity);


void pnd_fieldMP48 (Tensor4View pnd_field,

                    const Tensor3& PR_field,

                    const ArrayOfIndex& limits,

                    const ArrayOfScatteringMetaData& scat_meta_array,

                    const Index& scat_data_start,

                    const Index& npart,

                    const String& part_string,

                    const String& delim,

                    const Verbosity& verbosity);


void pnd_fieldH98 (Tensor4View pnd_field,

                   const Tensor3& LWC_field,

                   const ArrayOfIndex& limits,

                   const ArrayOfScatteringMetaData& scat_meta_array,

                   const Index& scat_data_start,

                   const Index& npart,

                   const String& part_string,

                   const String& delim,

                   const Verbosity& verbosity);


Numeric IWCtopnd_MH97 (const Numeric iwc,

                       Numeric dm,

                       const Numeric t,

                       const Numeric density,

                       const bool noisy);


Numeric IWCtopnd_H11 ( const Numeric d,

                       const Numeric t);


Numeric IWCtopnd_H13 ( const Numeric d,

                       const Numeric t);


Numeric IWCtopnd_H13Shape ( const Numeric d,

                       const Numeric t);


Numeric area_ratioH13 ( const Numeric d,

                            const Numeric t);


Numeric IWCtopnd_F07TR ( const Numeric d, const Numeric t,

                        const Numeric swc,const Numeric alpha,

                        const Numeric beta );


Numeric IWCtopnd_F07ML ( const Numeric d, const Numeric t,

                        const Numeric swc,const Numeric alpha,

                        const Numeric beta );


Numeric LWCtopnd (const Numeric lwc,

                  const Numeric density,

                  const Numeric r);


// ONLY FOR TESTING PURPOSES

Numeric LWCtopnd2 (//const Numeric density,

                   const Numeric r);


Numeric LWCtopnd_MGD_LWC ( const Numeric d, const Numeric rho,

                          const Numeric lwc);


Numeric IWCtopnd_MGD_IWC ( const Numeric d, const Numeric rho,

                          const Numeric iwc);


Numeric PRtopnd_MP48 (  const Numeric R,

                        const Numeric D);


void scale_pnd (Vector& w,

                const Vector& x,

                const Vector& y);


void chk_pndsum (Vector& pnd,

                 const Numeric xwc,

                 const Vector& vol,

                 const Vector& density,

                 const Index& p,

                 const Index& lat,

                 const Index& lon,

                 const String& part_type,

                 const Verbosity& verbosity);


void scale_H11 (Vector& pnd,

                const Numeric xwc,

                const Vector& density,

                const Vector& vol);


void scale_H13 (Vector& pnd,

                const Numeric xwc,

                const Vector& density,

                const Vector& vol);


void chk_massdensity_field(bool& x,

                           const Index&  dim,

                           const Tensor3& massdensity,

                           const Vector& p_grid,

                           const Vector& lat_grid,

                           const Vector& lon_grid);


void parse_partfield_name (String& partfield_name,

                      const String& part_string,

                      const String& delim);


void parse_psd_param (String& psd_param,

                      const String& part_string,

                      const String& delim);


void parse_part_material (String& part_material,

                      const String& part_string,

                      const String& delim);


void parse_part_size (Numeric& sizemin,

                      Numeric& sizemax,

                      const String& part_string,

                      const String& delim);


#endif //cloudbox_h