CCollimator.h

Go to the documentation of this file.

//
// Class CCollimator
//   Interface for cyclotron collimator
//
// Copyright (c) 2018-2022, 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_CCollimator_HH
#define CLASSIC_CCollimator_HH
 
#include "AbsBeamline/PluginElement.h"
 
class ParticleMatterInteractionHandler;
 
class CCollimator: public PluginElement {
 
public:
    explicit CCollimator(const std::string& name);
 
    CCollimator();
    CCollimator(const CCollimator& rhs);
    void operator=(const CCollimator&) = delete;
    virtual ~CCollimator();
 
    virtual void accept(BeamlineVisitor&) const override;
    virtual void goOnline(const double& kineticEnergy) override;
    virtual ElementType getType() const override;
    virtual void getDimensions(double& zBegin, double& zEnd) const override;
 
    // bool checkCollimator(Vector_t r, Vector_t rmin, Vector_t rmax);
 
    void print();
 
    void setDimensions(double xstart, double xend,
                       double ystart, double yend,
                       double zstart, double zend,
                       double width);
    using PluginElement::setDimensions;
 
    double getZStart() ;
    double getZEnd() ;
    double getWidth() ;
private:
    virtual void doInitialise(PartBunchBase<double, 3>* bunch) override;
    virtual bool doCheck(PartBunchBase<double, 3>* bunch, const int turnnumber, const double t, const double tstep) override;
    virtual void doSetGeom() override;
    virtual void doFinalise() override;
    virtual bool doPreCheck(PartBunchBase<double, 3>*) override;
    virtual bool doFinaliseCheck(PartBunchBase<double, 3>* bunch, bool flagNeedUpdate) override;
 
    bool informed_m = false; 
 
    double zstart_m;
    double zend_m;
    double width_m;
    double rmax_m; 
 
    ParticleMatterInteractionHandler* parmatint_m = nullptr;
};
 
inline
double CCollimator::getZStart() {
    return zstart_m;
}
 
inline
double CCollimator::getZEnd() {
    return zend_m;
}
 
inline
double CCollimator::getWidth() {
    return width_m;
}
#endif // CLASSIC_CCollimator_HH