PSD.h

Go to the documentation of this file.

//Copyright (c) 2013-2023, The MercuryDPM Developers Team. All rights reserved.
//For the list of developers, see <http://www.MercuryDPM.org/Team>.
//
//Redistribution and use in source and binary forms, with or without
//modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name MercuryDPM nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//DISCLAIMED. IN NO EVENT SHALL THE MERCURYDPM DEVELOPERS TEAM BE LIABLE FOR ANY
//DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
#ifndef MECURYDPM_PSD_H
#define MECURYDPM_PSD_H
 
#include <fstream>
#include <Logger.h>
#include <vector>
#include <Tools/csvReader.h>
#include <random>
#include "iostream"
#include "ExtendedMath.h"
#include "RNG.h"
#include <Math/DistributionElements.h>
 
using mathsFunc::square;
using mathsFunc::cubic;
 
class PSD
{
 
public:
    enum class TYPE
    {
        CUMULATIVE_NUMBER_DISTRIBUTION,
        CUMULATIVE_LENGTH_DISTRIBUTION,
        CUMULATIVE_VOLUME_DISTRIBUTION,
        CUMULATIVE_AREA_DISTRIBUTION,
        PROBABILITYDENSITY_NUMBER_DISTRIBUTION,
        PROBABILITYDENSITY_LENGTH_DISTRIBUTION,
        PROBABILITYDENSITY_AREA_DISTRIBUTION,
        PROBABILITYDENSITY_VOLUME_DISTRIBUTION
    };
    
    PSD();
 
    PSD(const PSD& other);
 
    ~PSD();
 
    PSD* copy() const;
 
    void printPSD() const;
 
    Mdouble drawSample();
 
    Mdouble insertManuallyByVolume(Mdouble volume);
 
    void validateCumulativeDistribution();
 
    void validateProbabilityDensityDistribution();
 
    MERCURYDPM_DEPRECATED
    void setPSDFromVector(std::vector<DistributionElements> psd, TYPE PSDType);
 
    void setPSDFromCSV(const std::string& fileName, TYPE PSDType, bool headings = false, Mdouble
    unitScalingFactorRadii = 1.0);
 
    void setDistributionUniform(Mdouble radMin, Mdouble radMax, int numberOfBins);
 
    void setDistributionNormal(Mdouble mean, Mdouble standardDeviation, int numberOfBins);
 
    static PSD getDistributionNormal(Mdouble mean, Mdouble standardDeviation, int numberOfBins) {
        PSD psd;
        psd.setDistributionNormal(mean, standardDeviation, numberOfBins);
        return psd;
    }
 
    void setDistributionLogNormal(Mdouble mean, Mdouble standardDeviation, int numberOfBins);
 
    static PSD getDistributionLogNormal(Mdouble mean, Mdouble standardDeviation, int numberOfBins) {
        PSD psd;
        psd.setDistributionLogNormal(mean, standardDeviation, numberOfBins);
        return psd;
    }
 
    void convertProbabilityDensityToCumulative();
 
    void convertCumulativeToProbabilityDensity();
 
    void convertProbabilityDensityToProbabilityDensityNumberDistribution(TYPE PDFType);
 
    void convertProbabilityDensityNumberDistributionToProbabilityDensityVolumeDistribution();
 
    void convertCumulativeToCumulativeNumberDistribution(TYPE CDFType);
 
    void cutoffCumulativeNumber(Mdouble quantileMin, Mdouble quantileMax, Mdouble minPolydispersity = 0.1);
 
    void cutoffAndSqueezeCumulative(Mdouble quantileMin, Mdouble quantileMax, Mdouble squeeze,
                                    Mdouble minPolydispersity = 0.1);
 
    Mdouble getMinRadius() const;
 
    Mdouble getMaxRadius() const;
    
    std::vector<DistributionElements> getParticleSizeDistribution() const;
    
    void setParticleSizeDistribution(std::vector<DistributionElements>);
 
    int getInsertedParticleNumber() const;
    
    void decrementNParticlesPerClass();
    
    void decrementVolumePerClass(Mdouble volume);
 
    Mdouble getRadius(int index) const;
    
    Mdouble getNumberDx(Mdouble x) const;
    
    Mdouble getVolumeDx(Mdouble x) const;
 
    Mdouble getRadiusByQuantile(Mdouble quantile) const;
 
    Mdouble getQuantileByRadius(Mdouble radius) const;
 
    Mdouble getVolumetricMeanRadius() const;
    
    Mdouble getSizeRatio() const;
    
    void cutHighSizeRatio();
 
//    /*!
//     * \brief compute raw momenta of the user defined PSD.
//     */
//    void computeRawMomenta();
//
//    /*!
//     * \brief compute central momenta of the user defined PSD.
//     */
//    void computeCentralMomenta();
//
//    /*!
//     * \brief compute standardised momenta of the user defined PSD.
//     */
//    void computeStandardisedMomenta();
//
//    /*!
//     * \brief get momenta of the user defined PSD.
//     */
//    std::array<Mdouble, 6> getMomenta() const;
    
    static std::vector<Mdouble> linspace(Mdouble Min, Mdouble Max, int numberOfBins);
    
    void setFixedSeed(int seed)
    {
//        random_.setLinearCongruentialGeneratorParmeters(0,0,1);
        random_.setRandomSeed(seed);
    }
    
    friend bool operator<(const DistributionElements& l, const DistributionElements& r);
    
    friend bool operator<(const DistributionElements& l, Mdouble r);
    
    friend std::ostream& operator<<(std::ostream& os, DistributionElements& p);
    
    friend std::istream& operator>>(std::istream& is, DistributionElements& p);
    
    friend Mdouble operator==(DistributionElements l, Mdouble r);
 
private:
    std::vector<DistributionElements> particleSizeDistribution_;
 
    std::vector<int> nParticlesPerClass_;
    
    std::vector<Mdouble> volumePerClass_;
    
    int index_;
    
    RNG random_;
};
 
 
#endif //MECURYDPM_PSD_H