CG.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 CG_H
#define CG_H
 
#include "CG/BaseCG.h"
#include <vector>
 
class CGHandler;
 
class Function;
 
class BaseParticle;
 
class BaseInteraction;
 
#include "CG/CGPoint.h"
#include "DPMBase.h"
#include "CG/CGHandler.h"
#include "Species/ParticleSpecies.h"
#include "Logger.h"
#include "CG/Functions/Lucy.h"
#include "CG/Functions/Heaviside.h"
 
template<class Coordinates = CGCoordinates::O,
        template<class> class BaseFunction=CGFunctions::Lucy,
        class Fields=CGFields::StandardFields>
class CG : public BaseCG
{
public:
    typedef BaseFunction<Coordinates> Function;
    typedef CGPoint<Coordinates, Fields> Point;
    
    CG() = default;
    
    CG(Mdouble width, unsigned n);
    
    CG(const CG& p) = default;
    
    virtual ~CG() = default;
    
    CG<Coordinates, BaseFunction, Fields>* copy() const override;
    
    void write(std::ostream& os) const override;
    
    void writeAll(std::ostream& os) const;
    
    std::string getName() const override;
    
    void initialise() override;
    
    virtual void createMesh();
    
    void evaluate() override;
    
    Point evaluateAverage();
    
    Point evaluateTotal();
    
    void evaluateParticleAtPoint(Fields& currentInteraction, const BaseParticle& p, Point& r);
    
    void evaluateParticle(const BaseParticle& p);
    
    void evaluateContact(const BaseInteraction& i);
    
    IntegralType getIntegralType(const BaseInteraction& c);
    
    void finish() override;
    
    const Point& getPoint(size_t i) const
    {
        return points_[i];
    }
    
    const std::vector<Point>& getPoints() const
    {
        return points_;
    }
    
    Function& getFunction()
    {
        return function_;
    }
    
    void setStandardDeviation(Mdouble std) override
    {
        function_.setStandardDeviation(std);
    }
    
    void setRadius(Mdouble radius) override
    {
        if (std::is_base_of<CGCoordinates::Base_X_Y_Z, Coordinates>::value)
        {
            function_.setStandardDeviation(radius * sqrt(.2));
        }
        else if (std::is_base_of<CGCoordinates::Base_XY_XZ_YZ, Coordinates>::value)
        {
            function_.setStandardDeviation(radius * sqrt(.4));
        }
        else /*XYZ*/ {
            function_.setStandardDeviation(radius * sqrt(.6));
        }
    }
    
    void setWidth(Mdouble width) override
    {
        function_.setWidth(width);
    }
    
    Mdouble getWidth() const override
    {
        return function_.getWidth();
    }
 
protected:
    
    void resetVariables();
    
    void volumeAverageVariables();
    
    void writeVariables();
    
    void evaluateCommon();
    
    void outputSumOfVariables();
 
protected:
    
    std::vector<Point> points_;
    
    Function function_;
    
    
};
 
#include "CG/CG.hcc"
 
#endif