active_set.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 ACTIVE_SET_H_
#define ACTIVE_SET_H_
 
#include "lib_algebra/active_set/lagrange_multiplier_disc_interface.h"
#include "lib_disc/function_spaces/grid_function.h"
 
using namespace std;
 
namespace ug {
 
 
template <typename TDomain, typename TAlgebra>
class ActiveSet
{
  public:
    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> function_type;
 
    typedef typename domain_traits<TDomain::dim>::grid_base_object TBaseElem;
 
    static const int dim = TDomain::dim;
 
  public:
    ActiveSet() : m_bObs(false), m_spLagMultDisc(NULL) {
      //  specifies the number of fcts
      //value_type u_val;
      //m_nrFcts = GetSize(u_val);  //ToDo: This field is only used in check_dist_to_obs which is commented out. Remove it completely?
    };
 
    void set_obstacle(ConstSmartPtr<function_type> obs) {
      m_spObs = obs; m_bObs = true;
      //  if 'obs'-gridfunction is defined on a subset,
      //  which is not a boundary-subset -> UG_LOG
    }
 
    void set_lagrange_multiplier_disc(
        SmartPtr<ILagrangeMultiplierDisc<TDomain, function_type> > lagMultDisc)
    {m_spLagMultDisc = lagMultDisc;};
 
    void prepare(function_type& u);
 
    //bool check_dist_to_obs(vector_type& u);
 
    template <typename TElem, typename TIterator>
    void active_index_elem(TIterator iterBegin,
        TIterator iterEnd, function_type& u,
        function_type& rhs, function_type& lagrangeMult);
 
    bool active_index(function_type& u, function_type& rhs, function_type& lagrangeMult,
        function_type& gap);
 
    void set_dirichlet_rows(matrix_type& mat);
 
    void lagrange_multiplier(function_type& lagrangeMult, const function_type& u);
 
    void residual_lagrange_mult(vector_type& lagMult, const matrix_type& mat,
        const vector_type& u, vector_type& rhs);
 
    template <typename TElem, typename TIterator>
    bool check_conv_elem(TIterator iterBegin,
        TIterator iterEnd, function_type& u, const function_type& lambda);
 
    bool check_conv(function_type& u, const function_type& lambda, const size_t step);
 
    bool check_inequ(const matrix_type& mat, const vector_type& u,
          const vector_type& lagrangeMult, const vector_type& rhs);
 
    template <typename TElem, typename TIterator>
    void lagrange_mat_inv_elem(TIterator iterBegin,
        TIterator iterEnd, matrix_type& lagrangeMatInv);
 
    void lagrange_mat_inv(matrix_type& lagrangeMatInv);
 
  private:
    SmartPtr<DoFDistribution> m_spDD;
    SmartPtr<TDomain> m_spDom;
 
    //size_t m_nrFcts; //ToDo: This field is only used in check_dist_to_obs which is commented out. Remove it completely?
 
    ConstSmartPtr<function_type> m_spObs;
    bool m_bObs;
 
    SmartPtr<ILagrangeMultiplierDisc<TDomain, function_type> > m_spLagMultDisc;
 
    vector<int> m_vActiveSubsets;
 
    /*template <typename TElem>
    struct activeElemAndLocInd{
      TElem* pElem;             // pointer to active elem
      vector<vector<size_t> > vlocInd;  // vector of local active indices
    };*/
 
    vector<DoFIndex> m_vActiveSetGlob;
    vector<DoFIndex> m_vActiveSetGlobOld;
};
 
} // namespace ug
 
#include "active_set_impl.h"
 
#endif /* ACTIVE_SET_H_ */