Gauss.h

Go to the documentation of this file.

// This file is part of the MercuryDPM project (https://www.mercurydpm.org).
// Copyright (c), The MercuryDPM Developers Team. All rights reserved.
// License: BSD 3-Clause License; see the LICENSE file in the root directory.
 
#ifndef Gauss_H
#define Gauss_H
 
#include <GeneralDefine.h>
#include <iostream>
#include "IntegralType.h"
#include "CG/Coordinates/R.h"
#include "CG/Coordinates/X.h"
#include "CG/Coordinates/Y.h"
#include "CG/Coordinates/Z.h"
#include "CG/Coordinates/RZ.h"
#include "CG/Coordinates/XY.h"
#include "CG/Coordinates/XZ.h"
#include "CG/Coordinates/YZ.h"
#include "CG/Coordinates/XYZ.h"
#include "CG/Coordinates/O.h"
 
class BaseParticle;
 
class BaseInteraction;
 
class DPMBase;
 
class Coordinates;
 
namespace CGFunctions
{
 
template<class Coordinates>
class Gauss
{
public:
    
    typedef Coordinates CoordinatesType;
    
    Gauss();
    
    Gauss(const Gauss& c) = default;
    
    ~Gauss() = default;
    
    void write(std::ostream& os) const;
    
    //void setStandardDeviation(Mdouble standardDeviation);
    
    void setWidth(Mdouble width);
    
    void setStandardDeviation(Mdouble std);
    
    void setWidthAndCutoff(Mdouble width, Mdouble cutoff);
    
    Mdouble getWidth() const;
    
    Mdouble getCutoff() const;
    
    inline Vec3D getCutoffVector(Mdouble radius, Vec3D cellSize) const { return Vec3D(getCutoff(), getCutoff(), getCutoff()); }
    
    Mdouble getEps() const;
    
    void setEps(Mdouble eps);
    
    Mdouble evaluateCGFunction(const Vec3D& position, const Coordinates r);
    
    Mdouble evaluateCGFunction(const Vec3D& position, const Mdouble rad, const Coordinates r)
    {
        return evaluateCGFunction(position, r);
    }
    
    Vec3D evaluateCGFunctionDerivatives(const Vec3D& position, const Coordinates& r);
    
    Mdouble evaluateCGFunctionDerivativeWithFD(const Vec3D& position, const Coordinates& r, const int i);
    
    Mdouble evaluateCylindricalCGFunction(const Vec3D& position, const CGCoordinates::R r)
    { return constants::NaN; }
    
    Mdouble
    evaluateCGIntegral(const BaseInteraction& i, const Coordinates r, IntegralType type = IntegralType::I_TO_P);
    
    Mdouble evaluateCylindricalCGIntegral(const BaseInteraction& c, const CGCoordinates::R r,
                                          IntegralType type = IntegralType::I_TO_P)
    { return constants::NaN; }
    
    Mdouble
    evaluateCGIntegral1D(const BaseInteraction& i, const Coordinates r, IntegralType type = IntegralType::I_TO_P);
 
protected:
    
    Mdouble width_;
    
    Mdouble cutoff_;
    
    Mdouble prefactor_;
    
    Mdouble integralPrefactor_;
    
    Mdouble normalLength_;
    
    Vec3D normal_;
    
    unsigned currentInteraction_;
    
    Mdouble eps_;
    
};
 
typedef CGFunctions::Gauss<CGCoordinates::O> GaussO;
typedef CGFunctions::Gauss<CGCoordinates::X> GaussX;
typedef CGFunctions::Gauss<CGCoordinates::Y> GaussY;
typedef CGFunctions::Gauss<CGCoordinates::Z> GaussZ;
typedef CGFunctions::Gauss<CGCoordinates::YZ> GaussYZ;
typedef CGFunctions::Gauss<CGCoordinates::XZ> GaussXZ;
typedef CGFunctions::Gauss<CGCoordinates::XY> GaussXY;
typedef CGFunctions::Gauss<CGCoordinates::XYZ> GaussXYZ;
typedef CGFunctions::Gauss<CGCoordinates::R> GaussR;
    
} //namespace CGFunctions
#include "Gauss.hcc"
 
#endif