ParticleInteractionBase.h

Go to the documentation of this file.

//
// Class ParticleInteractionBase
//   Base class for all particle-particle interactions.
//
//   Inheriting classes need to implement solve(), which evaluates all pairwise interactions between
//   particles. These (short-range) interaction happen on the particle container and its attributes
//   and not on a field.
//
 
#ifndef IPPL_PARTICLEINTERACTIONBASE_H
#define IPPL_PARTICLEINTERACTIONBASE_H
 
#include <string>
 
#include "Utility/ParameterList.h"
 
namespace ippl {
    template <typename ParticleContainer>
    class ParticleInteractionBase {
    public:
        ParticleInteractionBase(const ParticleContainer& pc, const ParameterList& params)
            : pc_m(pc) {
            ParticleInteractionBase::setDefaultParameters();
            params_m.merge(params);
        }
 
        explicit ParticleInteractionBase(const ParticleContainer& pc)
            : pc_m(pc) {
            ParticleInteractionBase::setDefaultParameters();
        }
 
    public:
        template <typename T>
        void updateParameter(const std::string& key, const T& value) {
            params_m.update<T>(key, value);
        }

        void updateParameters(const ParameterList& params) { params_m.update(params); }

        void mergeParameters(const ParameterList& params) { params_m.merge(params); }
 
        virtual void solve() = 0;
 
        virtual ~ParticleInteractionBase() = default;
 
    protected:
        const ParticleContainer& pc_m;
        ParameterList params_m;

        virtual void setDefaultParameters() {}
 
    private:
    };
}  // namespace ippl
 
#endif  // IPPL_PARTICLEINTERACTIONBASE_H