hiptmair_hybrid_smoother.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013:  G-CSC, Goethe University Frankfurt
 * Author: Dmitry Logashenko
 * 
 * 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.
 */
 
/*
 * The hybrid smoother proposed by R. Hiptmair for the discretizations
 * based on the Nedelec element. The smoother is implemented for the
 * discretizations of the time-harmonic equations.
 */
#ifndef __H__UG__PLUGINS__ELECTROMAGNETISM__HIPTMAIR_HYBRID_SMOOTHER__
#define __H__UG__PLUGINS__ELECTROMAGNETISM__HIPTMAIR_HYBRID_SMOOTHER__
 
// basic ug4 headers
#include "common/common.h"
#include "lib_grid/lg_base.h"
 
// library-specific ug4 headers
#include "lib_algebra/operator/interface/linear_iterator.h"
#include "lib_algebra/operator/interface/matrix_operator.h"
#include "lib_algebra/operator/damping.h"
#include "lib_algebra/operator/debug_writer.h"
 
// plugin headers
#include "../em_material.h"
 
namespace ug{
namespace Electromagnetism{
 
 
template <typename TDomain, typename TAlgebra>
class TimeHarmonicNedelecHybridSmoother :
  public ILinearIterator<typename TAlgebra::vector_type>,
  public DebugWritingObject<TAlgebra>
{
  typedef TimeHarmonicNedelecHybridSmoother<TDomain,TAlgebra> this_type;
  
public:
  typedef typename TAlgebra::vector_type vector_type;
  typedef typename TAlgebra::matrix_type matrix_type;
  typedef MatrixOperator<matrix_type, vector_type> matrix_operator_type;
 
  typedef CPUAlgebra TPotAlgebra;
  typedef typename TPotAlgebra::vector_type pot_vector_type;
  typedef typename TPotAlgebra::matrix_type pot_matrix_type;
  typedef MatrixOperator<pot_matrix_type, pot_vector_type> pot_matrix_operator_type;
  
  typedef GridFunction<TDomain, TAlgebra> TGridFunc;
  typedef GridFunction<TDomain, TPotAlgebra> TPotGridFunc;
 
private:
 
  bool zero_mass_entry (double val) {return fabs (val) < 1e-64;} // this could be merely 0
 
  SmartPtr<matrix_operator_type> m_spSysMat;
  
  SmartPtr<pot_matrix_operator_type> m_spPotMat;
  
  TPotGridFunc * m_pPotCorRe;
  TPotGridFunc * m_pPotCorIm;
  
  SmartPtr<DoFDistribution> m_spEdgeDD;
  
  SmartPtr<ApproximationSpace<TDomain> > m_spVertApproxSpace;
  SmartPtr<DoFDistribution> m_spVertDD;
  
  GridLevel m_GridLevel;
  
  SmartPtr<ILinearIterator<vector_type> > m_spEdgeSmoother;
  
  SmartPtr<ILinearIterator<pot_vector_type> > m_spVertSmoother;
 
  SmartPtr<EMDirichlet<TDomain, TAlgebra> > m_spDirichlet;
  
  struct tEdgeInfo
  {
    size_t vrt_index [2]; 
    
    char flags; 
    
    bool is_Dirichlet () {return (flags & 1) != 0;}
    bool conductive_vrt_0 () {return (flags & 2) != 0;}
    bool conductive_vrt_1 () {return (flags & 4) != 0;}
    bool is_init () {return (flags & 8) != 0;}
    
    void clear_flags () {flags = 0;}
    void set_Dirichlet () {flags |= 1;}
    void set_conductive_vrt_0 () {flags |= 2;}
    void set_conductive_vrt_1 () {flags |= 4;}
    void set_init () {flags |= 8;}
  };
  VariableArray1<tEdgeInfo> m_vEdgeInfo;
 
  bool m_bInit;
  
  bool m_bSkipEdge, m_bSkipVertex;
 
public:
  TimeHarmonicNedelecHybridSmoother
  (
    SmartPtr<ApproximationSpace<TDomain> > vertApproxSpace, 
    SmartPtr<ILinearIterator<vector_type> > edgeSmoother, 
    SmartPtr<ILinearIterator<pot_vector_type> > vertSmoother 
  )
  : m_spPotMat (new pot_matrix_operator_type),
    m_pPotCorRe (NULL), m_pPotCorIm (NULL),
    m_spVertApproxSpace (vertApproxSpace),
    m_spEdgeSmoother (edgeSmoother), m_spVertSmoother (vertSmoother),
    m_bInit (false),
    m_bSkipEdge (false), m_bSkipVertex (false)
  {
    if (m_spVertApproxSpace.invalid ())
      UG_THROW (name() << ": illegal vert.-centered approx. space");
    if (m_spEdgeSmoother.invalid ())
      UG_THROW (name() << ": illegal edge-centered smoother");
    if (m_spVertSmoother.invalid ())
      UG_THROW (name() << ": illegal vert.-centered smoother");
  }
  
  ~TimeHarmonicNedelecHybridSmoother ()
  {
    delete m_pPotCorRe; delete m_pPotCorIm;
  }
 
  const char* name() const {return "Hiptmair hybrid smoother for Whitney-1 elements";}
  
  bool supports_parallel() const {return true;}
  
  bool init(SmartPtr<ILinearOperator<vector_type> > J, const vector_type& u);
 
  bool init(SmartPtr<ILinearOperator<vector_type> > L)
  {
    UG_THROW(name () << ": Cannot initialize the hybrid smoother without the geometry. Specify the 2nd argument for init!");
    return false;
  }
 
  bool apply (vector_type & c, const vector_type & d);
 
  bool apply_update_defect (vector_type & c, vector_type & d)
  {
  //  compute the correction
    if(! apply (c, d)) return false;
 
  //  update the defect d := d - A*c
    if(! m_spSysMat->matmul_minus (d, c))
      UG_THROW (name() << "::apply_update_defect: failed to execute matmul_minus");
 
    return true;
  }
 
  void set_Dirichlet
  (
    SmartPtr<EMDirichlet<TDomain, TAlgebra> > spDirichlet 
  )
  {
    m_spDirichlet = spDirichlet;
  }
  
  void set_skip_edge_smoother (bool skip_edge) {m_bSkipEdge = skip_edge;}
  void set_skip_vertex_smoother (bool skip_vertex) {m_bSkipVertex = skip_vertex;}
 
  SmartPtr<ILinearIterator<vector_type, vector_type> > clone ()
  {
    SmartPtr<this_type> newInst
      (new this_type (m_spVertApproxSpace,
        m_spEdgeSmoother->clone (), m_spVertSmoother->clone ()));
    newInst->set_Dirichlet (m_spDirichlet);
    newInst->set_skip_edge_smoother (m_bSkipEdge);
    newInst->set_skip_vertex_smoother (m_bSkipVertex);
    newInst->set_debug (this->debug_writer ());
    newInst->set_damp (this->damping ());
    return newInst;
  }
  
private: // Auxiliary functions:
 
  void compute_potential_matrix
  (
    const DoFDistribution * pEdgeDD, 
    const DoFDistribution * pVertDD 
  );
 
  void get_edge_vert_correspondence
  (
    const DoFDistribution * pEdgeDD, 
    const DoFDistribution * pVertDD 
  );
 
  void compute_GtMG ();
 
  void collect_edge_defect
  (
    const vector_type & d, 
    pot_vector_type & potDefRe, 
    pot_vector_type & potDefIm 
  );
 
  void distribute_vertex_correction
  (
    pot_vector_type & potCorRe, 
    pot_vector_type & potCorIm, 
    vector_type & c 
  );
  
#ifdef UG_PARALLEL
  struct t_red_op_or
  {
    static inline bool op (bool a, bool b) {return a || b;}
  };
  struct t_red_op_and
  {
    static inline bool op (bool a, bool b) {return a && b;}
  };
#endif
 
}; // class TimeHarmonicNedelecHybridSmoother
 
} // end namespace Electromagnetism
} // end namespace ug
 
// Implementation of the functions:
#include "hiptmair_hybrid_smoother_impl.h"
 
#endif /* __H__UG__PLUGINS__ELECTROMAGNETISM__HIPTMAIR_HYBRID_SMOOTHER__ */
 
/* End of File */