convergence.hpp
Go to the documentation of this file.
1 
5 /* Copyright (c) 2011 Taneli Kalvas. All rights reserved.
6  *
7  * You can redistribute this software and/or modify it under the terms
8  * of the GNU General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * This library is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this library (file "COPYING" included in the package);
19  * if not, write to the Free Software Foundation, Inc., 51 Franklin
20  * Street, Fifth Floor, Boston, MA 02110-1301 USA
21  *
22  * If you have questions about your rights to use or distribute this
23  * software, please contact Berkeley Lab's Technology Transfer
24  * Department at TTD@lbl.gov. Other questions, comments and bug
25  * reports should be sent directly to the author via email at
26  * taneli.kalvas@jyu.fi.
27  *
28  * NOTICE. This software was developed under partial funding from the
29  * U.S. Department of Energy. As such, the U.S. Government has been
30  * granted for itself and others acting on its behalf a paid-up,
31  * nonexclusive, irrevocable, worldwide license in the Software to
32  * reproduce, prepare derivative works, and perform publicly and
33  * display publicly. Beginning five (5) years after the date
34  * permission to assert copyright is obtained from the U.S. Department
35  * of Energy, and subject to any subsequent five (5) year renewals,
36  * the U.S. Government is granted for itself and others acting on its
37  * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
38  * the Software to reproduce, prepare derivative works, distribute
39  * copies to the public, perform publicly and display publicly, and to
40  * permit others to do so.
41  */
42 
43 #ifndef CONVERGENCE_HPP
44 #define CONVERGENCE_HPP 1
45 
46 
47 #include <iostream>
48 #include <stdint.h>
49 #include <vector>
50 #include "scalarfield.hpp"
52 #include "particledatabase.hpp"
53 
54 
57 class Convergence {
58 
59  int32_t _iter;
61  std::vector<double> _epot_hist;
62  double _epot_lim;
63  double _epot_absf;
64  double _epot_relf;
65  ScalarField *_epot_old;
66  const ScalarField *_epot;
68  std::vector<double> _scharge_hist;
69  double _scharge_lim;
70  double _scharge_absf;
71  double _scharge_relf;
72  ScalarField *_scharge_old;
73  const ScalarField *_scharge;
75  struct EmitPoint {
76  double _epsilon;
77  double _alpha;
78  double _beta;
79  double _xave;
80  double _xpave;
82  EmitPoint();
83  EmitPoint( double x );
84  EmitPoint( const Emittance &emit );
85 
86  double &operator[]( int i );
87  };
88 
89  std::vector<double> _emit_hist[2];
90  double _emit_lim;
91  double _emit_absf;
92  double _emit_relf;
93  EmitPoint _emit_old[2];
94  const ParticleDataBase *_emit_pdb;
95  coordinate_axis_e _emit_axis;
96  double _emit_val;
97  const Emittance *_emit[2];
99 public:
100 
103  Convergence();
104 
107  ~Convergence();
108 
117  bool evaluate_iteration( void );
118 
121  void print_history( std::ostream &os ) const;
122 
125  void add_epot( const ScalarField &epot, double absf, double relf, double lim );
126 
129  void add_scharge( const ScalarField &scharge, double absf, double relf, double lim );
130 
133  void add_tdiag( const ParticleDataBase &pdb, coordinate_axis_e axis,
134  double val, double absf, double relf, double lim );
135 
138  void add_tdiag( const Emittance *emit1, double absf, double relf, double lim ) {
139  add_tdiag( emit1, NULL, absf, relf, lim );
140  }
141 
144  void add_tdiag( const Emittance *emit1, const Emittance *emit2,
145  double absf, double relf, double lim );
146 
149  void set_emittance( const Emittance *emit1, const Emittance *emit2 = NULL );
150 
151 };
152 
153 
154 #endif
155