TimeSmoothedCG.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 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) final;
    
    Mdouble getWidthTime() const final;
    
    void setTimeStep(Mdouble timeStep) final;
    
    Mdouble getTimeStep() const final;
 
protected:
    
    Mdouble widthTime_;
    
    Mdouble cutoffTime_;
    
    Mdouble nextTime_;
    
    Mdouble timeStep_;
    
    std::vector<TimeSmoothedFields<Fields> > averages_;
};
 
#include "TimeSmoothedCG.hcc"
 
#endif