OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
MultipoleTCurvedConstRadius.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2017, Titus Dascalu
3 * Copyright (c) 2018, Martin Duy Tat
4 * All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * 1. Redistributions of source code must retain the above copyright notice,
8 * this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright notice,
10 * this list of conditions and the following disclaimer in the documentation
11 * and/or other materials provided with the distribution.
12 * 3. Neither the name of STFC nor the names of its contributors may be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 * POSSIBILITY OF SUCH DAMAGE.
27 */
28
29
30#ifndef CLASSIC_MULTIPOLET_CURVED_CONST_RADIUS_H
31#define CLASSIC_MULTIPOLET_CURVED_CONST_RADIUS_H
32
81#include <vector>
82
84public:
86 explicit MultipoleTCurvedConstRadius(MultipoleT* element);
88 void initialise() override;
92 const BGeometryBase& getGeometry() const override { return planarArcGeometry_m; }
94 void transformCoords(Vector_t &/*R*/) override;
96 void transformBField(Vector_t &/*B*/, const Vector_t &/*R*/) override;
101 double getScaleFactor(double x, double s) override;
108 double getFn(size_t n, double x, double s) override;
113 void setMaxOrder(size_t orderZ, size_t orderX) override;
114
116private:
118 std::vector<polynomial::RecursionRelation> recursion_m;
121};
122
123#endif
std::vector< polynomial::RecursionRelation > recursion_m
Object for storing differential operator acting on Fn.
void setMaxOrder(size_t orderZ, size_t orderX) override
Set the number of terms used in calculation of field components Maximum power of z in Bz is 2 * maxO...
Vector_t localCartesianToOpalCartesian(const Vector_t &r) override
double getFn(size_t n, double x, double s) override
Calculate fn(x, s) by expanding the differential operator (from Laplacian and scalar potential) in te...
double getScaleFactor(double x, double s) override
Returns the scale factor .
PlanarArcGeometry planarArcGeometry_m
Geometry.
const BGeometryBase & getGeometry() const override
Return the cell geometry.
MultipoleTCurvedConstRadius(MultipoleT *element)
Constructor.
BGeometryBase & getGeometry() override
Return the cell geometry.
void initialise() override
Initialise the element.
void transformBField(Vector_t &, const Vector_t &) override
Transform B-field from Frenet-Serret coordinates to lab coordinates.
void transformCoords(Vector_t &) override
Transform to Frenet-Serret coordinates for sector magnets.
Abstract base class for accelerator geometry classes.
Definition: Geometry.h:43
A simple arc in the XZ plane.