ElementBase.cpp

Go to the documentation of this file.

//
// Class ElementBase
//   The very base class for beam line representation objects. A beam line
//   is modelled as a composite structure having a single root object
//   (the top level beam line), which contains both ``single'' leaf-type
//   elements (Components), as well as sub-lines (composites).
//
//   Interface for basic beam line object.
//   This class defines the abstract interface for all objects which can be
//   contained in a beam line. ElementBase forms the base class for two distinct
//   but related hierarchies of objects:
//   [OL]
//   [LI]
//   A set of concrete accelerator element classes, which compose the standard
//   accelerator component library (SACL).
//   [LI]
//   [/OL]
//   Instances of the concrete classes for single elements are by default
//   sharable. Instances of beam lines and integrators are by
//   default non-sharable, but they may be made sharable by a call to
//   [b]makeSharable()[/b].
//   [p]
//   An ElementBase object can return two lengths, which may be different:
//   [OL]
//   [LI]
//   The arc length along the geometry.
//   [LI]
//   The design length, often measured along a straight line.
//   [/OL]
//   Class ElementBase contains a map of name versus value for user-defined
//   attributes (see file AbsBeamline/AttributeSet.hh). The map is primarily
//   intended for processes that require algorithm-specific data in the
//   accelerator model.
//   [P]
//   The class ElementBase has as base class the abstract class RCObject.
//   Virtual derivation is used to make multiple inheritance possible for
//   derived concrete classes. ElementBase implements three copy modes:
//   [OL]
//   [LI]
//   Copy by reference: Call RCObject::addReference() and use [b]this[/b].
//   [LI]
//   Copy structure: use ElementBase::copyStructure().
//   During copying of the structure, all sharable items are re-used, while
//   all non-sharable ones are cloned.
//   [LI]
//   Copy by cloning: use ElementBase::clone().
//   This returns a full deep copy.
//   [/OL]
//
// Copyright (c) 200x - 2021, Paul Scherrer Institut, Villigen PSI, Switzerland
// 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/>.
//
#include "AbsBeamline/ElementBase.h"

#include "Channels/Channel.h"
#include "Solvers/ParticleMatterInteractionHandler.h"
#include "Solvers/WakeFunction.h"
#include "Structure/BoundaryGeometry.h"
#include <filesystem>

const std::map<ElementType, std::string> ElementBase::elementTypeToString_s = {
    {ElementType::ANY,                "Any"},
    {ElementType::BEAMLINE,           "Beamline"},
    {ElementType::CCOLLIMATOR,        "CCollimator"},
    {ElementType::CORRECTOR,          "Corrector"},
    {ElementType::CYCLOTRON,          "Cyclotron"},
    {ElementType::DEGRADER,           "Degrader"},
    {ElementType::DRIFT,              "Drift"},
    {ElementType::FLEXIBLECOLLIMATOR, "FlexibleCollimator"},
    {ElementType::MARKER,             "Marker"},
    {ElementType::MONITOR,            "Monitor"},
    {ElementType::MPSPLITINTEGRATOR,  "MPSplitIntegrator"},
    {ElementType::MULTIPOLE,          "Multipole"},
    {ElementType::MULTIPOLET,         "MultipoleT"},
    {ElementType::OFFSET,             "Offset"},
    {ElementType::OUTPUTPLANE,        "OutputPlane"},
    {ElementType::PROBE,              "Probe"},
    {ElementType::RBEND,              "RBend"},
    {ElementType::RBEND3D,            "RBend3D"},
    {ElementType::RFCAVITY,           "RFCavity"},
    {ElementType::RING,               "Ring"},
    {ElementType::SBEND,              "SBend"},
    {ElementType::SBEND3D,            "SBend3D"},
    {ElementType::SEPTUM,             "Septum"},
    {ElementType::SOLENOID,           "Solenoid"},
    {ElementType::SOURCE,             "Source"},
    {ElementType::STRIPPER,           "Stripper"},
    {ElementType::TRAVELINGWAVE,      "TravelingWave"},
    {ElementType::UNDULATOR,          "Undulator"},
    {ElementType::VACUUM,             "Vacuum"},
    {ElementType::VARIABLERFCAVITY,   "VariableRFCavity"}
};

ElementBase::ElementBase():
    ElementBase("")
{}


ElementBase::ElementBase(const ElementBase &right):
    RCObject(),
    shareFlag(true),
    csTrafoGlobal2Local_m(right.csTrafoGlobal2Local_m),
    misalignment_m(right.misalignment_m),
    aperture_m(right.aperture_m),
    elementEdge_m(right.elementEdge_m),
    rotationZAxis_m(right.rotationZAxis_m),
    elementID(right.elementID),
    userAttribs(right.userAttribs),
    wake_m(right.wake_m),
    bgeometry_m(right.bgeometry_m),
    parmatint_m(right.parmatint_m),
    positionIsFixed(right.positionIsFixed),
    elementPosition_m(right.elementPosition_m),
    elemedgeSet_m(right.elemedgeSet_m),
    outputfn_m(right.outputfn_m),
    deleteOnTransverseExit_m(right.deleteOnTransverseExit_m)
{

    if (parmatint_m) {
        parmatint_m->updateElement(this);
    }
    if (bgeometry_m) {
        bgeometry_m->updateElement(this);
    }
}


ElementBase::ElementBase(const std::string &name):
    RCObject(),
    shareFlag(true),
    csTrafoGlobal2Local_m(),
    misalignment_m(),
    elementEdge_m(0),
    rotationZAxis_m(0.0),
    elementID(name),
    userAttribs(),
    wake_m(nullptr),
    bgeometry_m(nullptr),
    parmatint_m(nullptr),
    positionIsFixed(false),
    elementPosition_m(0.0),
    elemedgeSet_m(false),
    outputfn_m("")
{}


ElementBase::~ElementBase()

{}


const std::string &ElementBase::getName() const {
    return elementID;
}


void ElementBase::setName(const std::string &name) {
    elementID = name;
}


void ElementBase::setOutputFN(const std::string fn) {
    outputfn_m = fn;
}


std::string ElementBase::getOutputFN() const {
    if (outputfn_m.empty()) {
        return getName();
    } else {
        std::filesystem::path filePath(outputfn_m);
        return filePath.replace_extension().native();
    }
}


double ElementBase::getAttribute(const std::string &aKey) const {
    const ConstChannel *aChannel = getConstChannel(aKey);

    if (aChannel != nullptr) {
        double val = *aChannel;
        delete aChannel;
        return val;
    } else {
        return 0.0;
    }
}


bool ElementBase::hasAttribute(const std::string &aKey) const {
    const ConstChannel *aChannel = getConstChannel(aKey);

    if (aChannel != nullptr) {
        delete aChannel;
        return true;
    } else {
        return false;
    }
}


void ElementBase::removeAttribute(const std::string &aKey) {
    userAttribs.removeAttribute(aKey);
}


void ElementBase::setAttribute(const std::string &aKey, double val) {
    Channel *aChannel = getChannel(aKey, true);

    if (aChannel != nullptr  &&  aChannel->isSettable()) {
        *aChannel = val;
        delete aChannel;
    } else
        std::cout << "Channel nullptr or not Settable" << std::endl;
}


Channel *ElementBase::getChannel(const std::string &aKey, bool create) {
    return userAttribs.getChannel(aKey, create);
}


const ConstChannel *ElementBase::getConstChannel(const std::string &aKey) const {
    // Use const_cast to allow calling the non-const method GetChannel().
    // The const return value of this method will nevertheless inhibit set().
    return const_cast<ElementBase *>(this)->getChannel(aKey);
}


std::string ElementBase::getTypeString(ElementType type) {
    return elementTypeToString_s.at(type);
}

ElementBase *ElementBase::copyStructure() {
    if (isSharable()) {
        return this;
    } else {
        return clone();
    }
}


void ElementBase::makeSharable() {
    shareFlag = true;
}


bool ElementBase::update(const AttributeSet &set) {
    for (AttributeSet::const_iterator i = set.begin(); i != set.end(); ++i) {
        setAttribute(i->first, i->second);
    }

    return true;
}

void ElementBase::setWake(WakeFunction *wk) {
    wake_m = wk;//->clone(getName() + std::string("_wake")); }
}

void ElementBase::setBoundaryGeometry(BoundaryGeometry *geo) {
    bgeometry_m = geo;//->clone(getName() + std::string("_wake")); }
}

void ElementBase::setParticleMatterInteraction(ParticleMatterInteractionHandler *parmatint) {
    parmatint_m = parmatint;
}

void ElementBase::setCurrentSCoordinate(double s) {
    if (!actionRange_m.empty() && actionRange_m.front().second < s) {
        actionRange_m.pop();
        if (!actionRange_m.empty()) {
            elementEdge_m = actionRange_m.front().first;
        }
    }
}

bool ElementBase::isInsideTransverse(const Vector_t &r) const
{
    const double &xLimit = aperture_m.second[0];
    const double &yLimit = aperture_m.second[1];
    double factor = 1.0;
    if (aperture_m.first == ApertureType::CONIC_RECTANGULAR ||
        aperture_m.first == ApertureType::CONIC_ELLIPTICAL) {
        Vector_t rRelativeToBegin = getEdgeToBegin().transformTo(r);
        double fractionLength = rRelativeToBegin(2) / getElementLength();
        factor = fractionLength * aperture_m.second[2];
    }

    switch(aperture_m.first) {
    case ApertureType::RECTANGULAR:
        return (std::abs(r[0]) < xLimit && std::abs(r[1]) < yLimit);
    case ApertureType::ELLIPTICAL:
        return (std::pow(r[0] / xLimit, 2) + std::pow(r[1] / yLimit, 2) < 1.0);
    case ApertureType::CONIC_RECTANGULAR:
        return (std::abs(r[0]) < factor * xLimit && std::abs(r[1]) < factor * yLimit);
    case ApertureType::CONIC_ELLIPTICAL:
        return (std::pow(r[0] / (factor * xLimit), 2) + std::pow(r[1] / (factor * yLimit), 2) < 1.0);
    default:
        return false;
    }
}

BoundingBox ElementBase::getBoundingBoxInLabCoords() const {
    CoordinateSystemTrafo toBegin = getEdgeToBegin() * csTrafoGlobal2Local_m;
    CoordinateSystemTrafo toEnd = getEdgeToEnd() * csTrafoGlobal2Local_m;

    const double &x = aperture_m.second[0];
    const double &y = aperture_m.second[1];
    const double &f = aperture_m.second[2];

    std::vector<Vector_t> corners(8);
    for (int i = -1; i < 2; i += 2) {
        for (int j = -1; j < 2; j += 2) {
            unsigned int idx = (i + 1)/2 + (j + 1);
            corners[idx] = toBegin.transformFrom(Vector_t(i * x, j * y, 0.0));
            corners[idx + 4] = toEnd.transformFrom(Vector_t(i * f * x, j * f * y, 0.0));
        }
    }

    return BoundingBox::getBoundingBox(corners);
}