optproperties.h

Go to the documentation of this file.

/* Copyright (C) 2003-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. */
 
 
 
/*===========================================================================
  ===  File description 
  ===========================================================================*/
 
#ifndef optproperties_h
#define optproperties_h
 
#include "matpackVII.h"
#include "mystring.h"
#include "messages.h"
#include "gridded_fields.h"
 
 
 
enum ParticleType {
  PARTICLE_TYPE_GENERAL = 10,
  PARTICLE_TYPE_MACROS_ISO = 20,
  PARTICLE_TYPE_HORIZ_AL = 30,
  PARTICLE_TYPE_SPHERICAL = 40
};
 
 
 
enum ParticleSSDMethod {
  PARTICLE_SSDMETHOD_NONE = 0,
  PARTICLE_SSDMETHOD_TMATRIX = 1,
};
 
 
 
/*===========================================================================
  === The SingleScatteringData structure
  ===========================================================================*/
 
 
struct SingleScatteringData {
  ParticleType particle_type;
  String       description;
  Vector       f_grid;
  Vector       T_grid;
  Vector       za_grid;
  Vector       aa_grid;
  Tensor7      pha_mat_data;
  Tensor5      ext_mat_data;
  Tensor5      abs_vec_data;
};
 
typedef Array<SingleScatteringData> ArrayOfSingleScatteringData;
 
ostream& operator<< (ostream& os, const SingleScatteringData& ssd);
ostream& operator<< (ostream& os, const ArrayOfSingleScatteringData& assd);
 
 
/*===========================================================================
  === The ScatteringMetaData structure
  ===========================================================================*/
struct ScatteringMetaData {
  String    description;
  String    material;
  String    shape;
  ParticleType particle_type;
  ParticleSSDMethod ssd_method;
  Numeric   density;
  Numeric   diameter_max;
  Numeric   volume;
  Numeric   area_projected;
  Numeric   aspect_ratio;
  Vector    scat_f_grid;
  Vector    scat_T_grid;
  GriddedField3  complex_refr_index;
};
 
typedef Array<ScatteringMetaData> ArrayOfScatteringMetaData;
 
ostream& operator<< (ostream& os, const ScatteringMetaData& ssd);
ostream& operator<< (ostream& os, const ArrayOfScatteringMetaData& assd);
 
 
 
// General functions:
// =============================================================
 
void abs_vecTransform(//Output and Input
                      VectorView abs_vec_lab,
                      //Input
                      ConstTensor3View abs_vec_data,
                      ConstVectorView za_datagrid,
                      ConstVectorView aa_datagrid,
                      const ParticleType& particle_type,
                      const Numeric& za_sca,
                      const Numeric& aa_sca,
                      const Verbosity& verbosity);
 
 
void ext_matTransform(//Output and Input
                      MatrixView ext_mat_lab,
                      //Input
                      ConstTensor3View ext_mat_data,
                      ConstVectorView za_datagrid,
                      ConstVectorView aa_datagrid,
                      const ParticleType& particle_type,
                      const Numeric& za_sca,
                      const Numeric& aa_sca,
                      const Verbosity& verbosity);
 
 
void pha_matTransform(//Output
                      MatrixView pha_mat_lab,
                      //Input
                      ConstTensor5View pha_mat_data,
                      ConstVectorView za_datagrid,
                      ConstVectorView aa_datagrid,
                      const ParticleType& particle_type,
                      const Index& za_sca_idx,
                      const Index& aa_sca_idx,
                      const Index& za_inc_idx,
                      const Index& aa_inc_idx,
                      ConstVectorView scat_za_grid,
                      ConstVectorView scat_aa_grid,
                      const Verbosity& verbosity);
 
 
void ext_matFromabs_vec(//Output:
                        MatrixView ext_mat,
                        //Input:
                        ConstVectorView abs_vec,
                        const Index& stokes_dim);
 
// Functions for the case: Randomly oriented particles: 
// ========================================================
 
void interpolate_scat_angle(//Output:
                            VectorView pha_mat_int,
                            Numeric& theta_rad,
                            //Input:
                            ConstTensor5View pha_mat_data,
                            ConstVectorView za_datagrid,
                            const Numeric& za_sca,
                            const Numeric& aa_sca,
                            const Numeric& za_inc,
                            const Numeric& aa_inc);
 
 
void pha_mat_labCalc(//Output:
                      MatrixView pha_mat_lab,
                      //Input:
                      ConstVectorView pha_mat_int,
                      const Numeric& za_sca,
                      const Numeric& aa_sca,
                      const Numeric& za_inc,
                      const Numeric& aa_inc,
                      const Numeric& theta_rad);
 
 
// Get ext_mat and abs_vec from propmat_clearsky:
// ========================================================
 
void opt_prop_sum_propmat_clearsky(//Output:
                                      Tensor3&         ext_mat,
                                      Matrix&          abs_vec,
                                      //Input:
                                      const Tensor4    propmat_clearsky);
 
ParticleType ParticleTypeFromString(const String& particle_type_string);
 
String ParticleTypeToString(const ParticleType& particle_type);
 
ParticleSSDMethod ParticleSSDMethodFromString(const String& particle_ssdmethod_string);
 
String ParticleSSDMethodToString(const ParticleSSDMethod& particle_ssdmethod_type);
 
#endif //optproperties_h