linear_iterator.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__OPERATOR_ITERATOR__
#define __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR_ITERATOR__
 
#include "lib_algebra/operator/damping.h"
#include "common/util/smart_pointer.h"
 
namespace ug{
 
// Iterator Operator
 
 
template <typename X, typename Y = X>
class ILinearIterator
{
  public:
    typedef X domain_function_type;
 
    typedef Y codomain_function_type;
 
  public:
 
    virtual const char* name() const = 0;
 
    virtual bool supports_parallel() const = 0;
 
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > J, const Y& u) = 0;
 
 
    virtual bool init(SmartPtr<ILinearOperator<Y,X> > L) = 0;
 
 
    virtual bool apply(Y& c, const X& d) = 0;
 
 
    virtual bool apply_update_defect(Y& c, X& d) = 0;
 
 
    void set_damp(SmartPtr<IDamping<X,Y> > spScaling) {
      m_spDamping = spScaling;
    }
 
    void set_damp(number factor) {
      m_spDamping = make_sp(new ConstantDamping<X,Y>(factor));
    }
 
    SmartPtr<IDamping<X,Y> > damping() {return m_spDamping;}
 
    virtual SmartPtr<ILinearIterator<X,Y> > clone() = 0;
 
    virtual ~ILinearIterator() {};
 
    ILinearIterator() {set_damp(1.0);};
 
    ILinearIterator(const ILinearIterator<X, Y> &parent)
    {
      set_damp(parent.m_spDamping);
    };
 
    virtual std::string config_string() const
    {
      std::stringstream ss; ss << name() << "( damping = " << m_spDamping->config_string() << ")"; return ss.str();
    }
 
  protected:
    SmartPtr<IDamping<X,Y> > m_spDamping;
};
 
} // end namespace ug
 
#endif /* __H__LIB_ALGEBRA__OPERATOR__INTERFACE__OPERATOR_ITERATOR__ */