BlockSolverBase.hpp

/*
 * This file is part of bogus, a C++ sparse block matrix library.
 *
 * Copyright 2013 Gilles Daviet <gdaviet@gmail.com>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/

#ifndef BOGUS_BLOCK_SOLVER_BASE_HPP
#define BOGUS_BLOCK_SOLVER_BASE_HPP

#include "../Block.fwd.hpp"
#include "../BlockSolvers.fwd.hpp"

#ifndef BOGUS_WITHOUT_EIGEN
#include "../Eigen/EigenProblemTraits.hpp"
#include "../Eigen/EigenBlockContainers.hpp"
#endif

#include "../Utils/Signal.hpp"

namespace bogus
{

template < typename BlockMatrixType >
class BlockSolverBase
{
public:
    typedef BlockMatrixTraits< BlockMatrixType > BlockTraits ;
    typedef typename BlockTraits::Scalar Scalar ;
    typedef ProblemTraits< Scalar > GlobalProblemTraits ;
    typedef Signal< unsigned, Scalar > CallBackType ;

    virtual ~BlockSolverBase() { }

    void setMaxIters( unsigned maxIters ) { m_maxIters = maxIters ; }
    unsigned maxIters() const { return m_maxIters ; }

    void setTol( Scalar tol ) { m_tol = tol ; }
    Scalar tol() const { return m_tol ; }


    CallBackType &callback() { return m_callback ; }
    const CallBackType &callback() const { return m_callback ; }

    const BlockObjectBase< BlockMatrixType > &matrix() const { return *m_matrix ; }

protected:

    BlockSolverBase( const BlockObjectBase< BlockMatrixType > * matrix = BOGUS_NULL_PTR(const BlockObjectBase< BlockMatrixType >),
                     unsigned maxIters = 0, Scalar tol = 0 )
        : m_matrix( matrix ), m_maxIters( maxIters ), m_tol( tol )
    {}

    const BlockObjectBase< BlockMatrixType > * m_matrix ;

    unsigned m_maxIters;
    Scalar m_tol ;

    CallBackType m_callback ;
} ;

} //namespace bogus

#endif