nested_iteration.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Arne Naegel
 * 
 * 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__NI_SOLVER__NI__
#define __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NI_SOLVER__NI__
 
#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 "lib_disc/assemble_interface.h"
 
#include "lib_disc/spatial_disc/domain_disc.h"
#include "lib_disc/function_spaces/metric_spaces.h"
#include "lib_disc/function_spaces/error_elem_marking_strategy.h"
 
#include "lib_algebra/operator/debug_writer.h"
 
namespace ug {
 
 
template <typename TDomain, typename TAlgebra>
class NestedIterationSolver
  :   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;
 
    typedef GridFunction<TDomain, TAlgebra> grid_function_type;
 
    typedef GridFunction<TDomain, CPUAlgebra> error_function_type;
 
  public:
    NestedIterationSolver();
 
    NestedIterationSolver(SmartPtr<IOperator<vector_type> > N);
 
    NestedIterationSolver(SmartPtr<IAssemble<TAlgebra> > spAss);
 
    NestedIterationSolver(SmartPtr<IAssemble<TAlgebra> > spAss, SmartPtr<IAssemble<TAlgebra> > spDomErr);
 
    NestedIterationSolver(SmartPtr<ILinearOperatorInverse<vector_type> > LinearSolver);
 
    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;
 
 
 
 
 
    int top_level() const     {return m_topLevel;}
    void set_top_level(int lev)   { m_topLevel = lev;}
 
    int base_level() const      {return m_baseLevel;}
    void set_base_level(int lev)  { m_baseLevel = lev;}
 
    void set_refiner(SmartPtr<IRefiner> r) {m_spRefiner =r; }
 
    void set_refinement_marking(SmartPtr<IElementMarkingStrategy<TDomain> > m) {m_spRefinementMarking =m; }
    void set_coarsening_marking(SmartPtr<IElementMarkingStrategy<TDomain> > m) {m_spCoarseningMarking =m; }
    void set_tolerance(number tol)
    {
      m_TOL = tol;
      UG_LOG("NI::set_tolerance" << m_TOL <<std::endl);
    }
 
 
 
    bool use_adaptive_refinement() const {return m_bUseAdaptiveRefinement;}
    void disable_adaptive_refinement() {m_bUseAdaptiveRefinement= false;}
    void enable_adaptive_refinement()  {m_bUseAdaptiveRefinement= true;}
 
 
    void set_max_steps(int steps) {m_maxSteps = steps;}
    number last_error() const {return m_lastError;}
 
    void set_associated_space(SmartPtr<IGridFunctionSpace<grid_function_type> > spSpace)
    { m_spAssociatedSpace = spSpace;}
 
    void set_absolute_tolerance(number atol)
    {
 
      m_absTOL = atol;
      UG_LOG("NI::set_absolute_tolerance" << m_absTOL <<std::endl);
    }
 
 
    using DebugWritingObject<TAlgebra>::write_debug;
    using DebugWritingObject<TAlgebra>::vector_debug_writer;
    void set_debug_elem_error(SmartPtr<error_function_type> spErrEta)
    {m_spElemError = spErrEta;}
 
  protected:
    void estimate_and_mark_domain(const grid_function_type& u, SmartPtr<IElementMarkingStrategy<TDomain> > spMarking,  bool bClearMarks = true);
    number refine_domain(const grid_function_type& u);
    number coarsen_domain(const grid_function_type& u);
 
 
  private:
    SmartPtr<ILinearOperatorInverse<vector_type> > m_spLinearSolver;
 
    SmartPtr<AssembledOperator<algebra_type> > m_N;
    SmartPtr<AssembledLinearOperator<algebra_type> > m_J;
    SmartPtr<IAssemble<TAlgebra> > m_spAss;
    SmartPtr<IAssemble<TAlgebra> > m_spDomErr;
 
    int m_dgbCall;
    int m_lastNumSteps;
 
 
    int m_baseLevel;
    int m_topLevel;
 
    SmartPtr<IRefiner> m_spRefiner;
 
    SmartPtr<IElementMarkingStrategy<TDomain> > m_spRefinementMarking;
    SmartPtr<IElementMarkingStrategy<TDomain> > m_spCoarseningMarking;
    bool m_bUseAdaptiveRefinement;
 
    int m_maxSteps;
    number m_lastError;
 
    number m_TOL;
 
    SmartPtr<IGridFunctionSpace<grid_function_type> > m_spAssociatedSpace;
 
    number m_absTOL;
 
    SmartPtr<error_function_type> m_spElemError;
};
 
}
 
#include "nested_iteration_impl.h"
 
#endif /* __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NI_SOLVER__NI__ */