gs_solver.hpp

Go to the documentation of this file.

/* Copyright (c) 2005-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 GS_SOLVER_HPP
#define GS_SOLVER_HPP 1


#include <iostream>
#include "solver.hpp"
#include "geometry.hpp"
#include "problem.hpp"
#include "matrix.hpp"
#include "crowmatrix.hpp"
#include "mvector.hpp"


class GSSolver : public Solver {
    double   _eps;
    uint32_t _imax;
    double   _w;

    double   _newton_Reps;  
    double   _newton_dXeps; 
    double   _newton_imax;  
    static void gauss_seidel_error( const std::string func, int status );

public:

    GSSolver( double w = 1.66,
              double eps = 1.0e-6, 
              uint32_t imax = 10000, 
              double newton_Reps = 1.0e-5, 
              double newton_dXeps = 1.0e-6, 
              uint32_t newton_imax = 10 );

    ~GSSolver() {}

    virtual void solve( const Problem &p, Vector &X );

    virtual void reset( void );

    void set_newton_imax( uint32_t newton_imax ) {
        _newton_imax = newton_imax;
    }

    void set_newton_residual_eps( double newton_Reps ) {
        _newton_Reps = newton_Reps;
    }

    void set_newton_step_eps( double newton_dXeps ) {
        _newton_dXeps = newton_dXeps;
    }

    static bool gauss_seidel( const CRowMatrix &mat, const Vector &rhs, Vector &sol,
                              uint32_t &imax, double &eps, double w );
};


#endif