BaseCG.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 BaseCG_H
#define BaseCG_H
 
#include <cstdlib>
#include <functional>
#include "GeneralDefine.h"
#include "BaseObject.h"
#include "File.h"
#include "Math/Vector.h"
 
class CGHandler;
 
class BaseInteractable;
 
class BaseCG : public BaseObject
{
public:
    
    BaseCG();
    
    BaseCG(const BaseCG& p) = default;
    
    ~BaseCG() override = default;
    
    void read(std::istream& is) override;
    
    void write(std::ostream& os) const override;
    
    void clear();
    
    virtual BaseCG* copy() const = 0;
    
    virtual void initialise() = 0;
    
    virtual void evaluate() = 0;
    
    virtual void finish() = 0;
    
    void setHandler(CGHandler* handler);
    
    CGHandler* getHandler() const;
    
    virtual void setWidth(Mdouble width)=0;
    
    virtual Mdouble getWidth() const =0;
    
    void setNZ(std::size_t nZ);
    
    std::size_t getNZ() const;
    
    void setNY(std::size_t nY);
    
    std::size_t getNY() const;
    
    void setNX(std::size_t nX);
    
    std::size_t getNX() const;
    
    void setN(std::size_t n);
    
    void setN(std::array<std::size_t, 3> n);
    
    void setH(Mdouble h);
    
    void setHX(Mdouble h);
    
    void setHY(Mdouble h);
    
    void setHZ(Mdouble h);
    
    void setTimeMin(Mdouble timeMin);
    
    void setTimeMax(Mdouble timeMax);
    
    Mdouble getTimeMin() const;
    
    Mdouble getTimeMax() const;
    
    void setMin(Vec3D min);
    
    void setX(Mdouble min, Mdouble max);
    
    void setY(Mdouble min, Mdouble max);
    
    void setZ(Mdouble min, Mdouble max);
    
    void setXGrid(Mdouble min, Mdouble max, Mdouble h);
    
    void setYGrid(Mdouble min, Mdouble max, Mdouble h);
    
    void setZGrid(Mdouble min, Mdouble max, Mdouble h);
    
    void setGrid(Vec3D min, Vec3D max, Mdouble h);
    
    void setMax(Vec3D max);
    
    Vec3D getMin() const;
    
    Vec3D getMax() const;
    
    void selectSpecies(unsigned speciesIndex);
    
    void setSelectedParticle(const std::function<const bool(const BaseInteractable*)>& selectedParticle);
    
    void setEps(Mdouble eps);
    
    Mdouble getEps() const;
 
    void setAverageBeyondDomain(const bool val) {averageBeyondDomain_=val;}
 
    bool getAverageBeyondDomain() const {return averageBeyondDomain_;}
    
    void setVerbose(const bool verbose) {verbose_=verbose;}
    
    bool getVerbose() const {return verbose_;}
 
    /*
     * Sets width such that the CG function has a fixed standard deviation
     * See CGStandardDeviationUnitTest.
     */
    virtual void setStandardDeviation(Mdouble std) = 0;
    
    /*
     * Sets width such that the CG function has the same standard deviation as a spherical cg function.
     * See CGStandardDeviationUnitTest.
     */
    virtual void setRadius(Mdouble radius) = 0;
 
protected:
    
    CGHandler* handler_; 
    
    std::size_t nX_;
    
    std::size_t nY_;
    
    std::size_t nZ_;
    
    Mdouble eps_;
    
    Mdouble timeMin_;
    
    Mdouble timeMax_;
    
    Vec3D min_;
    
    Vec3D max_;
    
    std::function<bool(const BaseInteractable*)> selectedParticle_;
 
    bool averageBeyondDomain_ = true;
    
    bool verbose_ = false;
 
public:
    File statFile;
};
 
#endif