OPALX (Object Oriented Parallel Accelerator Library for Exascal)
MINIorX
OPALX
OpalTravelingWave.h
Go to the documentation of this file.
1
//
2
// Class OpalTravelingWave
3
// The TRAVELINGWAVE 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_OpalTravelingWave_HH
19
#define OPAL_OpalTravelingWave_HH
20
21
#include "
Elements/OpalElement.h
"
22
23
class
OpalTravelingWave
:
public
OpalElement
{
24
25
public
:
26
28
enum
{
29
VOLT
=
COMMON
,
// The peak voltage.
30
DVOLT
,
// The peak voltage error
31
FREQ
,
// The RF frequency.
32
LAG
,
// The phase lag.
33
DLAG
,
// The phase lag error
34
FMAPFN
,
// The filename of the fieldmap
35
APVETO
,
// Do not use this cavity in the Autophase procedure
36
FAST
,
// Faster but less accurate
37
NUMCELLS
,
// Number of cells in a TW structure
38
DESIGNENERGY
,
// The mean kinetic energy at exit
39
MODE
,
// The phase shift between cells
40
SIZE
41
};
42
44
OpalTravelingWave
();
45
46
virtual
~OpalTravelingWave
();
47
49
virtual
OpalTravelingWave
*
clone
(
const
std::string &name);
50
52
virtual
void
update
();
53
54
private
:
55
56
// Not implemented.
57
OpalTravelingWave
(
const
OpalTravelingWave
&);
58
void
operator=
(
const
OpalTravelingWave
&);
59
60
// Clone constructor.
61
OpalTravelingWave
(
const
std::string &name,
OpalTravelingWave
*parent);
62
63
};
64
65
#endif
// OPAL_OpalTravelingWave_HH
OpalElement.h
OpalElement::COMMON
@ COMMON
Definition
OpalElement.h:56
OpalElement::OpalElement
OpalElement(int size, const char *name, const char *help)
Exemplar constructor.
Definition
OpalElement.cpp:39
OpalTravelingWave
Definition
OpalTravelingWave.h:23
OpalTravelingWave::update
virtual void update()
Update the embedded CLASSIC cavity.
Definition
OpalTravelingWave.cpp:73
OpalTravelingWave::operator=
void operator=(const OpalTravelingWave &)
OpalTravelingWave::~OpalTravelingWave
virtual ~OpalTravelingWave()
Definition
OpalTravelingWave.cpp:64
OpalTravelingWave::OpalTravelingWave
OpalTravelingWave()
Exemplar constructor.
Definition
OpalTravelingWave.cpp:25
OpalTravelingWave::clone
virtual OpalTravelingWave * clone(const std::string &name)
Make clone.
Definition
OpalTravelingWave.cpp:68
OpalTravelingWave::OpalTravelingWave
OpalTravelingWave(const OpalTravelingWave &)
OpalTravelingWave::DLAG
@ DLAG
Definition
OpalTravelingWave.h:33
OpalTravelingWave::SIZE
@ SIZE
Definition
OpalTravelingWave.h:40
OpalTravelingWave::FREQ
@ FREQ
Definition
OpalTravelingWave.h:31
OpalTravelingWave::LAG
@ LAG
Definition
OpalTravelingWave.h:32
OpalTravelingWave::MODE
@ MODE
Definition
OpalTravelingWave.h:39
OpalTravelingWave::VOLT
@ VOLT
Definition
OpalTravelingWave.h:29
OpalTravelingWave::FMAPFN
@ FMAPFN
Definition
OpalTravelingWave.h:34
OpalTravelingWave::DVOLT
@ DVOLT
Definition
OpalTravelingWave.h:30
OpalTravelingWave::FAST
@ FAST
Definition
OpalTravelingWave.h:36
OpalTravelingWave::DESIGNENERGY
@ DESIGNENERGY
Definition
OpalTravelingWave.h:38
OpalTravelingWave::NUMCELLS
@ NUMCELLS
Definition
OpalTravelingWave.h:37
OpalTravelingWave::APVETO
@ APVETO
Definition
OpalTravelingWave.h:35