precond.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2013   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef precond_h
#define precond_h

#include "oofemcfg.h"
#include "floatarray.h"
#include "sparsemtrx.h"
#include "inputrecord.h"

namespace oofem {
class OOFEM_EXPORT Preconditioner
{
public:
    Preconditioner(const SparseMtrx & a, InputRecord & attributes);
    Preconditioner() { }
    virtual ~Preconditioner(void) { }

    virtual void init(const SparseMtrx &a) { }

    FloatArray solve(const FloatArray &rhs) const {
        FloatArray y;
        this->solve(rhs, y);
        return y;
    }
    FloatArray trans_solve(const FloatArray &rhs) const {
        FloatArray y;
        this->trans_solve(rhs, y);
        return y;
    }
    virtual void solve(const FloatArray &rhs, FloatArray &solution) const = 0;
    virtual void trans_solve(const FloatArray &rhs, FloatArray &solution) const = 0;

    virtual const char *giveClassName() const { return "Preconditioner"; }
    virtual IRResultType initializeFrom(InputRecord *ir) { return IRRT_OK; }
};
} // end namespace oofem
#endif // precond_h