newton_limex.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Markus Breit,
 *         but largely copied from ugcore Newton implementation by 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 UG_PLUGINS__LIMEX__NEWTON_LIMEX
#define UG_PLUGINS__LIMEX__NEWTON_LIMEX
 
#include "lib_algebra/operator/interface/operator_inverse.h"
#include "lib_algebra/operator/interface/linear_operator_inverse.h"
#include "lib_algebra/operator/debug_writer.h"
 
#include "lib_disc/assemble_interface.h"
#include "lib_disc/operator/non_linear_operator/assembled_non_linear_operator.h"
#include "lib_disc/operator/linear_operator/assembled_linear_operator.h"
 
 
namespace ug {
 
template <typename TAlgebra>
class LimexNewtonSolver
  :   public IOperatorInverse<typename TAlgebra::vector_type>
    //public DebugWritingObject<TAlgebra>
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename TAlgebra::vector_type vector_type;
 
    typedef typename TAlgebra::matrix_type matrix_type;
 
  public:
    LimexNewtonSolver();
 
    LimexNewtonSolver(SmartPtr<IOperator<vector_type> > N);
 
    LimexNewtonSolver(SmartPtr<IAssemble<TAlgebra> > spAss);
 
    void set_linear_solver(SmartPtr<ILinearOperatorInverse<vector_type> > LinearSolver)
    {m_spLinearSolver = LinearSolver;}
 
    virtual bool init(SmartPtr<IOperator<vector_type> > N);
 
    virtual bool prepare(vector_type& u);
 
    virtual bool apply(vector_type& u);
 
    virtual std::string config_string() const;
 
    number linear_solver_rate() const;
 
    int linear_solver_steps() const;
 
  private:
    void write_debug(const vector_type& vec, const char* filename);
    void write_debug(const matrix_type& mat, const char* filename);
 
  private:
    SmartPtr<ILinearOperatorInverse<vector_type> > m_spLinearSolver;
 
 
    SmartPtr<AssembledOperator<algebra_type> > m_N;
 
    SmartPtr<AssembledLinearOperator<algebra_type> > m_J;
 
    SmartPtr<IAssemble<TAlgebra> > m_spAss;
 
 
    size_t m_linSolverSteps;
    number m_linSolverRate;
};
 
} // namespace ug
 
#include "newton_limex_impl.h"
 
#endif  // UG_PLUGINS__LIMEX__NEWTON_LIMEX