TimeSmoothedCG.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 TimeSmoothedCG_H
#define TimeSmoothedCG_H
 
#include <GeneralDefine.h>
#include "CG/CG.h"
#include <iostream>
#include <vector>
#include "TimeSmoothedFields.h"
 
class BaseParticle;
 
class BaseInteraction;
 
class DPMBase;
 
class Function;
 
template<class Coordinates, template<class> class BaseFunction=CGFunctions::Lucy, class Fields=CGFields::StandardFields>
class TimeSmoothedCG final : public CG<Coordinates, BaseFunction, Fields>
{
public:
    typedef BaseFunction<Coordinates> Function;
    
    TimeSmoothedCG();
    
    TimeSmoothedCG(const TimeSmoothedCG& p) = default;
    
    virtual ~TimeSmoothedCG() = default;
    
    TimeSmoothedCG<Coordinates, BaseFunction, Fields>* copy() const override;
    
    void write(std::ostream& os) const override;
    
    void writeAll(std::ostream& os, TimeSmoothedFields<Fields>& average) const;
    
    std::string getName() const override;
    
    void initialise() override;
    
    void evaluate() override;
    
    void finish() override;
    
    void setWidthTime(Mdouble widthTime);
    
    Mdouble getWidthTime() const;
    
    void setTimeStep(Mdouble timeStep);
    
    Mdouble getTimeStep() const;
 
protected:
    
    Mdouble widthTime_;
    
    Mdouble cutoffTime_;
    
    Mdouble nextTime_;
    
    Mdouble timeStep_;
    
    std::vector<TimeSmoothedFields<Fields> > averages_;
};
 
#include "TimeSmoothedCG.hcc"
 
#endif