ppath.h

Go to the documentation of this file.

/* Copyright (C) 2002-2012 Patrick Eriksson <Patrick.Eriksson@chalmers.se>

   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 ppath_h
#define ppath_h


#include "agenda_class.h"
#include "array.h"
#include "arts.h"
#include "interpolation.h"
#include "matpackI.h"
#include "mystring.h"



/*===========================================================================
  === The Ppath structure
  ===========================================================================*/


struct Ppath {
  Index             dim;
  Index             np;
  Numeric           constant;
  String            background;
  Vector            start_pos;
  Vector            start_los;
  Numeric           start_lstep;
  Matrix            pos;
  Matrix            los;
  Vector            r;
  Vector            lstep;
  Vector            end_pos;
  Vector            end_los;
  Numeric           end_lstep;
  Vector            nreal;
  Vector            ngroup;
  ArrayOfGridPos    gp_p;
  ArrayOfGridPos    gp_lat;
  ArrayOfGridPos    gp_lon;
};


typedef Array<Ppath> ArrayOfPpath;



/*===========================================================================
  === South/north pole, nadir/zenith
  ===========================================================================*/

// Latitudes with an absolute value > POLELAT are considered to be on
// the south or north pole for 3D.
//
const Numeric   POLELAT = 90-1e-8;

// This variable defines how much zenith and azimuth angles can
// deviate from 0, 90 and 180 degrees, but still be treated to be 0,
// 90 or 180.  For example, an azimuth angle of 180-0.999*ANGTOL will
// be treated as a strictly southward observation.  However, the
// angles are not allowed to go outside their defined range.  This
// means, for example, that values above 180 are never allowed.
//
const Numeric   ANGTOL = 1e-6; 




/*===========================================================================
  === Functions from ppath.cc
  ===========================================================================*/

Numeric geometrical_ppc( const Numeric& r, const Numeric& za );

Numeric geompath_za_at_r(
        const Numeric&   ppc,
        const Numeric&   a_za,
        const Numeric&   r );

Numeric geompath_lat_at_za(
        const Numeric&   za0,
        const Numeric&   lat0,
        const Numeric&   za );

void cart2zaaa(
             Numeric&  za,
             Numeric&  aa,
       const Numeric&  dx,
       const Numeric&  dy,
       const Numeric&  dz );

void zaaa2cart(
             Numeric&  dx,
             Numeric&  dy,
             Numeric&  dz,
       const Numeric&  za,
       const Numeric&  aa );

void map_daa(
             Numeric&   za,
             Numeric&   aa,
       const Numeric&   za0,
       const Numeric&   aa0,
       const Numeric&   aa_grid );

void find_tanpoint( 
         Index&   it,
   const Ppath    ppath );

void plevel_slope_2d(
               Numeric&   c1,
        ConstVectorView   lat_grid,           
        ConstVectorView   refellipsoid,
        ConstVectorView   z_surf,
        const GridPos&    gp,
        const Numeric&    za );

void plevel_slope_3d(
              Numeric&    c1,
              Numeric&    c2,
        ConstVectorView   lat_grid,
        ConstVectorView   lon_grid,  
        ConstVectorView   refellipsoid,
        ConstMatrixView   z_surf,
        const GridPos&    gp_lat,
        const GridPos&    gp_lon,
        const Numeric&    aa );

bool is_los_downwards( 
        const Numeric&   za,
        const Numeric&   tilt );

Numeric plevel_angletilt(
        const Numeric&   r,
        const Numeric&   c );

void ppath_init_structure( 
              Ppath&      ppath,
        const Index&      atmosphere_dim,
        const Index&      np );

void ppath_set_background( 
              Ppath&      ppath,
        const Index&      case_nr );

Index ppath_what_background( const Ppath&   ppath );

void ppath_copy(
          Ppath&      ppath1,
    const Ppath&       ppath2,
    const Index&       ncopy );

void ppath_step_geom_1d(
              Ppath&      ppath,
        ConstVectorView   z_field,
        ConstVectorView   refellipsoid,
        const Numeric&    z_surface,
        const Numeric&    lmax );

void ppath_geom_updown_1d(
              Ppath&      ppath,
        ConstVectorView   z_field,
        ConstVectorView   refellipsoid,
        const Numeric&    z_surface,
        const Index&      cloudbox_on, 
     const ArrayOfIndex&  cloudbox_limits );

void ppath_step_geom_2d(
              Ppath&      ppath,
        ConstVectorView   lat_grid,
        ConstMatrixView   z_field,
        ConstVectorView   refellipsoid,
        ConstVectorView   z_surface,
        const Numeric&    lmax );

void ppath_step_geom_3d(
              Ppath&       ppath,
        ConstVectorView    lat_grid,
        ConstVectorView    lon_grid,
        ConstTensor3View   z_field,
        ConstVectorView    refellipsoid,
        ConstMatrixView    z_surface,
        const Numeric&     lmax );

void ppath_step_refr_1d(
              Workspace&  ws,
              Ppath&      ppath,
        ConstVectorView   p_grid,
        ConstTensor3View  z_field,
        ConstTensor3View  t_field,
        ConstTensor4View  vmr_field,
        ConstVectorView   f_grid, 
        ConstVectorView   refellipsoid,
        const Numeric&    z_surface,
        const Numeric&    lmax,
        const Agenda&     refr_index_agenda,
        const String&     rtrace_method,
        const Numeric&    lraytrace );

void ppath_step_refr_2d(
              Workspace&  ws,
              Ppath&      ppath,
        ConstVectorView   p_grid,
        ConstVectorView   lat_grid,
        ConstTensor3View  z_field,
        ConstTensor3View  t_field,
        ConstTensor4View  vmr_field,
        ConstVectorView   f_grid, 
        ConstVectorView   refellipsoid,
        ConstVectorView   z_surface,
        const Numeric&    lmax,
        const Agenda&     refr_index_agenda,
        const String&     rtrace_method,
        const Numeric&    lraytrace );

void ppath_step_refr_3d(
              Workspace&  ws,
              Ppath&      ppath,
        ConstVectorView   p_grid,
        ConstVectorView   lat_grid,
        ConstVectorView   lon_grid,
        ConstTensor3View  z_field,
        ConstTensor3View  t_field,
        ConstTensor4View  vmr_field,
        ConstVectorView   f_grid, 
        ConstVectorView   refellipsoid,
        ConstMatrixView   z_surface,
        const Numeric&    lmax,
        const Agenda&     refr_index_agenda,
        const String&     rtrace_method,
        const Numeric&    lraytrace );

void ppath_start_stepping(
              Ppath&            ppath,
        const Index&            atmosphere_dim,
        ConstVectorView         p_grid,
        ConstVectorView         lat_grid,
        ConstVectorView         lon_grid,
        ConstTensor3View        z_field,
        ConstVectorView         refellipsoid,
        ConstMatrixView         z_surface,
        const Index &           cloudbox_on,
        const ArrayOfIndex &    cloudbox_limits,
        const bool &            outside_cloudbox,
        ConstVectorView         rte_pos,
        ConstVectorView         rte_los,
        const Verbosity&        verbosity);

void ppath_calc(  
          Workspace&      ws,
          Ppath&          ppath,
    const Agenda&         ppath_step_agenda,
    const Index&          atmosphere_dim,
    const Vector&         p_grid,
    const Vector&         lat_grid,
    const Vector&         lon_grid,
    const Tensor3&        t_field,
    const Tensor3&        z_field,
    const Tensor4&        vmr_field,
    const Vector&         f_grid, 
    const Vector&         refellipsoid,
    const Matrix&         z_surface,
    const Index&          cloudbox_on, 
    const ArrayOfIndex&   cloudbox_limits,
    const Vector&         rte_pos,
    const Vector&         rte_los,
    const Numeric&        ppath_lraytrace,
    const bool&           ppath_inside_cloudbox_do,
    const Verbosity&      verbosity);

#endif  // ppath_h