PyRingDefinition.cpp

Go to the documentation of this file.

//
// Python API for OpalRingDefinition
//
// Copyright (c) 2022 - 2023, Chris Rogers, STFC Rutherford Appleton Laboratory, Didcot, UK
//
// 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 "PyOpal/PyCore/ExceptionTranslation.h"
#include "PyOpal/PyCore/Globals.h"
#include "PyOpal/PyCore/PyOpalObject.h"

#include "AbsBeamline/Ring.h" // classic
#include "Elements/OpalRingDefinition.h"
#include "Physics/Units.h" // classic
#include "Utilities/RingSection.h" // classic


//using namespace boost::python;
namespace PyOpal {
namespace PyRingDefinition {

std::string ring_definition_docstring = std::string();

const char* module_docstring = 
"ring_definition module contains the RingDefinition class";

template <>
std::string PyOpalObjectNS::PyOpalObject<OpalRingDefinition>::classDocstring =
"RingDefinition class enables definition of the global ring parameters\n"
"\n"
"RingDefinition holds definitions of the global ring parameters like the\n"
"position of the first lattice element and position of the beam.\n"
"Internally, the RingDefinition handles placement of OPAL objects. Once they\n"
"have been placed, (e.g. Track has been executed), it is possible to\n"
"interrogate the RingDefinition to find what are the element positions as\n"
"placed by PyOpal, for debugging purposes.\n"
"\n"
"See also pyopal.objects.line.Line class, which handles the sequential\n"
"element placements.\n\n";

template <>
std::vector<PyOpalObjectNS::AttributeDef> PyOpalObjectNS::PyOpalObject<OpalRingDefinition>::attributes = {
    {"LAT_RINIT", "lattice_initial_r", "", PyOpalObjectNS::DOUBLE},
    {"LAT_PHIINIT", "lattice_initial_phi", "", PyOpalObjectNS::DOUBLE},
    {"LAT_THETAINIT", "lattice_initial_theta", "", PyOpalObjectNS::DOUBLE},
    {"BEAM_RINIT", "beam_initial_r", "", PyOpalObjectNS::DOUBLE},
    {"BEAM_PHIINIT", "beam_initial_phi", "", PyOpalObjectNS::DOUBLE},
    {"BEAM_THETAINIT", "beam_initial_theta", "", PyOpalObjectNS::DOUBLE},
    {"BEAM_PRINIT", "beam_initial_pr", "", PyOpalObjectNS::DOUBLE},
    {"HARMONIC_NUMBER", "harmonic_number", "", PyOpalObjectNS::DOUBLE},
    {"SYMMETRY", "symmetry", "", PyOpalObjectNS::INT},
    {"SCALE", "scale", "", PyOpalObjectNS::DOUBLE},
    {"RFFREQ", "rf_frequency", "", PyOpalObjectNS::DOUBLE},
    {"IS_CLOSED", "is_closed", "", PyOpalObjectNS::BOOL}, // BUG in underlying code
    {"MIN_R", "minimum_r", "", PyOpalObjectNS::DOUBLE},
    {"MAX_R", "maximum_r", "", PyOpalObjectNS::DOUBLE},
};

BOOST_PYTHON_MODULE(ring_definition) {
    PyOpal::Globals::Initialise();
    ExceptionTranslation::registerExceptions();
    PyOpalObjectNS::PyOpalObject<OpalRingDefinition> element;
    auto elementClass = element.make_element_class("RingDefinition");
    element.addGetFieldValue(elementClass, 1.0, 1.0, 1.0, 1e-1);
}

}
}