arts-docs-2.2/doxygen/jacobian_8h_source.html

/* Copyright (C) 2004-2012 Mattias Ekstrom <ekstrom@rss.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. */


#ifndef jacobian_h

#define jacobian_h


#include <map>

#include <iostream>

#include <stdexcept>

#include "matpackI.h"

#include "array.h"

#include "mystring.h"

#include "make_array.h"

#include "bifstream.h"

#include "interpolation.h"

#include "logic.h"

#include "methods.h"

#include "ppath.h"

#include "agenda_class.h"


class RetrievalQuantity {

public:


  RetrievalQuantity() : mmaintag(),

                        msubtag(),

                        mmode(),

                        manalytical(-1),

                        mperturbation(0.),

                        mgrids()

  { /* Nothing to do here. */ }


  RetrievalQuantity(const String&             maintag,

                    const String&             subtag,

                    const String&             mode,

                    const Index&              analytical,

                    const Numeric&            perturbation,

                    const ArrayOfVector&      grids ) :

    mmaintag(maintag),

    msubtag(subtag),

    mmode(mode),

    manalytical(analytical),

    mperturbation(perturbation),

    mgrids(grids)

  {

    // With Matpack, initialization of mgrids from grids should work correctly.

  }


  const String& MainTag() const { return mmaintag; }

  void MainTag( const String& mt ) { mmaintag = mt; }

  const String& Subtag() const { return msubtag; }

  void Subtag( const String& st ) { msubtag = st; }

  const String& Mode() const { return mmode; }

  void Mode( const String& m ) { mmode = m; }

  const Index& Analytical() const { return manalytical; }

  void Analytical( const Index& m ) { manalytical = m; }

  const Numeric& Perturbation() const { return mperturbation; }

  void Perturbation( const Numeric& p ) { mperturbation = p; }

  const ArrayOfVector& Grids() const { return mgrids; }

  void Grids( const ArrayOfVector& g ) { mgrids = g; }


private:


  String mmaintag;

  String msubtag;

  String mmode;

  Index manalytical;

  Numeric mperturbation;

  ArrayOfVector mgrids;

};


ostream& operator << (ostream& os, const RetrievalQuantity& ot);


typedef Array<RetrievalQuantity> ArrayOfRetrievalQuantity;


// A macro to loop analytical jacobian quantities

#define FOR_ANALYTICAL_JACOBIANS_DO(what_to_do) \

  for( Index iq=0; iq<jacobian_quantities.nelem(); iq++ ) \

    { \

      if( jacobian_quantities[iq].Analytical() ) \

        { what_to_do } \

    }


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

//             Functions related to calculation of Jacobian

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


void calc_nd_field(       Tensor3View& nd,

                    const VectorView&  p,

                    const Tensor3View& t);


bool check_retrieval_grids(       ArrayOfVector& grids,

                                  ostringstream& os,

                            const Vector&        p_grid,

                            const Vector&        lat_grid,

                            const Vector&        lon_grid,

                            const Vector&        p_retr,

                            const Vector&        lat_retr,

                            const Vector&        lon_retr,

                            const String&        p_retr_name,

                            const String&        lat_retr_name,

                            const String&        lon_retr_name,

                            const Index&         dim);


void diy_from_path_to_rgrids(

         Tensor3View          diy_dx,

   const RetrievalQuantity&   jacobian_quantity,

   ConstTensor3View           diy_dpath,

   const Index&               atmosphere_dim,

   const Ppath&               ppath,

   ConstVectorView            ppath_p );


void get_perturbation_gridpos(      ArrayOfGridPos& gp,

                              const Vector&         atm_grid,

                              const Vector&         jac_grid,

                              const bool&           is_pressure);


void get_perturbation_limit(       ArrayOfIndex& limit,

                             const Vector&       pert_grid,

                             const Vector&       atm_limit);


void get_perturbation_range(       Range& range,

                             const Index& index,

                             const Index& length);


void get_pointers_for_analytical_jacobians(

         ArrayOfIndex&               abs_species_i,

         ArrayOfIndex&               is_t,

         ArrayOfIndex&               wind_i,

   const ArrayOfRetrievalQuantity&   jacobian_quantities,

   const ArrayOfArrayOfSpeciesTag&   abs_species );


void perturbation_field_1d(       VectorView      field,

                            const ArrayOfGridPos& p_gp,

                            const Index&          p_pert_n,

                            const Range&          p_range,

                            const Numeric&        size,

                            const Index&          method);


void perturbation_field_2d(       MatrixView      field,

                            const ArrayOfGridPos& p_gp,

                            const ArrayOfGridPos& lat_gp,

                            const Index&          p_pert_n,

                            const Index&          lat_pert_n,

                            const Range&          p_range,

                            const Range&          lat_range,

                            const Numeric&        size,

                            const Index&          method);


void perturbation_field_3d(       Tensor3View     field,

                            const ArrayOfGridPos& p_gp,

                            const ArrayOfGridPos& lat_gp,

                            const ArrayOfGridPos& lon_gp,

                            const Index&          p_pert_n,

                            const Index&          lat_pert_n,

                            const Index&          lon_pert_n,

                            const Range&          p_range,

                            const Range&          lat_range,

                            const Range&          lon_range,

                            const Numeric&        size,

                            const Index&          method);


void polynomial_basis_func(

        Vector&   b,

  const Vector&   x,

  const Index&    poly_coeff );


void vmrunitscf(

        Numeric&   x,

  const String&    unit,

  const Numeric&   vmr,

  const Numeric&   p,

  const Numeric&   t );


#endif // jacobian_h