RingSection.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2012-2014, 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.
 */

#ifndef RING_SECTION_H
#define RING_SECTION_H

#include <vector>

#include "AbsBeamline/Component.h"

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;}
  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 = 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