OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
OpalMultipole.h
Go to the documentation of this file.
1 //
2 // Class OpalMultipole
3 // The MULTIPOLE element.
4 //
5 // Copyright (c) 200x - 2020, Paul Scherrer Institut, Villigen PSI, Switzerland
6 // All rights reserved
7 //
8 // This file is part of OPAL.
9 //
10 // OPAL is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with OPAL. If not, see <https://www.gnu.org/licenses/>.
17 //
18 #ifndef OPAL_OpalMultipole_HH
19 #define OPAL_OpalMultipole_HH
20 
21 #include "Elements/OpalElement.h"
22 
23 
24 class OpalMultipole: public OpalElement {
25 
26 public:
27 
29  enum {
30  KN = COMMON, // The normal field components.
31  DKN, // The normal field component errors.
32  KS, // The skewed field components.
33  DKS, // The skewed field component errors.
34  SIZE
35  };
36 
38  OpalMultipole();
39 
40  virtual ~OpalMultipole();
41 
43  virtual OpalMultipole *clone(const std::string &name);
44 
46  // Handle printing in OPAL-8 format.
47  virtual void print(std::ostream &) const;
48 
50  virtual void update();
51 
52 private:
53 
54  // Not implemented.
56  void operator=(const OpalMultipole &);
57 
58  // Clone constructor.
59  OpalMultipole(const std::string &name, OpalMultipole *parent);
60 };
61 
62 #endif // OPAL_OpalMultipole_HH
const std::string name
OpalMultipole(const OpalMultipole &)
virtual ~OpalMultipole()
virtual OpalMultipole * clone(const std::string &name)
Make clone.
virtual void print(std::ostream &) const
Print the object.
void operator=(const OpalMultipole &)
virtual void update()
Update the embedded CLASSIC multipole.
OpalMultipole()
Exemplar constructor.