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<double, 3>& pos) const;
 
    bool isPastEndPlane(const Vector_t<double, 3>& pos) const;
 
    bool getFieldValue(
            const Vector_t<double, 3>& pos, const Vector_t<double, 3>& centroid, const double& t,
            Vector_t<double, 3>& E, Vector_t<double, 3>& B) const;
 
    std::vector<Vector_t<double, 3>> 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<double, 3> pos) { startPosition_m = pos; }
 
    inline Vector_t<double, 3> getStartPosition() const { return startPosition_m; }
 
    inline void setStartNormal(Vector_t<double, 3> orientation);
 
    inline Vector_t<double, 3> getStartNormal() const { return startOrientation_m; }
 
    inline void setEndPosition(Vector_t<double, 3> pos) { endPosition_m = pos; }
 
    inline Vector_t<double, 3> getEndPosition() const { return endPosition_m; }
 
    inline void setEndNormal(Vector_t<double, 3> orientation);
 
    inline Vector_t<double, 3> getEndNormal() const { return endOrientation_m; }
 
    inline void setComponentPosition(Vector_t<double, 3> position) {
        componentPosition_m = position;
    }
 
    inline Vector_t<double, 3> getComponentPosition() const { return componentPosition_m; }
 
    inline void setComponentOrientation(Vector_t<double, 3> orientation);
 
    inline Vector_t<double, 3> getComponentOrientation() const { return componentOrientation_m; }
 
private:
    void rotate(Vector_t<double, 3>& vector) const;
    void rotate_back(Vector_t<double, 3>& vector) const;
    inline Vector_t<double, 3>& normalise(Vector_t<double, 3>& vector) const;
    inline void rotateToTCoordinates(Vector_t<double, 3>& vec) const;
    inline void rotateToCyclCoordinates(Vector_t<double, 3>& vec) const;
 
    Component* component_m;
 
    Vector_t<double, 3> componentPosition_m;
    Vector_t<double, 3> componentOrientation_m;
 
    Vector_t<double, 3> startPosition_m;
    Vector_t<double, 3> startOrientation_m;
 
    Vector_t<double, 3> endPosition_m;
    Vector_t<double, 3> endOrientation_m;
 
    void updateComponentOrientation();
    double sin2_m;
    double cos2_m;
};
 
typedef std::vector<RingSection*> RingSectionList;
 
inline void RingSection::setComponentOrientation(Vector_t<double, 3> orientation) {
    componentOrientation_m = orientation;
    updateComponentOrientation();
}
 
inline void RingSection::setStartNormal(Vector_t<double, 3> orientation) {
    startOrientation_m = normalise(orientation);
}
 
inline void RingSection::setEndNormal(Vector_t<double, 3> orientation) {
    endOrientation_m = normalise(orientation);
}
 
inline Vector_t<double, 3>& RingSection::normalise(Vector_t<double, 3>& orientation) const {
    double magnitude =
            sqrt(orientation(0) * orientation(0) + orientation(1) * orientation(1)
                 + orientation(2) * orientation(2));
    if (magnitude > 0.) orientation = orientation / magnitude;
    return orientation;
}
 
void RingSection::rotateToTCoordinates(Vector_t<double, 3>& vec) const {
    vec = Vector_t<double, 3>({vec(1), vec(2), vec(0)});
}
 
void RingSection::rotateToCyclCoordinates(Vector_t<double, 3>& vec) const {
    vec = Vector_t<double, 3>({vec(2), vec(0), vec(1)});
}
 
#endif  // RING_SECTION_H