Gauss.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 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;
    
    Mdouble getEps() const;
    
    void setEps(Mdouble eps);
    
    Mdouble evaluateCGFunction(const Vec3D& position, const Coordinates 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