plummerlens.h

Go to the documentation of this file.

/*

  This file is a part of GRALE, a library to facilitate the simulation
  and inversion of gravitational lenses.

  Copyright (C) 2008-2012 Jori Liesenborgs

  Contact: jori.liesenborgs@gmail.com
  
  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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  
*/

#ifndef GRALE_PLUMMERLENS_H

#define GRALE_PLUMMERLENS_H

#include "graleconfig.h"
#include "symmetriclens.h"

namespace grale
{

class GRALE_IMPORTEXPORT PlummerLensParams : public GravitationalLensParams
{
public:
        PlummerLensParams()                                                             { lensmass = 0; angwidth = 0; }

        PlummerLensParams(double mass,double angularwidth)                              { lensmass = mass; angwidth = angularwidth; }

        double getLensMass() const                                                      { return lensmass; }

        double getAngularWidth() const                                                  { return angwidth; }
        
        GravitationalLensParams *createCopy() const;
        bool write(serut::SerializationInterface &si) const;
        bool read(serut::SerializationInterface &si);
private:
        double lensmass,angwidth;
};

class GRALE_IMPORTEXPORT PlummerLens : public SymmetricLens
{
public:
        PlummerLens();
        ~PlummerLens();

        bool getProjectedPotential(double D_s, double D_ds, Vector2D<double> theta, 
                                   double *pPotentialValue) const;

        bool getSuggestedScales(double *pDeflectionScale, double *pPotentialScale) const;
        bool getCLParameterCounts(int *pNumIntParams, int *pNumFloatParams) const;
        bool getCLParameters(double deflectionScale, double potentialScale, int *pIntParams, float *pFloatParams) const;
        std::string getCLProgram(std::string &subRoutineName) const;
        int getCLSubLenses() const                                                      { return 1; }
protected:
        bool processParameters(const GravitationalLensParams *pLensParams);
        double getMassInside(double thetaLength) const;
        double getProfileSurfaceMassDensity(double thetaLength) const;
private:
        double mass,angularwidth,angularwidth2;
};                    

} // end namespace

#endif // GRALE_PLUMMERLENS_H