MultipoleTBase.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2017, Titus Dascalu
 *  Copyright (c) 2018, Martin Duy Tat
 *  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.
 */
 
 
#ifndef CLASSIC_MULTIPOLETBASE_H
#define CLASSIC_MULTIPOLETBASE_H

 
#include "Algorithms/Vektor.h"
class MultipoleT;
class BeamlineVisitor;
class BGeometryBase;
 
// Base class for the implementation part of the MultipoleT magnet element
class MultipoleTBase {
public:
    explicit MultipoleTBase(MultipoleT* element);
    virtual ~MultipoleTBase() = default;
protected:
    MultipoleT* element_m;
public:
    virtual void initialise() = 0;
    virtual BGeometryBase& getGeometry() = 0;
    virtual const BGeometryBase& getGeometry() const = 0;
    virtual void transformCoords(Vector_t &R) = 0;
    virtual void transformBField(Vector_t &B, const Vector_t &R) = 0;
    virtual double getScaleFactor(double x, double s) = 0;
    virtual double getBx (const Vector_t &R);
    double getBz (const Vector_t &R);
    virtual double getBs (const Vector_t &R);
    virtual double getFn(size_t n, double x, double s) = 0;
    virtual void setMaxOrder(size_t /*orderZ*/, size_t /*orderX*/) {}
    virtual Vector_t localCartesianToOpalCartesian(const Vector_t& r) = 0;
    virtual double localCartesianRotation() { return 0.0; }
};
 
#endif