nl_gauss_seidel.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
 * Author: Raphael Prohl
 * 
 * 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.
 */
 
/*
 *  (main parts are based on the structure of
 *    newton.h and some ideas of Sebastian Reiter & Andreas Vogel)
 */
 
#ifndef __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NL_GAUSS_SEIDEL__NL_GAUSS_SEIDEL_H_
#define __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NL_GAUSS_SEIDEL__NL_GAUSS_SEIDEL_H_
 
#include "lib_algebra/operator/interface/operator_inverse.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/spatial_disc/local_to_global/local_to_global_mapper.h"
 
namespace ug {
 
template <typename TAlgebra>
class LocalToGlobalMapperNLGS : public ILocalToGlobalMapper<TAlgebra>
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
  public:
    LocalToGlobalMapperNLGS() {}
 
    void add_local_vec_to_global(vector_type& vec, const LocalVector& lvec,
        ConstSmartPtr<DoFDistribution> dd);
 
    void add_local_mat_to_global(matrix_type& mat, const LocalMatrix& lmat,
        ConstSmartPtr<DoFDistribution> dd);
 
     void modify_LocalSol(LocalVector& vecMod, const LocalVector& lvec, ConstSmartPtr<DoFDistribution> dd){}
 
    void set_assembling_index(const size_t assIndex){ m_assemblingIndex = assIndex;}
 
    ~LocalToGlobalMapperNLGS() {};
 
  private:
    size_t m_assemblingIndex;
};
 
 
template <typename TDomain, typename TAlgebra>
class NLGaussSeidelSolver
  : public IOperatorInverse<typename TAlgebra::vector_type>,
    public DebugWritingObject<TAlgebra>
{
  private:
    typedef NLGaussSeidelSolver<TDomain, TAlgebra> this_type;
 
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename TAlgebra::matrix_type matrix_type;
 
    typedef typename TAlgebra::vector_type vector_type;
 
    typedef typename vector_type::value_type value_type;
 
    typedef TDomain domain_type;
 
    typedef ApproximationSpace<domain_type> approx_space_type;
 
    typedef typename domain_traits<TDomain::dim>::grid_base_object grid_base_object;
 
  protected:
    typedef DebugWritingObject<TAlgebra> base_writer_type;
 
  public:
    NLGaussSeidelSolver();
 
    NLGaussSeidelSolver(SmartPtr<approx_space_type> spApproxSpace,
          SmartPtr<IConvergenceCheck<vector_type> > spConvCheck);
 
    void set_approximation_space(SmartPtr<approx_space_type> spApproxSpace)
    {m_spApproxSpace = spApproxSpace;}
 
    void set_convergence_check(SmartPtr<IConvergenceCheck<vector_type> > spConvCheck);
 
    void set_damp(const number damp) {m_damp = damp;}
 
    void set_constraint(const vector_type& cons) {m_ConsVec = cons; m_bProjectedGS = true;}
 
  //  OperatorInverse interface methods
 
    virtual bool init(SmartPtr<IOperator<vector_type> > op);
 
    virtual bool prepare(vector_type& u);
 
    virtual bool apply(vector_type& u);
 
    virtual std::string config_string() const
    {
      std::stringstream ss;
      ss << "NonlinearGaussSeidelSolver( damp = " << m_damp << ")\n";
      ss << " ConvergenceCheck: ";
      if(m_spConvCheck.valid()) ss << ConfigShift(m_spConvCheck->config_string()) << "\n";
      else              ss << " NOT SET!\n";
 
      return ss.str();
    }
 
  private:
    void write_debug(const vector_type& vec, const char* filename);
    void write_debug(const matrix_type& mat, const char* filename);
 
  private:
    SmartPtr<approx_space_type> m_spApproxSpace;
 
    ConstSmartPtr<DoFDistribution> m_spLevDD;
    ConstSmartPtr<DoFDistribution> m_spSurfDD;
 
    GridLevel m_gridLevel;
 
    SmartPtr<IConvergenceCheck<vector_type> > m_spConvCheck;
 
    SmartPtr<AssembledOperator<algebra_type> > m_spAssOp;
    SmartPtr<AssembledLinearOperator<algebra_type> > m_spJBlock;
    SmartPtr<IAssemble<TAlgebra> > m_spAss;
 
    number m_damp;
 
    vector_type m_ConsVec;
    bool m_bProjectedGS;
 
    int m_dgbCall;
 
    /* TODO: hier alle typen von grid_base_object zulassen?
    typedef Attachment<vector<grid_base_object*> > AElemList;   //attachment type: attachment of ElemDatas
    AElemList m_aElemList;            //the instance of the attachment type
    typedef Grid::VertexAttachmentAccessor<AElemList> ElemListAccessor;
    ElemListAccessor m_aaElemList;
    void attach_attachments()
    {
      typename TDomain::grid_type& grid = *this->domain().grid();
      grid.attach_to_vertices(m_aElemList);
      m_aaElemList.access(grid, m_aElemList);
    }*/
 
    // TODO: hier alle typen von grid_base_object zulassen?
    typedef std::vector<grid_base_object*> elemList;
    std::vector<elemList> m_vElemList;
 
    Selector m_sel;
 
    LocalToGlobalMapperNLGS<TAlgebra> m_map;
};
 
}
 
#include "nl_gauss_seidel_impl.h"
 
#endif /* __H__UG__LIB_DISC__OPERATOR__NON_LINEAR_OPERATOR__NL_GAUSS_SEIDEL__NL_GAUSS_SEIDEL_H_ */