OpalTrimCoil.h

Go to the documentation of this file.

//
// Class OpalTrimCoil
//   A TRIMCOIL definition is used to define a trim coil which can be applied
//   to a Cyclotron.
//
// Copyright (c) 2018 - 2019, Matthias Frey and Jochem Snuverink,
//                            Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
//
// Implemented as part of the PhD thesis
// "Precise Simulations of Multibunches in High Intensity Cyclotrons"
// and the paper
// "Matching of turn pattern measurements for cyclotrons using multiobjective optimization"
// (https://doi.org/10.1103/PhysRevAccelBeams.22.064602)
//
// 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 OPAL_TRIM_COIL_H
#define OPAL_TRIM_COIL_H

#include "AbstractObjects/Definition.h"

#include <memory>
#include <string>

class Attribute;
class Inform;
class TrimCoil;

class OpalTrimCoil: public Definition {

public:
    OpalTrimCoil();

    virtual ~OpalTrimCoil();

    //  Can replace only by another OpalTrimCoil
    virtual bool canReplaceBy(Object* object);

    virtual OpalTrimCoil* clone(const std::string& name);

    virtual void execute();

    static OpalTrimCoil* find(const std::string& name);

    virtual void update();

    using Definition::print;
    Inform& print(Inform& os) const;

    void initOpalTrimCoil();

    std::unique_ptr<TrimCoil> trimcoil_m;

private:
    enum class TrimCoilType: unsigned short {
        BFIELD,
        PHASE,
        BFIELDMIRRORED
    };

    OpalTrimCoil  (const OpalTrimCoil&) = delete;
    void operator=(const OpalTrimCoil&) = delete;
    OpalTrimCoil(const std::string &name, OpalTrimCoil* parent);

    void printPolynom(Inform& os, const Attribute& attr) const;

    TrimCoilType getTrimCoilType() const;
};

inline Inform& operator<<(Inform& os, const OpalTrimCoil& b) {
    return b.print(os);
}

#endif // OPAL_TRIM_COIL_H