RingSection.h

Go to the documentation of this file.

//
// Class RingSection
//   Defines the component placement handler in ring geometry.
//
// Copyright (c) 2012 - 2023, Chris Rogers, STFC Rutherford Appleton Laboratory, Didcot, UK
// All rights reserved
//
// 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 RING_SECTION_H
#define RING_SECTION_H

#include "AbsBeamline/Component.h"

#include <cmath>
#include <vector>

class RingSection {

public:
    RingSection();

    RingSection(const RingSection& sec);

    RingSection& operator=(const RingSection& sec);

    ~RingSection();

    bool isOnOrPastStartPlane(const Vector_t& pos) const;

    bool isPastEndPlane(const Vector_t& pos) const;

    bool getFieldValue(const Vector_t& pos, const Vector_t& centroid,
                       const double& t, Vector_t& E, Vector_t& B) const;

    std::vector<Vector_t> getVirtualBoundingBox() const;

    bool doesOverlap(double phiStart, double phiEnd) const;

    inline void setComponent(Component* component) {component_m = component;}

    inline Component* getComponent() const {return component_m;}

    inline void setStartPosition(Vector_t pos) {startPosition_m = pos;}

    inline Vector_t getStartPosition() const {return startPosition_m;}

    inline void setStartNormal(Vector_t orientation);

    inline Vector_t getStartNormal() const {return startOrientation_m;}

    inline void setEndPosition(Vector_t pos) {endPosition_m = pos;}

    inline Vector_t getEndPosition() const {return endPosition_m;}

    inline void setEndNormal(Vector_t orientation);

    inline Vector_t getEndNormal() const {return endOrientation_m;}

    inline void setComponentPosition(Vector_t position) {componentPosition_m = position;}

    inline Vector_t getComponentPosition() const {return componentPosition_m;}

    inline void setComponentOrientation(Vector_t orientation);

    inline Vector_t getComponentOrientation() const {return componentOrientation_m;}

    void handleOffset();

private:
    void rotate(Vector_t& vector) const;
    void rotate_back(Vector_t& vector) const;
    inline Vector_t& normalise(Vector_t& vector) const;
    inline void rotateToTCoordinates(Vector_t& vec) const;
    inline void rotateToCyclCoordinates(Vector_t& vec) const;

    Component* component_m;

    Vector_t componentPosition_m;
    Vector_t componentOrientation_m;

    Vector_t startPosition_m;
    Vector_t startOrientation_m;

    Vector_t endPosition_m;
    Vector_t endOrientation_m;

    void updateComponentOrientation();
    double sin2_m;
    double cos2_m;
};

typedef std::vector<RingSection*> RingSectionList;

inline void RingSection::setComponentOrientation(Vector_t orientation) {
    componentOrientation_m = orientation;
    updateComponentOrientation();
}

inline void RingSection::setStartNormal(Vector_t orientation) {
    startOrientation_m = normalise(orientation);
}

inline void RingSection::setEndNormal(Vector_t orientation) {
    endOrientation_m = normalise(orientation);
}

inline Vector_t& RingSection::normalise(Vector_t& orientation) const {
    double magnitude = std::sqrt(orientation(0) * orientation(0) +
                                 orientation(1) * orientation(1) +
                                 orientation(2) * orientation(2));
    if (magnitude > 0.) {
        orientation /= magnitude;
    }
    return orientation;
}


void RingSection::rotateToTCoordinates(Vector_t& vec) const {
  vec = Vector_t(vec(1), vec(2), vec(0));
}

void RingSection::rotateToCyclCoordinates(Vector_t& vec) const {
  vec = Vector_t(vec(2), vec(0), vec(1));
}

#endif //RING_SECTION_H