preconditioner.h

Go to the documentation of this file.

//    |  /           |
//    ' /   __| _` | __|  _ \   __|
//    . \  |   (   | |   (   |\__ `
//   _|\_\_|  \__,_|\__|\___/ ____/
//                   Multi-Physics
//
//  License:         BSD License
//                   Kratos default license: kratos/license.txt
//
//  Main authors:    Pooyan Dadvand
//
//
 
#if !defined(KRATOS_PRECONDITIONER_H_INCLUDED )
#define  KRATOS_PRECONDITIONER_H_INCLUDED
 
// System includes
#include <string>
#include <iostream>
 
// External includes
 
// Project includes
#include "includes/define.h"
#include "includes/model_part.h"
 
namespace Kratos
{
 
 
 
 
 
 
 
template<class TSparseSpaceType, class TDenseSpaceType>
class Preconditioner
{
public:
 
    KRATOS_CLASS_POINTER_DEFINITION(Preconditioner);
 
    typedef typename TSparseSpaceType::MatrixType SparseMatrixType;
 
    typedef typename TSparseSpaceType::VectorType VectorType;
 
    typedef typename TDenseSpaceType::MatrixType DenseMatrixType;
 
 
    Preconditioner() {}
 
    Preconditioner(const Preconditioner& Other) {}
 
    virtual ~Preconditioner() {}
 
 
 
    Preconditioner& operator=(const Preconditioner& Other)
    {
        return *this;
    }
 
 
    virtual void Initialize(SparseMatrixType& rA, VectorType& rX, VectorType& rB) {}
 
    virtual void Initialize(SparseMatrixType& rA, DenseMatrixType& rX, DenseMatrixType& rB)
    {
        VectorType x(TDenseSpaceType::Size1(rX));
        VectorType b(TDenseSpaceType::Size1(rB));
 
        TDenseSpaceType::GetColumn(0,rX, x);
        TDenseSpaceType::GetColumn(0,rB, b);
 
        Initialize(rA, x, b);
    }
 
    virtual void InitializeSolutionStep(SparseMatrixType& rA, VectorType& rX, VectorType& rB)
    {
    }
 
    virtual void FinalizeSolutionStep(SparseMatrixType& rA, VectorType& rX, VectorType& rB)
    {
    }
 
    virtual void Clear()
    {
    }
 
    virtual bool AdditionalPhysicalDataIsNeeded()
    {
        return false;
    }
 
    virtual void ProvideAdditionalData(
        SparseMatrixType& rA,
        VectorType& rX,
        VectorType& rB,
        typename ModelPart::DofsArrayType& rdof_set,
        ModelPart& r_model_part
    )
    {}
 
    virtual void Mult(SparseMatrixType& rA, VectorType& rX, VectorType& rY)
    {
        VectorType z = rX;
        ApplyRight(z);
        TSparseSpaceType::Mult(rA,z, rY);
        ApplyLeft(rY);
    }
 
    virtual void TransposeMult(SparseMatrixType& rA, VectorType& rX, VectorType& rY)
    {
        VectorType z = rX;
        ApplyTransposeLeft(z);
        TSparseSpaceType::TransposeMult(rA,z, rY);
        ApplyTransposeRight(rY);
    }
 
    virtual VectorType& ApplyLeft(VectorType& rX)
    {
        return rX;
    }
 
    virtual VectorType& ApplyRight(VectorType& rX)
    {
        return rX;
    }
 
    virtual VectorType& ApplyTransposeLeft(VectorType& rX)
    {
//  KRATOS_THROW_ERROR(std::logic_error,
//           " virtual TVectorType& ApplyTransposeLeft(TVectorType& rX)",
//           "This preconditioner dosn't have ApplyTransposeLeft defined.", "");
        return rX;
    }
 
    virtual VectorType& ApplyTransposeRight(VectorType& rX)
    {
//  KRATOS_THROW_ERROR(std::logic_error,
//           " virtual TVectorType& ApplyTransposeRight(TVectorType& rX)",
//           "This preconditioner dosn't have ApplyTransposeRight defined.", "");
        return rX;
    }
 
    virtual VectorType& ApplyInverseRight(VectorType& rX)
    {
        return rX;
    }
 
    /* The method Finalize is used to recover the value of rX.
       In principle, it is enough to multiply by the right preconditioner.
    See the diagoinal preconditioner for a nontrivial example. */
    virtual VectorType& Finalize(VectorType& rX)
    {
        return ApplyRight(rX);
    }
 
 
 
 
 
 
    virtual std::string Info() const
    {
        return "Preconditioner";
    }
 
    virtual void PrintInfo(std::ostream& rOStream) const
    {
        rOStream << "Preconditioner";
    }
 
    virtual void PrintData(std::ostream& rOStream) const
    {
    }
 
 
 
 
 
protected:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
private:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
}; // Class Preconditioner
 
 
 
 
 
 
template<class TSparseSpaceType, class TDenseSpaceType>
inline std::istream& operator >> (std::istream& IStream,
                                  Preconditioner<TSparseSpaceType, TDenseSpaceType>& rThis)
{
    return IStream;
}
 
template<class TSparseSpaceType, class TDenseSpaceType>
inline std::ostream& operator << (std::ostream& OStream,
                                  const Preconditioner<TSparseSpaceType, TDenseSpaceType>& rThis)
{
    rThis.PrintInfo(OStream);
    OStream << std::endl;
    rThis.PrintData(OStream);
 
    return OStream;
}
 
}  // namespace Kratos.
 
#endif // KRATOS_PRECONDITIONER_H_INCLUDED  defined