arts-docs-2.4/doxygen/montecarlo_8h_source.html

/* Copyright (C) 2003-2012 Cory Davis <cory@met.ed.ac.uk>


   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 of the

   License, 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 montecarlo_h

#define montecarlo_h


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

  === External declarations

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

#include <cmath>

#include <stdexcept>

#include "arts.h"

#include "check_input.h"

#include "cloudbox.h"

#include "lin_alg.h"

#include "logic.h"

#include "matpackI.h"

#include "messages.h"

#include "optproperties.h"

#include "physics_funcs.h"

#include "ppath.h"

#include "rng.h"

#include "rte.h"

#include "special_interp.h"

#include "xml_io.h"


extern const Numeric DEG2RAD;

extern const Numeric RAD2DEG;

extern const Numeric PI;


void clear_rt_vars_at_gp(Workspace& ws,

                         MatrixView ext_mat_mono,

                         VectorView abs_vec_mono,

                         Numeric& temperature,

                         const Agenda& propmat_clearsky_agenda,

                         const Numeric& f_mono,

                         const GridPos& gp_p,

                         const GridPos& gp_lat,

                         const GridPos& gp_lon,

                         ConstVectorView p_grid,

                         ConstTensor3View t_field,

                         ConstTensor4View vmr_field);


void cloudy_rt_vars_at_gp(Workspace& ws,

                          MatrixView ext_mat_mono,

                          VectorView abs_vec_mono,

                          VectorView pnd_vec,

                          Numeric& temperature,

                          const Agenda& propmat_clearsky_agenda,

                          const Index stokes_dim,

                          const Index f_index,

                          const Vector& f_grid,

                          const GridPos& gp_p,

                          const GridPos& gp_lat,

                          const GridPos& gp_lon,

                          ConstVectorView p_grid_cloud,

                          ConstTensor3View t_field_cloud,

                          ConstTensor4View vmr_field_cloud,

                          const Tensor4& pnd_field,

                          const ArrayOfArrayOfSingleScatteringData& scat_data,

                          const ArrayOfIndex& cloudbox_limits,

                          const Vector& rte_los);


void cloud_atm_vars_by_gp(VectorView pressure,

                          VectorView temperature,

                          MatrixView vmr,

                          MatrixView pnd,

                          const ArrayOfGridPos& gp_p,

                          const ArrayOfGridPos& gp_lat,

                          const ArrayOfGridPos& gp_lon,

                          const ArrayOfIndex& cloudbox_limits,

                          ConstVectorView p_grid_cloud,

                          ConstTensor3View t_field_cloud,

                          ConstTensor4View vmr_field_cloud,

                          ConstTensor4View pnd_field);


void get_ppath_transmat(

    Workspace& ws,

    MatrixView& trans_mat,

    const Ppath& ppath,

    const Agenda& propmat_clearsky_agenda,

    const Index stokes_dim,

    const Index f_index,

    const Vector& f_grid,

    const Vector& p_grid,

    const Tensor3& t_field,

    const Tensor4& vmr_field,

    const ArrayOfIndex& cloudbox_limits,

    const Tensor4& pnd_field,

    const ArrayOfArrayOfSingleScatteringData& scat_data_mono,

    const Verbosity& verbosity);


bool is_anyptype_nonTotRan(

    const ArrayOfArrayOfSingleScatteringData& scat_data_mono);


void mcPathTraceGeneral(Workspace& ws,

                        MatrixView evol_op,

                        Vector& abs_vec_mono,

                        Numeric& temperature,

                        MatrixView ext_mat_mono,

                        Rng& rng,

                        Vector& rte_pos,

                        Vector& rte_los,

                        Vector& pnd_vec,

                        Numeric& g,

                        Ppath& ppath_step,

                        Index& termination_flag,

                        bool& inside_cloud,

                        const Agenda& ppath_step_agenda,

                        const Numeric& ppath_lmax,

                        const Numeric& ppath_lraytrace,

                        const Numeric& taustep_limit,

                        const Agenda& propmat_clearsky_agenda,

                        const Index stokes_dim,

                        const Index f_index,

                        const Vector& f_grid,

                        const Vector& p_grid,

                        const Vector& lat_grid,

                        const Vector& lon_grid,

                        const Tensor3& z_field,

                        const Vector& refellipsoid,

                        const Matrix& z_surface,

                        const Tensor3& t_field,

                        const Tensor4& vmr_field,

                        const ArrayOfIndex& cloudbox_limits,

                        const Tensor4& pnd_field,

                        const ArrayOfArrayOfSingleScatteringData& scat_data,

                        const Verbosity& verbosity);


void mcPathTraceRadar(Workspace& ws,

                      MatrixView evol_op,

                      Vector& abs_vec_mono,

                      Numeric& temperature,

                      MatrixView ext_mat_mono,

                      Rng& rng,

                      Vector& rte_pos,

                      Vector& rte_los,

                      Vector& pnd_vec,

                      Numeric& stot,

                      Numeric& ttot,

                      Ppath& ppath_step,

                      Index& termination_flag,

                      bool& inside_cloud,

                      const Agenda& ppath_step_agenda,

                      const Numeric& ppath_lmax,

                      const Numeric& ppath_lraytrace,

                      const Agenda& propmat_clearsky_agenda,

                      const bool& anyptype_nonTotRan,

                      const Index stokes_dim,

                      const Index f_index,

                      const Vector& f_grid,

                      const Vector& Iprop,

                      const Vector& p_grid,

                      const Vector& lat_grid,

                      const Vector& lon_grid,

                      const Tensor3& z_field,

                      const Vector& refellipsoid,

                      const Matrix& z_surface,

                      const Tensor3& t_field,

                      const Tensor4& vmr_field,

                      const ArrayOfIndex& cloudbox_limits,

                      const Tensor4& pnd_field,

                      const ArrayOfArrayOfSingleScatteringData& scat_data_mono,

                      const Verbosity& verbosity);


void Sample_los(VectorView new_rte_los,

                Numeric& g_los_csc_theta,

                MatrixView Z,

                Rng& rng,

                ConstVectorView rte_los,

                const ArrayOfArrayOfSingleScatteringData& scat_data,

                const Index stokes_dim,

                const Index f_index,

                ConstVectorView pnd_vec,

                ConstVectorView Z11maxvector,

                const Numeric Csca,

                const Numeric rtp_temperature,

                const Index t_interp_order = 1);


void Sample_los_uniform(VectorView new_rte_los, Rng& rng);


#endif  // montecarlo_h