proj_gauss_seidel_interface.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.
 */
 
#ifndef __H__UG__LIB_ALGEBRA__OPERATOR__PRECONDITIONER__PROJECTED_GAUSS_SEIDEL__PROJ_GAUSS_SEIDEL_INTERFACE__
#define __H__UG__LIB_ALGEBRA__OPERATOR__PRECONDITIONER__PROJECTED_GAUSS_SEIDEL__PROJ_GAUSS_SEIDEL_INTERFACE__
 
#include "obstacles/obstacle_constraint_interface.h"
#include "lib_algebra/operator/preconditioner/gauss_seidel.h"
 
namespace ug{
 
 
template <typename TDomain, typename TAlgebra>
class IProjGaussSeidel:
  public GaussSeidelBase<TAlgebra>
{
  public:
    typedef GaussSeidelBase<TAlgebra> base_type;
 
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
    typedef typename vector_type::value_type value_type;
 
    typedef GridFunction<TDomain, TAlgebra> GF;
 
  public:
    IProjGaussSeidel(): GaussSeidelBase<TAlgebra>(){
      m_spvObsConstraint.clear();
      m_bObsCons = false;
    };
 
 
    IProjGaussSeidel( const IProjGaussSeidel<TDomain, TAlgebra> &parent )
      : base_type(parent)
    {
      m_spvObsConstraint = parent.m_spvObsConstraint;
      m_bObsCons = parent.m_bObsCons;
    }
 
    void add_obstacle_constraint(SmartPtr<IObstacleConstraint<TDomain,TAlgebra> > spObsCons)
    {
      m_spvObsConstraint.push_back(spObsCons);
      m_bObsCons = true;
 
      //  inits the obstacle constraint
      spObsCons->init();
    }
 
    ~IProjGaussSeidel(){};
 
    virtual const char* name() const = 0;
 
    virtual bool init(SmartPtr<ILinearOperator<vector_type> > J, const vector_type& u);
 
 
    virtual void step(const matrix_type& mat, vector_type& c, const vector_type& d, const number relax) = 0;
 
    void project_correction(value_type& c_i, const size_t i);
 
    virtual bool apply(vector_type& c, const vector_type& d);
 
    virtual bool apply_update_defect(vector_type& c, vector_type& d);
 
  private:
    void truncateVec(vector_type& vec, vector<DoFIndex>& vInd);
 
    void truncateMat(matrix_type& mat, vector<DoFIndex>& vInd);
 
  protected:
    vector<SmartPtr<IObstacleConstraint<TDomain,TAlgebra> > > m_spvObsConstraint;
 
  private:
    SmartPtr<vector_type> m_spSol;
 
    bool m_bObsCons;
 
    bool m_bInit;
 
};
 
 
} // end namespace ug
 
// include implementation
#include "proj_gauss_seidel_interface_impl.h"
 
#endif /* __H__UG__LIB_ALGEBRA__OPERATOR__PRECONDITIONER__PROJECTED_GAUSS_SEIDEL__PROJ_GAUSS_SEIDEL_INTERFACE__ */