compositelens.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_COMPOSITELENS_H

#define GRALE_COMPOSITELENS_H

#include "graleconfig.h"
#include "gravitationallens.h"
#include <vector>
#include <list>

namespace grale
{

class GRALE_IMPORTEXPORT CompositeLensParams : public GravitationalLensParams
{
public:
        class LensInfo;
public:
        CompositeLensParams();
        ~CompositeLensParams();
        bool addLens(double factor, Vector2D<double> position, double angle, const GravitationalLens &lens);
        bool write(serut::SerializationInterface &si) const;
        bool read(serut::SerializationInterface &si);
        const std::list<LensInfo *> &getLensInfo() const                                                { return m_lensInfo; }
        GravitationalLensParams *createCopy() const;
private:
        std::list<LensInfo *> m_lensInfo;
};

// TODO
// WARNING!!! No check on the different angular diameter distances of the sublenses is performed!!!
// 
class GRALE_IMPORTEXPORT CompositeLens : public GravitationalLens
{
public:
        CompositeLens();
        ~CompositeLens();
        bool getAlphaVector(Vector2D<double> theta, Vector2D<double> *pAlpha) const;
        double getSurfaceMassDensity(Vector2D<double> theta) const;
        bool getAlphaVectorDerivatives(Vector2D<double> theta, double &axx, double &ayy, double &axy) const;
        void setDerivativeAngularDistanceScale(double distanceScale);
        bool getProjectedPotential(double D_s, double D_ds, Vector2D<double> theta, double *pPotentialValue) const;

        int getNumberOfSubLenses() const                                                        { return m_lenses.size(); }
        const GravitationalLens *getSubLens(int i) const                                        { return m_lenses[i]; }
        Vector2D<double> getSubLensPosition(int i) const                                        { return m_positions[i]; }
        double getSubLensAngle(int i) const                                                     { return m_angles[i]; }
        double getSubLensFactor(int i) const                                                    { return m_factors[i]; }

        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;
protected:
        bool processParameters(const GravitationalLensParams *pLensParams);
private:
        static std::string getCLProgram(const std::vector<std::string> &subRoutineNames, int recursionLevel, int maxRecursion);
        
        void findCLSubroutines(std::string &prog, std::vector<std::string> &otherRoutineNames, int recursionLevel, int &maxRecursionLevel) const;

        std::vector<GravitationalLens *> m_lenses;
        std::vector<Vector2D<double> > m_positions;
        std::vector<double> m_angles;
        std::vector<double> m_factors;
};
        
} // end namespace

#endif // GRALE_COMPOSITELENS_H