OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
MultipoleTStraight.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_STRAIGHT_H
31#define CLASSIC_MULTIPOLET_STRAIGHT_H
32
77
80#include <vector>
81
83public:
85 explicit MultipoleTStraight(MultipoleT* element);
87 void initialise() override;
91 const BGeometryBase& getGeometry() const override { return straightGeometry_m; }
93 void transformCoords(Vector_t &R) override;
95 void transformBField(Vector_t &/*B*/, const Vector_t &/*R*/) override {}
100 double getScaleFactor(double /*x*/, double /*s*/) override { return 1; }
105 double getBx (const Vector_t &R) override;
110 double getBs (const Vector_t &R) override;
117 double getFn(size_t n, double x, double s) override;
119
120private:
123};
124
125#endif
MultipoleTBase(MultipoleT *element)
double getBs(const Vector_t &R) override
void transformBField(Vector_t &, const Vector_t &) override
double getFn(size_t n, double x, double s) override
StraightGeometry straightGeometry_m
BGeometryBase & getGeometry() override
MultipoleTStraight(MultipoleT *element)
void transformCoords(Vector_t &R) override
void initialise() override
Vector_t localCartesianToOpalCartesian(const Vector_t &r) override
const BGeometryBase & getGeometry() const override
double getBx(const Vector_t &R) override
double getScaleFactor(double, double) override
Abstract base class for accelerator geometry classes.
Definition Geometry.h:43
A geometry representing a straight line.
Vektor< double, 3 > Vector_t