nanoparticle.hpp

Go to the documentation of this file.

#ifndef NANOPARTICLE_H
#define NANOPARTICLE_H

#include "npspec/constants.h"
#include <string>

class Nanoparticle
{
public:

    Nanoparticle();


    int calculateSpectrum();


    void getSpectrum(double spec[NPSpec::NLAMBDA]) const;


    void getRGB(double &r, double &g, double &b) const;


    void getHSV(double &h, double &s, double &v) const;


    double getOpacity() const;


    int getNLayers() const;


    NPSpec::NanoparticleShape getShape() const;


    NPSpec::SpectraType getSpectraType() const;


    NPSpec::SpectraProperty getSpectraProperty() const;


    double getSphereRadius() const;


    double getEllipsoidZRadius() const;


    double getEllipsoidXYRadius() const;


    double getSphereLayerRelativeRadius(int layer_num) const;


    double getEllipsoidLayerZRelativeRadius(int layer_num) const;


    double getEllipsoidLayerXYRelativeRadius(int layer_num) const;


    std::string getLayerMaterial(int layer_num) const;


    int getLayerIndex(int layer_num) const;


    int getIncrement() const;


    double getPathLength() const;


    double getConcentration() const;


    bool getSizeCorrect() const;


    double getMediumRefractiveIndex() const;


    void setNLayers(int nlay);

    /* \param npshape The new shape of the nanoparticle.
     *
     *  \warning For an ellipse a max of two layers are allowed.
     *
     * \remark
     * When you change the shape of the nanoparticle, the parameters for
     * the other shape remain in memory so you can switch back and forth
     * and not have to reset the parameters.
     */
    void setShape(NPSpec::NanoparticleShape npshape);


    void setSpectraType(NPSpec::SpectraType stype);


    void setSpectraProperty(NPSpec::SpectraProperty spec);


    void setSphereRadius(double rad);


    void setEllipsoidRadius(double zrad, double xyrad);


    void setSphereLayerRelativeRadius(int layer_num, double rrad);


    void setEllipsoidLayerRelativeRadius(int layer_num, double zrrad, double xyrrad);


    void setLayerMaterial(int layer_num, std::string mat);


    void setIncrement(int i);


    void setPathLength(double len);


    void setConcentration(double conc);


    void setSizeCorrect(bool corr);


    void setMediumRefractiveIndex(double mref);

private:
    // Private functions
    void updateRadius(NPSpec::NanoparticleShape npshape);
    void updateRelativeRadius(NPSpec::NanoparticleShape npshape);
    void distributeRelativeRadius(int n, double rrad, double array[NPSpec::MAXLAYERS]);

    // Input parameters to solvers
    int nLayers;
    NPSpec::SpectraType sType;
    NPSpec::SpectraProperty sProp;
    NPSpec::NanoparticleShape shape;
    int increment;
    bool sizeCorrect;
    double pathLength;
    double concentration;
    double mediumRefractiveIndex;
    std::string materials[NPSpec::MAXLAYERS];
    int  materialIndex[NPSpec::MAXLAYERS];
    double radius[2];
    double relativeRadius[NPSpec::MAXLAYERS][2];

    // Auxillary
    double sphereRadius;
    double sphereRelativeRadius[NPSpec::MAXLAYERS];
    double ellipsoidRadius[2];
    double ellipsoidRelativeRadius[NPSpec::MAXLAYERS][2];

    // Results
    double extinction[NPSpec::NLAMBDA];
    double scattering[NPSpec::NLAMBDA];
    double absorbance[NPSpec::NLAMBDA];
    double red;
    double blue;
    double green;
    double hue;
    double saturation;
    double value;

};


#endif // NANOPARTICLE_H