Solenoid.h

Go to the documentation of this file.

#ifndef OPALX_Solenoid_HH
#define OPALX_Solenoid_HH
 
// ------------------------------------------------------------------------
// $RCSfile: Solenoid.h,v $
// ------------------------------------------------------------------------
// $Revision: 1.1.1.1 $
// ------------------------------------------------------------------------
// Copyright: see Copyright.readme
// ------------------------------------------------------------------------
//
// Class: Solenoid
//   Defines the abstract interface for a solenoid magnet.
//
// ------------------------------------------------------------------------
// Class category: AbsBeamline
// ------------------------------------------------------------------------
//
// $Date: 20.1.2026 $
// $Author: PSI $
//
// ------------------------------------------------------------------------
 
#include "AbsBeamline/Component.h"
#include "Algorithms/CoordinateSystemTrafo.h"
 
class Fieldmap;
 
class Solenoid : public Component {
public:
    /* ============================== Constructors ============================== */
    explicit Solenoid(const std::string& name);
    Solenoid();
    Solenoid(const Solenoid&);
    virtual ~Solenoid();
    /* ========================================================================== */
    /* ============================== Apply Functions =========================== */
    virtual bool apply(const std::shared_ptr<ParticleContainer_t>& pc) override;
 
    virtual bool apply(
            const size_t& i, const double& t, Vector_t<double, 3>& E,
            Vector_t<double, 3>& B) override;
 
    virtual bool apply(
            const Vector_t<double, 3>& R, const Vector_t<double, 3>& P, const double& t,
            Vector_t<double, 3>& E, Vector_t<double, 3>& B) override;
 
    virtual bool applyToReferenceParticle(
            const Vector_t<double, 3>& R, const Vector_t<double, 3>& P, const double& t,
            Vector_t<double, 3>& E, Vector_t<double, 3>& B) override;
    /* ========================================================================== */
    /* ============================== Functions ================================= */
    virtual void accept(BeamlineVisitor&) const override;
 
    virtual double getBz() const = 0;
 
    void setKS(double ks);
 
    void setDKS(double ks);
 
    virtual void initialise(PartBunch_t* bunch, double& startField, double& endField) override;
 
    virtual void finalise() override;
 
    virtual bool bends() const override;
 
    virtual void goOnline(const double& kineticEnergy) override;
 
    virtual void goOffline() override;
 
    void setFieldMapFN(std::string fn);
 
    void setFast(bool fast);
 
    bool getFast() const;
 
    virtual ElementType getType() const override;
 
    virtual void getFieldExtend(double& zBegin, double& zEnd) const override;
 
    virtual void getElementDimensions(double& zBegin, double& zEnd) const override;
 
    bool getSupportEnvelope(double& horizontalRadius, double& verticalRadius) const;
 
    virtual bool isInside(const Vector_t<double, 3>& r) const override;
 
    virtual CoordinateSystemTrafo getEdgeToBegin() const override;
 
    virtual CoordinateSystemTrafo getEdgeToEnd() const override;
 
private:
    /* ========================================================================== */
    /* ============================== Variables ================================= */
 
    std::string filename_m;
 
    Fieldmap* fieldmap_m;
 
    double scale_m;
 
    double scaleError_m;
 
    double startField_m;
 
    double endField_m;
 
    bool fast_m;
 
    void operator=(const Solenoid&);
};
 
inline CoordinateSystemTrafo Solenoid::getEdgeToBegin() const {
    CoordinateSystemTrafo ret(Vector_t<double, 3>(0, 0, 0), Quaternion(1, 0, 0, 0));
    return ret;
}
 
inline CoordinateSystemTrafo Solenoid::getEdgeToEnd() const {
    CoordinateSystemTrafo ret(
            Vector_t<double, 3>(0, 0, getElementLength()), Quaternion(1, 0, 0, 0));
    return ret;
}
#endif  // OPALX_Solenoid_HH