matrix_operator_inverse.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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.
 */
 
#ifndef __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR_INVERSE__
#define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR_INVERSE__
 
#include "linear_operator_inverse.h"
#include "matrix_operator.h"
#include "common/error.h"
#include "common/util/smart_pointer.h"
 
namespace ug{
 
// Inverse of a Matrix-based Linear Operator
 
 
template <typename M, typename X, typename Y = X>
class IMatrixOperatorInverse
  : public virtual ILinearOperatorInverse<X,Y>
{
  public:
    typedef X domain_function_type;
 
    typedef Y codomain_function_type;
 
    typedef M matrix_type;
 
  public:
 
    virtual bool init(SmartPtr<MatrixOperator<M,Y,X> > A) = 0;
 
 
    virtual bool apply(Y& u, const X& f) = 0;
 
 
    virtual bool apply_return_defect(Y& u, X& f) = 0;
 
    virtual ~IMatrixOperatorInverse() {};
 
  public:
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > A, const Y&u)
    {
    //  forget about u and forward request.
      return init(A);
    }
 
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > A)
    {
    //  cast operator
      SmartPtr<MatrixOperator<M,Y,X> > op =
                  A.template cast_dynamic<MatrixOperator<M,Y,X> >();
 
    //  check if correct types are present
      if(op.invalid())
        UG_THROW("IMatrixOperatorInverse::init:"
            " Passed operator is not matrix-based.");
 
    //  forward request
      return init(op);
    }
};
 
}
#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__MATRIX_OPERATOR_INVERSE__ */