convergence.hpp

Go to the documentation of this file.

/* Copyright (c) 2011 Taneli Kalvas. All rights reserved.
 *
 * You can redistribute this software and/or modify it under the terms
 * of the GNU General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 * 
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this library (file "COPYING" included in the package);
 * if not, write to the Free Software Foundation, Inc., 51 Franklin
 * Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * If you have questions about your rights to use or distribute this
 * software, please contact Berkeley Lab's Technology Transfer
 * Department at TTD@lbl.gov. Other questions, comments and bug
 * reports should be sent directly to the author via email at
 * taneli.kalvas@jyu.fi.
 * 
 * NOTICE. This software was developed under partial funding from the
 * U.S.  Department of Energy.  As such, the U.S. Government has been
 * granted for itself and others acting on its behalf a paid-up,
 * nonexclusive, irrevocable, worldwide license in the Software to
 * reproduce, prepare derivative works, and perform publicly and
 * display publicly.  Beginning five (5) years after the date
 * permission to assert copyright is obtained from the U.S. Department
 * of Energy, and subject to any subsequent five (5) year renewals,
 * the U.S. Government is granted for itself and others acting on its
 * behalf a paid-up, nonexclusive, irrevocable, worldwide license in
 * the Software to reproduce, prepare derivative works, distribute
 * copies to the public, perform publicly and display publicly, and to
 * permit others to do so.
 */

#ifndef CONVERGENCE_HPP
#define CONVERGENCE_HPP 1


#include <iostream>
#include <stdint.h>
#include <vector>
#include "scalarfield.hpp"
#include "trajectorydiagnostics.hpp"
#include "particledatabase.hpp"


class Convergence {

    int32_t                 _iter;              
    std::vector<double>     _epot_hist;         
    double                  _epot_lim;          
    double                  _epot_absf;         
    double                  _epot_relf;         
    ScalarField            *_epot_old;          
    const ScalarField      *_epot;              
    std::vector<double>     _scharge_hist;      
    double                  _scharge_lim;       
    double                  _scharge_absf;      
    double                  _scharge_relf;      
    ScalarField            *_scharge_old;       
    const ScalarField      *_scharge;           
    struct EmitPoint {
        double              _epsilon;           
        double              _alpha;             
        double              _beta;              
        double              _xave;              
        double              _xpave;             
        EmitPoint();
        EmitPoint( double x );
        EmitPoint( const Emittance &emit );

        double &operator[]( int i );
    };

    std::vector<double>     _emit_hist[2];      
    double                  _emit_lim;          
    double                  _emit_absf;         
    double                  _emit_relf;         
    EmitPoint               _emit_old[2];       
    const ParticleDataBase *_emit_pdb;          
    coordinate_axis_e       _emit_axis;         
    double                  _emit_val;          
    const Emittance        *_emit[2];           
public:

    Convergence();

    ~Convergence();

    bool evaluate_iteration( void );

    void print_history( std::ostream &os ) const;

    void add_epot( const ScalarField &epot, double absf, double relf, double lim );

    void add_scharge( const ScalarField &scharge, double absf, double relf, double lim );

    void add_tdiag( const ParticleDataBase &pdb, coordinate_axis_e axis,
                    double val, double absf, double relf, double lim );

    void add_tdiag( const Emittance *emit1, double absf, double relf, double lim ) {
        add_tdiag( emit1, NULL, absf, relf, lim );
    }

    void add_tdiag( const Emittance *emit1, const Emittance *emit2, 
                    double absf, double relf, double lim );

    void set_emittance( const Emittance *emit1, const Emittance *emit2 = NULL );

};


#endif