linear_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__LINEAR_OPERATOR_INVERSE__
#define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__LINEAR_OPERATOR_INVERSE__
 
#include "linear_operator.h"
#include "linear_iterator.h"
#include "lib_algebra/operator/convergence_check.h"
#include "common/error.h"
#include "common/util/smart_pointer.h"
 
namespace ug{
 
 
// Inverse of a Linear Operator
 
 
template <typename X, typename Y = X>
class ILinearOperatorInverse : public ILinearIterator<X,Y>
{
  public:
    typedef X domain_function_type;
 
    typedef Y codomain_function_type;
 
  public:
    ILinearOperatorInverse()
      : m_spLinearOperator(NULL),
        m_spConvCheck(new StdConvCheck<X>(100, 1e-12, 1e-12, true))
    {}
 
    ILinearOperatorInverse(SmartPtr<IConvergenceCheck<X> > spConvCheck)
      : m_spLinearOperator(NULL),
        m_spConvCheck(spConvCheck)
    {}
 
    virtual ~ILinearOperatorInverse() {};
 
 
    virtual const char* name() const = 0;
 
 
 
    virtual std::string config_string() const { return name(); }
 
    virtual bool supports_parallel() const = 0;
 
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > L)
    {
    //  remember operator
      m_spLinearOperator = L;
      return true;
    }
 
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > J, const Y& u)
    {
    //  remember operator
      m_spLinearOperator = J;
      return true;
    }
 
 
    virtual bool apply(Y& u, const X& f) = 0;
 
 
    virtual bool apply_return_defect(Y& u, X& f) = 0;
 
    virtual bool apply_update_defect(Y& u, X& f)
    {
      return apply_return_defect(u,f);
    }
 
    virtual SmartPtr<ILinearIterator<X,Y> > clone()
    {
      UG_THROW("No cloning implemented.");
      return SPNULL;
    }
 
    ConstSmartPtr<IConvergenceCheck<X> > convergence_check() const {return m_spConvCheck;}
 
    SmartPtr<IConvergenceCheck<X> > convergence_check() {return m_spConvCheck;}
 
    number defect() const {return convergence_check()->defect();}
 
    int step() const {return convergence_check()->step();}
 
    number reduction() const {return convergence_check()->reduction();}
 
    virtual int standard_offset() const {return 3;}
 
    void set_convergence_check(SmartPtr<IConvergenceCheck<X> > spConvCheck)
    {
      m_spConvCheck = spConvCheck;
      m_spConvCheck->set_offset(standard_offset());
    };
 
    SmartPtr<ILinearOperator<Y,X> > linear_operator()
    {
      if(m_spLinearOperator.invalid())
        UG_THROW(name() << ": Linear Operator that should be "
                         "inverted has not been set.");
 
      return m_spLinearOperator;
    }
 
  protected:
    SmartPtr<ILinearOperator<Y,X> > m_spLinearOperator;
 
    SmartPtr<IConvergenceCheck<X> > m_spConvCheck;
};
 
}
#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__LINEAR_OPERATOR_INVERSE__ */