newton.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__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NEWTON_SOLVER__NEWTON__
#define __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NEWTON_SOLVER__NEWTON__
 
#include <cmath>
 
#include "lib_algebra/operator/interface/operator_inverse.h"
#include "lib_algebra/operator/interface/linear_operator_inverse.h"
#include "lib_algebra/operator/debug_writer.h"
 
// modul intern headers
#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"
#include "../line_search.h"
#include "newton_update_interface.h"
#include "lib_algebra/operator/debug_writer.h"
 
#include "nestedNewtonRFSwitch.h"
 
#if ENABLE_NESTED_NEWTON_RESOLFUNC_UPDATE
 
#include "newtonUpdaterGeneric.h"
 
#endif
 
namespace ug {
 
template <typename TAlgebra>
class NewtonSolver
  :   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:
    NewtonSolver(SmartPtr<IOperator<vector_type> > N);
 
    NewtonSolver(SmartPtr<IAssemble<TAlgebra> > spAss);
 
    NewtonSolver();
 
    NewtonSolver(SmartPtr<ILinearOperatorInverse<vector_type> > LinearSolver,
                 SmartPtr<IConvergenceCheck<vector_type> > spConvCheck,
                 SmartPtr<ILineSearch<vector_type> > spLineSearch);
 
    void set_linear_solver(SmartPtr<ILinearOperatorInverse<vector_type> > LinearSolver) {m_spLinearSolver = LinearSolver;}
 
    void set_convergence_check(SmartPtr<IConvergenceCheck<vector_type> > spConvCheck);
 
    void set_line_search(SmartPtr<ILineSearch<vector_type> > spLineSearch) {m_spLineSearch = spLineSearch;}
    void disable_line_search() {m_spLineSearch = SPNULL;}
    SmartPtr<ILineSearch<vector_type> > line_search() {return m_spLineSearch;}
 
    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;
 
    void print_average_convergence() const;
 
    size_t num_newton_steps() const;
    int num_linsolver_calls(size_t call) const;
    int num_linsolver_steps(size_t call) const;
    double average_linear_steps(size_t call) const;
    int total_linsolver_calls() const;
    int total_linsolver_steps() const;
    double total_average_linear_steps() const;
    int last_num_newton_steps() const {return m_lastNumSteps;}
 
    void clear_average_convergence();
 
    void add_inner_step_update(SmartPtr<INewtonUpdate > NU)
      {m_innerStepUpdate.push_back(NU);}
 
    void clear_inner_step_update(SmartPtr<INewtonUpdate > NU)
      {m_innerStepUpdate.clear();}
 
    void add_step_update(SmartPtr<INewtonUpdate > NU)
      {m_stepUpdate.push_back(NU);}
 
    void clear_step_update(SmartPtr<INewtonUpdate > NU)
      {m_stepUpdate.clear();}
    
    void set_reassemble_J_freq(int freq)
      {m_reassembe_J_freq = freq;};
 
#if ENABLE_NESTED_NEWTON_RESOLFUNC_UPDATE
    void setNewtonUpdater( SmartPtr<NewtonUpdaterGeneric<vector_type> > nU )
    {
      m_newtonUpdater = nU;
    }
#endif
 
  private:
    void write_debug(const vector_type& vec, std::string filename);
    void write_debug(const matrix_type& mat, std::string filename);
 
  private:
    SmartPtr<ILinearOperatorInverse<vector_type> > m_spLinearSolver;
 
    SmartPtr<IConvergenceCheck<vector_type> > m_spConvCheck;
 
    SmartPtr<ILineSearch<vector_type> > m_spLineSearch;
 
    std::vector<SmartPtr<INewtonUpdate> > m_innerStepUpdate;
    std::vector<SmartPtr<INewtonUpdate> > m_stepUpdate;
 
    SmartPtr<AssembledOperator<algebra_type> > m_N;
    SmartPtr<AssembledLinearOperator<algebra_type> > m_J;
    SmartPtr<IAssemble<TAlgebra> > m_spAss;
    int m_reassembe_J_freq;
 
    int m_dgbCall;
    int m_lastNumSteps;
 
    std::vector<int> m_vTotalLinSolverSteps;
    std::vector<int> m_vLinSolverCalls;
    std::vector<number> m_vNonLinSolverRates;
    std::vector<number> m_vLinSolverRates;
 
#if ENABLE_NESTED_NEWTON_RESOLFUNC_UPDATE
 
    SmartPtr<NewtonUpdaterGeneric<vector_type> > m_newtonUpdater;
 
#endif
 
};
 
}
 
#include "newton_impl.h"
 
#endif /* __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NEWTON_SOLVER__NEWTON__ */