SBend3D.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2012, Chris Rogers
 *  All rights reserved.
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *  2. Redistributions in binary form must reproduce the above copyright notice,
 *     this list of conditions and the following disclaimer in the documentation
 *     and/or other materials provided with the distribution.
 *  3. Neither the name of STFC nor the names of its contributors may be used to
 *     endorse or promote products derived from this software without specific
 *     prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 */

#include "Fields/BMultipoleField.h"
#include "Fields/SectorMagneticFieldMap.h"
#include "BeamlineGeometry/PlanarArcGeometry.h"
#include "AbsBeamline/Component.h"

#ifndef ABSBEAMLINE_SBEND3D_H
#define ABSBEAMLINE_SBEND3D_H

class SBend3D : public Component {
  public:
    explicit SBend3D(const std::string &name);

    SBend3D(const SBend3D &right);

    ~SBend3D();

    ElementBase* clone() const override;

    bool apply(const size_t &i, const double &t, Vector_t &E, Vector_t &B) override;

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

    void initialise(PartBunchBase<double, 3> *bunch, double &startField, double &endField) override;

    void finalise() override;

    inline bool bends() const override;

    void getDimensions(double &/*zBegin*/, double &/*zEnd*/) const override {}

    BGeometryBase& getGeometry() override;

    const BGeometryBase& getGeometry() const override;

    EMField &getField() override;

    const EMField &getField() const override;

    void accept(BeamlineVisitor& visitor) const override;

    void setFieldMapFileName(const std::string& name);

    inline std::string getFieldMapFileName() const;

    double getLengthUnits() const {return lengthUnits_m;}

    void setLengthUnits(double lengthUnits) {lengthUnits_m = lengthUnits;}

    double getFieldUnits() const {return fieldUnits_m;}

    void setFieldUnits(double fieldUnits) {fieldUnits_m = fieldUnits;}

    int getPolynomialOrder() const {return polyOrder_m;}

    void setPolynomialOrder(int polyOrder) {polyOrder_m = polyOrder;}

    int getSmoothingOrder() const {return smoothOrder_m;}

    void setSmoothingOrder(int polyOrder) {smoothOrder_m = polyOrder;}

    SectorMagneticFieldMap* getSectorMagneticFieldMap() const {return map_m;}

  private:
    SectorMagneticFieldMap* map_m;
    // Geometry
    PlanarArcGeometry planarArcGeometry_m;
    // Units used for field maps
    double fieldUnits_m;
    double lengthUnits_m;
    // Polynomial interpolation
    int polyOrder_m;
    double smoothOrder_m;
    // Not implemented (I think this is something to do with error fields?)
    BMultipoleField dummy;
};

std::string SBend3D::getFieldMapFileName() const {
    return map_m->getFieldMapFileName();
}

#endif