Stripper.h

Go to the documentation of this file.

//
// Class Stripper
//   The Stripper element defines the interface for a stripping foil
//
// Copyright (c) 2011, Jianjun Yang, Paul Scherrer Institut, Villigen PSI, Switzerland
// Copyright (c) 2017-2019, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Beam dynamics in high intensity cyclotrons including neighboring bunch effects"
// and the paper
// "Beam dynamics in high intensity cyclotrons including neighboring bunch effects:
// Model, implementation, and application"
// (https://journals.aps.org/prab/pdf/10.1103/PhysRevSTAB.13.064201)
//
// 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_Stripper_HH
#define CLASSIC_Stripper_HH

#include "AbsBeamline/PluginElement.h"

class Stripper: public PluginElement {

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

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

    virtual void accept(BeamlineVisitor &) const override;
    virtual ElementType getType() const override;

    void   setOPCharge(double charge);
    double getOPCharge() const;
    void   setOPMass(double mass);
    double getOPMass() const;
    void   setOPYield(double yield);
    double getOPYield() const;
    void   setStop(bool stopflag);
    bool   getStop() const;

    virtual int getRequiredNumberOfTimeSteps() const override;

private:
    virtual bool doCheck(PartBunchBase<double, 3> *bunch, const int turnnumber, const double t, const double tstep) override;
    virtual void doFinalise() override;
    virtual bool doPreCheck(PartBunchBase<double, 3>*) override;
    virtual bool doFinaliseCheck(PartBunchBase<double, 3> *bunch, bool flagNeedUpdate) override;

    double opcharge_m; 
    double opmass_m;   
    double opyield_m;  
    bool   stop_m;     
};

inline
int Stripper::getRequiredNumberOfTimeSteps() const
{
    return 1;
}

#endif // CLASSIC_Stripper_HH