epot_mgsolver.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_MGSOLVER_HPP
#define EPOT_MGSOLVER_HPP 1


#include "epot_solver.hpp"
#include "epot_mgsubsolver.hpp"


class EpotMGSolver : public EpotSolver {

    std::vector<MeshScalarField *>   _epotv;
    std::vector<Geometry *>          _geomv;
    std::vector<EpotMGSubSolver *>   _epotsolverv;
    std::vector<MeshScalarField *>   _rhsv;
    std::vector<MeshScalarField *>   _workv;
    std::vector<MeshScalarField *>   _work2v;

    bool             _geom_prepared;  
    uint32_t         _levels;         
    uint32_t         _npre;           
    uint32_t         _npost;          
    uint32_t         _mgcycmax;       
    uint32_t         _mgcyc;          
    double           _mgeps;          
    double           _mgerr;          
    uint32_t         _gamma;          
    double           _step;           
    double           _coarse_eps;     
    double           _coarse_err;     
    double           _w;              
    uint32_t         _imax;           
    uint32_t         _coarse_steps;   
    double           _local_Ulim;     
    uint32_t         _local_imax;     
    double           _local_eps;      
    void prepare_local_gnewton_settings( void );
    void print_field( const MeshScalarField *F );

    void prepare_mg_geom( void );

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

    void prolong_add_3d( MeshScalarField *out, int32_t i, int32_t j, int32_t k, double C );
    void prolong_add_cyl( MeshScalarField *out, int32_t i, int32_t j, double C );
    void prolong_add_2d( MeshScalarField *out, int32_t i, int32_t j, double C );
    void prolong_add_1d( MeshScalarField *out, int32_t i, double C );

    void correct( const Geometry *geom, MeshScalarField *sol, const MeshScalarField *corr );

    void restrict_3d( MeshScalarField *out, const MeshScalarField *in, bool defect );
    void restrict_cyl( MeshScalarField *out, const MeshScalarField *in, bool defect );
    void restrict_2d( MeshScalarField *out, const MeshScalarField *in, bool defect );
    void restrict_1d( MeshScalarField *out, const MeshScalarField *in, bool defect );

    void restrict( MeshScalarField *out, const MeshScalarField *in, bool defect );

    void prolong_3d( MeshScalarField *out, const MeshScalarField *in );
    void prolong_cyl( MeshScalarField *out, const MeshScalarField *in );
    void prolong_2d( MeshScalarField *out, const MeshScalarField *in );
    void prolong_1d( MeshScalarField *out, const MeshScalarField *in );
    void prolong( MeshScalarField *out, const MeshScalarField *in );

    void mg_recurse( uint32_t level );

    virtual void reset_problem( void );

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

public:

    EpotMGSolver( Geometry &geom );

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

    virtual ~EpotMGSolver();

    void set_eps( double eps );

    void set_w( double w );

    void set_imax( uint32_t imax );

    void set_local_imax( uint32_t local_imax );

    void set_levels( uint32_t levels );

    void set_mgcycmax( uint32_t mgcyc );

    void set_mgeps( double mgeps );

    void set_gamma( uint32_t gamma );

    void set_npre( uint32_t npre );

    void set_npost( uint32_t npost );

    double get_potential_change_norm( void ) const;

    double get_error_estimate( void ) const;

    uint32_t get_mgcyc( void ) const;

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

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

#endif