arts-docs-2.4/doxygen/optproperties_8h_source.html

/* 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 "gridded_fields.h"

#include "interpolation_poly.h"

#include "matpackVII.h"

#include "messages.h"

#include "mystring.h"

#include "propagationmatrix.h"


//structure (a scattering element).

enum PType : Index {

  PTYPE_GENERAL = 300,

  PTYPE_AZIMUTH_RND = 200,

  PTYPE_TOTAL_RND = 100,

};


enum ParticleSSDMethod {

  PARTICLE_SSDMETHOD_NONE = 0,

  PARTICLE_SSDMETHOD_TMATRIX = 1,

};


/*===========================================================================

  === The SingleScatteringData structure

  ===========================================================================*/


struct SingleScatteringData {

  PType ptype;

  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;

typedef Array<Array<SingleScatteringData> > ArrayOfArrayOfSingleScatteringData;


ostream& operator<<(ostream& os, const SingleScatteringData& ssd);

ostream& operator<<(ostream& os, const ArrayOfSingleScatteringData& assd);


/*===========================================================================

  === The ScatteringMetaData structure

  ===========================================================================*/

struct ScatteringMetaData {

  String description;

  String source;

  String refr_index;

  Numeric mass;

  Numeric diameter_max;

  Numeric diameter_volume_equ;

  Numeric diameter_area_equ_aerodynamical;

};


typedef Array<ScatteringMetaData> ArrayOfScatteringMetaData;

typedef Array<Array<ScatteringMetaData> > ArrayOfArrayOfScatteringMetaData;


ostream& operator<<(ostream& os, const ScatteringMetaData& ssd);

ostream& operator<<(ostream& os, const ArrayOfScatteringMetaData& assd);


// General functions:

// =============================================================


void opt_prop_Bulk(  //Output

    Tensor5& ext_mat,

    Tensor4& abs_vec,

    Index& ptype,

    //Input

    const ArrayOfTensor5& ext_mat_ss,

    const ArrayOfTensor4& abs_vec_ss,

    const ArrayOfIndex& ptypes_ss);


void opt_prop_ScatSpecBulk(  //Output

    ArrayOfTensor5& ext_mat,

    ArrayOfTensor4& abs_vec,

    ArrayOfIndex& ptype,

    //Input

    const ArrayOfArrayOfTensor5& ext_mat_se,

    const ArrayOfArrayOfTensor4& abs_vec_se,

    const ArrayOfArrayOfIndex& ptypes_se,

    ConstMatrixView pnds,

    ConstMatrixView t_ok);


void opt_prop_NScatElems(  //Output

    ArrayOfArrayOfTensor5& ext_mat,

    ArrayOfArrayOfTensor4& abs_vec,

    ArrayOfArrayOfIndex& ptypes,

    Matrix& t_ok,

    //Input

    const ArrayOfArrayOfSingleScatteringData& scat_data,

    const Index& stokes_dim,

    const Vector& T_array,

    const Matrix& dir_array,

    const Index& f_index,

    const Index& t_interp_order = 1);


void opt_prop_1ScatElem(  //Output

    Tensor5View ext_mat,

    Tensor4View abs_vec,

    Index& ptype,

    VectorView t_ok,

    //Input

    const SingleScatteringData& ssd,

    const Vector& T_array,

    const Matrix& dir_array,

    const Index& f_index,

    const Index& t_interp_order = 1);


void ext_mat_SSD2Stokes(  //Output

    MatrixView ext_mat_stokes,

    //Input

    ConstVectorView ext_mat_ssd,

    const Index& stokes_dim,

    const Index& ptype);


void abs_vec_SSD2Stokes(  //Output

    VectorView abs_vec_stokes,

    //Input

    ConstVectorView abs_vec_ssd,

    const Index& stokes_dim,

    const Index& ptype);


void pha_mat_Bulk(  //Output

    Tensor6& pha_mat,

    Index& ptype,

    //Input

    const ArrayOfTensor6& pha_mat_ss,

    const ArrayOfIndex& ptypes_ss);


void pha_mat_ScatSpecBulk(  //Output

    ArrayOfTensor6& pha_mat,

    ArrayOfIndex& ptype,

    //Input

    const ArrayOfArrayOfTensor6& pha_mat_se,

    const ArrayOfArrayOfIndex& ptypes_se,

    ConstMatrixView pnds,

    ConstMatrixView t_ok);


void pha_mat_NScatElems(  //Output

    ArrayOfArrayOfTensor6& pha_mat,

    ArrayOfArrayOfIndex& ptypes,

    Matrix& t_ok,

    //Input

    const ArrayOfArrayOfSingleScatteringData& scat_data,

    const Index& stokes_dim,

    const Vector& T_array,

    const Matrix& pdir_array,

    const Matrix& idir_array,

    const Index& f_index,

    const Index& t_interp_order = 1);


void pha_mat_1ScatElem(  //Output

    Tensor6View pha_mat,

    Index& ptype,

    VectorView t_ok,

    //Input

    const SingleScatteringData& ssd,

    const Vector& T_array,

    const Matrix& pdir_array,

    const Matrix& idir_array,

    const Index& f_start,

    const Index& t_interp_order = 1);


void FouComp_1ScatElem(  //Output

    Tensor7View pha_mat_fou,

    Index& ptype,

    VectorView t_ok,

    //Input

    const SingleScatteringData& ssd,

    const Vector& T_array,

    const Vector& pdir_array,

    const Vector& idir_array,

    const Index& f_start,

    const Index& t_interp_order,

    const Index& naa_totran);


void abs_vecTransform(  //Output and Input

    StokesVector& abs_vec_lab,

    //Input

    ConstTensor3View abs_vec_data,

    ConstVectorView za_datagrid,

    ConstVectorView aa_datagrid,

    const PType& ptype,

    const Numeric& za_sca,

    const Numeric& aa_sca,

    const Verbosity& verbosity);


void ext_matTransform(  //Output and Input

    PropagationMatrix& ext_mat_lab,

    //Input

    ConstTensor3View ext_mat_data,

    ConstVectorView za_datagrid,

    ConstVectorView aa_datagrid,

    const PType& ptype,

    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 PType& ptype,

    const Index& za_sca_idx,

    const Index& aa_sca_idx,

    const Index& za_inc_idx,

    const Index& aa_inc_idx,

    ConstVectorView za_grid,

    ConstVectorView aa_grid,

    const Verbosity& verbosity);


void ext_matFromabs_vec(  //Output

    MatrixView ext_mat,

    //Input

    ConstVectorView abs_vec,

    const Index& stokes_dim);


void ssd_tinterp_parameters(  //Output

    VectorView t_ok,

    Index& this_T_interp_order,

    ArrayOfGridPosPoly& T_gp,

    Matrix& T_itw,

    //Input

    ConstVectorView T_grid,

    const Vector& T_array,

    const Index& t_interp_order);


// Functions for the case: Randomly oriented particles:

// ========================================================


Numeric scat_angle(const Numeric& za_sca,

                   const Numeric& aa_sca,

                   const Numeric& za_inc,

                   const Numeric& aa_inc);


void interpolate_scat_angle(  //Output:

    VectorView pha_mat_int,

    //Input:

    ConstTensor5View pha_mat_data,

    ConstVectorView za_datagrid,

    const Numeric theta);


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:

    PropagationMatrix& ext_mat,

    StokesVector& abs_vec,

    //Input:

    const ArrayOfPropagationMatrix& propmat_clearsky);


PType PTypeFromString(const String& ptype_string);

PType PType2FromString(const String& ptype_string);


String PTypeToString(const PType& ptype);


void ConvertAzimuthallyRandomSingleScatteringData(SingleScatteringData& ssd);


ParticleSSDMethod ParticleSSDMethodFromString(

    const String& particle_ssdmethod_string);


String ParticleSSDMethodToString(

    const ParticleSSDMethod& particle_ssdmethod_type);


#endif  //optproperties_h