PluginElement.h

Go to the documentation of this file.

//
// Class PluginElement
//   Abstract Interface for (Cyclotron) Plugin Elements (CCollimator, Probe, Stripper, Septum)
//   Implementation via Non-Virtual Interface Template Method
//
// Copyright (c) 2018-2020, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// This file is part of OPAL.
//
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef CLASSIC_PluginElement_HH
#define CLASSIC_PluginElement_HH

#include "AbsBeamline/Component.h"
#include <string>
#include <memory>

template <class T, unsigned Dim>
class PartBunchBase;

class LossDataSink;
class PluginElement: public Component {

public:
    explicit PluginElement(const std::string &name);

    PluginElement();
    PluginElement(const PluginElement &);
    void operator=(const PluginElement &) = delete;
    virtual ~PluginElement();

    virtual void initialise(PartBunchBase<double, 3> *bunch, double &startField, double &endField) override; // not used?
    void initialise(PartBunchBase<double, 3> *bunch); // replacement for virtual initialise
    virtual void finalise()  final; // final since virtual hook doFinalise
    virtual void goOffline() final; // final since virtual hook doGoOffline
    virtual bool bends() const override;
    virtual void getDimensions(double &zBegin, double &zEnd) const override;
    virtual bool apply(const size_t &i,
                       const double &t,
                       Vector_t &E,
                       Vector_t &B) override;

    virtual bool applyToReferenceParticle(const Vector_t &R,
                                          const Vector_t &P,
                                          const double &t,
                                          Vector_t &E,
                                          Vector_t &B) override;

    void setDimensions(double xstart, double xend, double ystart, double yend);

    double getXStart() const;
    double getXEnd()   const;
    double getYStart() const;
    double getYEnd()   const;
    bool check(PartBunchBase<double, 3> *bunch, const int turnnumber, const double t, const double tstep);
    int  checkPoint(const double & x, const double & y) const;
    void save();

protected:
    void setGeom(const double dist);
    void changeWidth(PartBunchBase<double, 3> *bunch, int i, const double tstep, const double tangle);
    double calculateIncidentAngle(double xp, double yp) const;

private:
    bool preCheck(PartBunchBase<double, 3> *bunch) {return doPreCheck(bunch);}
    bool finaliseCheck(PartBunchBase<double, 3> *bunch, bool flagNeedUpdate) {return doFinaliseCheck(bunch, flagNeedUpdate);}
    virtual void doInitialise(PartBunchBase<double, 3>* /*bunch*/) {}
    virtual bool doCheck(PartBunchBase<double, 3> *bunch, const int turnnumber, const double t, const double tstep) = 0;
    virtual void doSetGeom() {};
    virtual bool doPreCheck(PartBunchBase<double, 3>*) {return true;}
    virtual bool doFinaliseCheck(PartBunchBase<double, 3> *, bool flagNeedUpdate) {return flagNeedUpdate;}
    virtual void doFinalise() {};
    virtual void doGoOffline() {};

protected:
    /* Members */
    double xstart_m;
    double xend_m;
    double ystart_m;
    double yend_m;
    double rstart_m;
    double rend_m;
    double rmin_m;    
    Point  geom_m[5]; 
    double A_m, B_m, R_m, C_m; 

    std::unique_ptr<LossDataSink> lossDs_m;   
    int numPassages_m = 0; 
};

#endif // CLASSIC_PluginElement_HH