HGridOptimiser.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 HGRIDOPTIMIZER_H
#define HGRIDOPTIMIZER_H
 
#include <vector>
#include "MercuryBase.h"
 
class HGridOptimiser
{
public:
    void initialise(const MercuryBase& problem, unsigned int numberOfCells, int verbosity);
    
    void initialisePolyFunc(double omega, std::vector<double>& coeff, unsigned int numberOfCells, int verbosity);
    
    unsigned int radius2Cell(double r);
    
    unsigned int radius2IntCell(double r);
    
    double intCell2Min(unsigned int i);
    
    double intCell2Max(unsigned int i);
    
    double cell2Min(unsigned int i);
    
    double cell2Max(unsigned int i);
    
    double pdfIntCell(double start, double end, unsigned int i, int p);
    
    double pdfInt(double start, double end, int power);
    
    double diffPdfInt(double x, int power);
    
    double expectedCellsIntegralCellNumerator(double start, double end, unsigned int i, int p, double h);
    
    double diffHExpectedCellsIntegralCellNumerator(double start, double end, unsigned int i, int p, double h);
    
    double expectedCellsIntegralCellDenominator(double start, double end, unsigned int i);
    
    double expectedCellsIntegral(double start, double end, int p, double h);
    
    double diffStartExpectedCellsIntegral(double start, double end, int p, double h);
    
    double diffEndExpectedCellsIntegral(double start, double end, int p, double h);
    
    double diffHExpectedCellsIntegral(double start, double end, int p, double h);
    
    double calculateWork(std::vector<double>& hGridCellSizes, HGridMethod method, int verbosity);
    
    void calculateDiffWork(std::vector<double>& hGridCellSizes, std::vector<double>& dfdx, HGridMethod method,
                           int verbosity);
    
    void calcDfDx(std::vector<double>& hGridCellSizes, std::vector<double>& dfdx, HGridMethod method, int verbosity);
    
    double checkLimit(std::vector<double>& hGridCellSizes, std::vector<double>& dfdx, int verbosity);
    
    void applyStep(std::vector<double>& hGridCellSizes, std::vector<double>& dfdx, double stepsize, int verbosity);
    
    double
    goldenSectionSearch(std::vector<double>& startHGridCellSizes, std::vector<double>& searchDirection, double min,
                        double cur, double max, HGridMethod method, int verbosity);
    
    void getOptimalDistribution(std::vector<double>& hGridCellSizes, unsigned int numberOfLevels, HGridMethod method,
                                int verbosity);
    
    void histNumberParticlesPerCell(std::vector<double>& hGridCellSizes);
 
private:
    unsigned int numCells_;
    double rMin_;
    double rMax_;
    double length_;
    double cellCheckOverContactCheckRatio_;
    unsigned int dimension_;
    
    //Something with cells. Still have to find out which property the double represents.
    //Could be the number of particles in that cell (see initialise), but then 
    //you'd expect an unsigned int and not a double.
    std::vector<double> cellN_;
    std::vector<double> intCellN;
};
 
#endif