epot_gssolver.hpp

Go to the documentation of this file.

/* Copyright (c) 2011-2013 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 EPOT_GSSOLVER_HPP
#define EPOT_GSSOLVER_HPP 1


#include "epot_solver.hpp"


class EpotGSSolver : public EpotSolver {

    MeshScalarField *_epot;
    MeshScalarField *_rhs;

    uint32_t         _iter;           
    uint32_t         _imax;           
    double           _eps;            
    double           _step;           
    double           _err;            
    double           _w;              
    double           _local_Ulim_fac; 
    double           _local_Ulim;     
    uint32_t         _local_imax;     
    double           _local_eps;      
    double solve_pexp_potential( double epf, double cof, double rhs, double p ) const;
    double solve_nsimp_potential( double epf, double cof, double rhs, double p ) const;
    void prepare_local_gnewton_settings( void );

    double gs_loop_3d( void ) const;
    double gs_process_near_solid_3d( const uint8_t *nearsolid_ptr, 
                                     uint32_t a, uint32_t dj, uint32_t dk, uint8_t bindex ) const;
    double gs_process_pure_vacuum_3d( uint32_t a, uint32_t dj, uint32_t dk ) const;
    double gs_process_neumann_3d( uint32_t a, uint32_t dj, uint32_t dk, uint8_t bindex ) const;


    double gs_loop_cyl( void ) const;
    double gs_process_near_solid_cyl( const uint8_t *nearsolid_ptr, 
                                      uint32_t i, uint32_t j, uint8_t bindex ) const;
    double gs_process_pure_vacuum_cyl( uint32_t i, uint32_t j ) const;
    double gs_process_neumann_cyl( uint32_t i, uint32_t j, uint8_t bindex ) const;


    double gs_loop_2d( void ) const;
    double gs_process_near_solid_2d( const uint8_t *nearsolid_ptr, 
                                     uint32_t a, uint32_t dj,
                                     uint8_t bindex ) const;
    double gs_process_pure_vacuum_2d( uint32_t a, uint32_t dj ) const;
    double gs_process_neumann_2d( uint32_t a, uint32_t dj, uint8_t bindex ) const;


    double gs_loop_1d( void ) const;
    double gs_process_near_solid_1d( const uint8_t *nearsolid_ptr, 
                                     uint32_t i, uint8_t bindex ) const;
    double gs_process_pure_vacuum_1d( uint32_t i ) const;
    double gs_process_neumann_1d( uint32_t i, uint8_t bindex ) const;


    double near_solid_neumann_rhs_contribution( uint32_t i, uint32_t j, uint32_t k, 
                                                uint8_t bindex, const Vec3D &x ) const;
    void preprocess( const MeshScalarField &scharge );
    void postprocess( void );

    double error_scale( void );

    virtual void reset_problem( void );

    virtual void subsolve( MeshScalarField &epot, const MeshScalarField &scharge );

public:

    EpotGSSolver( Geometry &geom );

    EpotGSSolver( Geometry &geom, std::istream &s );

    virtual ~EpotGSSolver() {}

    void set_eps( double eps );

    void set_imax( uint32_t imax );

    void set_w( double w );

    void set_plasma_solver_parameters( double Ulim_fac, uint32_t imax, double eps );

    double get_potential_change_norm( void ) const;

    double get_error_estimate( void ) const;

    uint32_t get_iter( void ) const;

    virtual void debug_print( std::ostream &os ) const;

    virtual void save( std::ostream &s ) const;
};

#endif