arts-docs-2.4/doxygen/doit_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 doit_h

#define doit_h


#include "agenda_class.h"

#include "matpackVI.h"

#include "ppath.h"

#include "propagationmatrix.h"


void rte_step_doit_replacement(

    //FIXME function name of 'rte_step_doit_replacement' should be replaced by

    // proper name

    //Output and Input:

    VectorView stokes_vec,

    MatrixView trans_mat,

    //Input

    const PropagationMatrix& ext_mat_av,

    const StokesVector& abs_vec_av,

    ConstVectorView sca_vec_av,

    const Numeric& lstep,

    const Numeric& rtp_planck_value,

    const bool& trans_is_precalc = false);


//  propagation direction.

void cloud_fieldsCalc(Workspace& ws,

                      // Output:

                      Tensor5View ext_mat_field,

                      Tensor4View abs_vec_field,

                      // Input:

                      const Agenda& spt_calc_agenda,

                      const Index& za_index,

                      const Index& aa_index,

                      const ArrayOfIndex& cloudbox_limits,

                      ConstTensor3View t_field,

                      ConstTensor4View pnd_field,

                      const Verbosity& verbosity);


void cloud_ppath_update1D(Workspace& ws,

                          Tensor6View i_field,

                          // ppath_step_agenda:

                          const Index& p_index,

                          const Index& za_index,

                          ConstVectorView za_grid,

                          const ArrayOfIndex& cloudbox_limits,

                          ConstTensor6View scat_field,

                          // Calculate scalar gas absorption:

                          const Agenda& propmat_clearsky_agenda,

                          ConstTensor4View vmr_field,

                          // Gas absorption:

                          // Propagation path calculation:

                          const Agenda& ppath_step_agenda,

                          const Numeric& ppath_lmax,

                          const Numeric& ppath_lraytrace,

                          ConstVectorView p_grid,

                          ConstTensor3View z_field,

                          ConstVectorView refellipsoid,

                          // Calculate thermal emission:

                          ConstTensor3View t_field,

                          ConstVectorView f_grid,

                          const Index& f_index,

                          //particle opticla properties

                          ConstTensor5View ext_mat_field,

                          ConstTensor4View abs_vec_field,

                          const Agenda& surface_rtprop_agenda,

                          const Index& scat_za_interp,

                          const Verbosity& verbosity);


void cloud_ppath_update1D_noseq(Workspace& ws,

                                // Input and output

                                Tensor6View cloudbox_field_mono,

                                // ppath_step_agenda:

                                const Index& p_index,

                                const Index& za_index,

                                ConstVectorView za_grid,

                                const ArrayOfIndex& cloudbox_limits,

                                ConstTensor6View cloudbox_field_mono_old,

                                ConstTensor6View doit_scat_field,

                                // Calculate scalar gas absorption:

                                const Agenda& propmat_clearsky_agenda,

                                ConstTensor4View vmr_field,

                                // Gas absorption:

                                // Propagation path calculation:

                                const Agenda& ppath_step_agenda,

                                const Numeric& ppath_lmax,

                                const Numeric& ppath_lraytrace,

                                ConstVectorView p_grid,

                                ConstTensor3View z_field,

                                ConstVectorView refellipsoid,

                                // Calculate thermal emission:

                                ConstTensor3View t_field,

                                ConstVectorView f_grid,

                                // used for surface ?

                                const Index& f_index,

                                //particle optical properties

                                ConstTensor5View ext_mat_field,

                                ConstTensor4View abs_vec_field,

                                const Agenda& surface_rtprop_agenda,

                                const Index& scat_za_interp,

                                const Verbosity& verbosity);


void cloud_ppath_update1D_planeparallel(Workspace& ws,

                                        Tensor6View cloudbox_field_mono,

                                        // ppath_step_agenda:

                                        const Index& p_index,

                                        const Index& za_index,

                                        ConstVectorView za_grid,

                                        const ArrayOfIndex& cloudbox_limits,

                                        ConstTensor6View scat_field,

                                        // Calculate scalar gas absorption:

                                        const Agenda& propmat_clearsky_agenda,

                                        ConstTensor4View vmr_field,

                                        // Gas absorption:

                                        // Propagation path calculation:

                                        ConstVectorView p_grid,

                                        ConstTensor3View z_field,

                                        // Calculate thermal emission:

                                        ConstTensor3View t_field,

                                        ConstVectorView f_grid,

                                        const Index& f_index,

                                        //particle opticla properties

                                        ConstTensor5View ext_mat_field,

                                        ConstTensor4View abs_vec_field,

                                        // const Agenda& surface_agenda,

                                        const Verbosity& verbosity);


void cloud_ppath_update3D(Workspace& ws,

                          Tensor6View cloudbox_field_mono,

                          // ppath_step_agenda:

                          const Index& p_index,

                          const Index& lat_index,

                          const Index& lon_index,

                          const Index& za_index,

                          const Index& aa_index,

                          ConstVectorView za_grid,

                          ConstVectorView aa_grid,

                          const ArrayOfIndex& cloudbox_limits,

                          ConstTensor6View doit_scat_field,

                          // Calculate scalar gas absorption:

                          const Agenda& propmat_clearsky_agenda,

                          ConstTensor4View vmr_field,

                          // Gas absorption:

                          // Propagation path calculation:

                          const Agenda& ppath_step_agenda,

                          const Numeric& ppath_lmax,

                          const Numeric& ppath_lraytrace,

                          ConstVectorView p_grid,

                          ConstVectorView lat_grid,

                          ConstVectorView lon_grid,

                          ConstTensor3View z_field,

                          ConstVectorView refellipsoid,

                          // Calculate thermal emission:

                          ConstTensor3View t_field,

                          ConstVectorView f_grid,

                          const Index& f_index,

                          //particle optical properties

                          ConstTensor5View ext_mat_field,

                          ConstTensor4View abs_vec_field,

                          const Index&,  //scat_za_interp

                          const Verbosity& verbosity);


void cloud_RT_no_background(Workspace& ws,

                            //Output

                            Tensor6View cloudbox_field_mono,

                            // Input

                            const Agenda& propmat_clearsky_agenda,

                            const Ppath& ppath_step,

                            ConstVectorView t_int,

                            ConstMatrixView vmr_list_int,

                            ConstTensor3View ext_mat_int,

                            ConstMatrixView abs_vec_int,

                            ConstMatrixView sca_vec_int,

                            ConstMatrixView cloudbox_field_mono_int,

                            ConstVectorView p_int,

                            const ArrayOfIndex& cloudbox_limits,

                            ConstVectorView f_grid,

                            const Index& f_index,

                            const Index& p_index,

                            const Index& lat_index,

                            const Index& lon_index,

                            const Index& za_index,

                            const Index& aa_index,

                            const Verbosity& verbosity);


void cloud_RT_surface(Workspace& ws,

                      //Output

                      Tensor6View cloudbox_field_mono,

                      //Input

                      const Agenda& surface_rtprop_agenda,

                      ConstVectorView f_grid,

                      const Index& f_index,

                      const Index& stokes_dim,

                      const Ppath& ppath_step,

                      const ArrayOfIndex& cloudbox_limits,

                      ConstVectorView za_grid,

                      const Index& za_index);


void cloudbox_field_ngAcceleration(  //Output

    Tensor6& cloudbox_field_mono,

    //Input

    const ArrayOfTensor6& acceleration_input,

    const Index& accelerated,

    const Verbosity& verbosity);


void interp_cloud_coeff1D(  //Output

    Tensor3View ext_mat_int,

    MatrixView abs_vec_int,

    MatrixView sca_vec_int,

    MatrixView cloudbox_field_mono_int,

    VectorView t_int,

    MatrixView vmr_list_int,

    VectorView p_int,

    //Input

    ConstTensor5View ext_mat_field,

    ConstTensor4View abs_vec_field,

    ConstTensor6View doit_scat_field,

    ConstTensor6View cloudbox_field_mono,

    ConstTensor3View t_field,

    ConstTensor4View vmr_field,

    ConstVectorView p_grid,

    const Ppath& ppath_step,

    const ArrayOfIndex& cloudbox_limits,

    ConstVectorView za_grid,

    const Index& scat_za_interp,

    const Verbosity& verbosity);


void za_gridOpt(  //Output:

    Vector& za_grid_opt,

    Matrix& i_field_opt,

    // Input

    ConstVectorView za_grid_fine,

    ConstTensor6View i_field,

    const Numeric& acc,

    const Index& scat_za_interp);


void doit_scat_fieldNormalize(Workspace& ws,

                              Tensor6& doit_scat_field,

                              const Tensor6& cloudbox_field_mono,

                              const ArrayOfIndex& cloudbox_limits,

                              const Agenda& spt_calc_agenda,

                              const Index& atmosphere_dim,

                              const Vector& za_grid,

                              const Vector& aa_grid,

                              const Tensor4& pnd_field,

                              const Tensor3& t_field,

                              const Numeric& norm_error_threshold,

                              const Index& norm_debug,

                              const Verbosity& verbosity);


#endif  //doit_h