constraint_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * 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__SPATIAL_DISC__CONSTRAINTS__CONSTRAINTS__INTERFACE__
#define __H__UG__LIB_DISC__SPATIAL_DISC__CONSTRAINTS__CONSTRAINTS__INTERFACE__
 
// extern headers
#include <vector>
 
// intern headers
#include "lib_disc/assemble_interface.h"
#include "lib_disc/common/local_algebra.h"
#include "lib_disc/dof_manager/dof_distribution.h"
#include "lib_disc/function_spaces/approximation_space.h"
 
namespace ug{
 
 
template <typename TAlgebra>
class IConstraint
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
  public:
    virtual void adjust_jacobian(matrix_type& J, const vector_type& u,
                                 ConstSmartPtr<DoFDistribution> dd, int type, number time = 0.0,
                                 ConstSmartPtr<VectorTimeSeries<vector_type> > vSol = SPNULL,
                   const number s_a0 = 1.0) = 0;
 
    virtual void adjust_defect(vector_type& d, const vector_type& u,
                   ConstSmartPtr<DoFDistribution> dd, int type, number time = 0.0,
                   ConstSmartPtr<VectorTimeSeries<vector_type> > vSol = SPNULL,
                   const std::vector<number>* vScaleMass = NULL,
                   const std::vector<number>* vScaleStiff = NULL) = 0;
 
    virtual void adjust_linear(matrix_type& mat, vector_type& rhs,
                               ConstSmartPtr<DoFDistribution> dd, int type, number time = 0.0)  = 0;
 
    virtual void adjust_rhs(vector_type& rhs, const vector_type& u,
                            ConstSmartPtr<DoFDistribution> dd, int type, number time = 0.0)  = 0;
 
    virtual void adjust_solution(vector_type& u, ConstSmartPtr<DoFDistribution> dd, int type,
                   number time = 0.0)  = 0;
 
    virtual void adjust_correction(vector_type& c, ConstSmartPtr<DoFDistribution> dd, int type,
                     number time = 0.0) {adjust_solution(c, dd, type, time);}
 
    virtual void adjust_linear_residual(vector_type& d, const vector_type& u,
                                   ConstSmartPtr<DoFDistribution> dd, int type, number time = 0.0)
    {adjust_correction(d, dd, type, time);}
 
    virtual void adjust_error(const vector_type& u, ConstSmartPtr<DoFDistribution> dd, int type,
                  number time = 0.0,
                  ConstSmartPtr<VectorTimeSeries<vector_type> > vSol = SPNULL,
                  const std::vector<number>* vScaleMass = NULL,
                  const std::vector<number>* vScaleStiff = NULL) {};
 
    virtual void adjust_prolongation(matrix_type& P,
                                     ConstSmartPtr<DoFDistribution> ddFine,
                                     ConstSmartPtr<DoFDistribution> ddCoarse,
                     int type,
                                     number time = 0.0) {};
 
    virtual void adjust_restriction(matrix_type& R,
                                    ConstSmartPtr<DoFDistribution> ddCoarse,
                                    ConstSmartPtr<DoFDistribution> ddFine,
                    int type,
                                    number time = 0.0) {};
 
    virtual void adjust_restriction(vector_type& uCoarse, GridLevel coarseLvl,
                    const vector_type& uFine, GridLevel fineLvl,
                    int type) {};
 
    virtual void adjust_prolongation(vector_type& uFine, GridLevel fineLvl,
                    const vector_type& uCoarse, GridLevel coarseLvl,
                    int type) {};
 
    virtual void modify_solution(vector_type& uMod, const vector_type& u,
                    ConstSmartPtr<DoFDistribution> dd, int type) {};
 
    virtual void modify_solution(SmartPtr<VectorTimeSeries<vector_type> > vSolMod,
        ConstSmartPtr<VectorTimeSeries<vector_type> > vSol,
        ConstSmartPtr<DoFDistribution> dd,
        int type) {};
 
    virtual int type() const = 0;
 
    virtual ~IConstraint() {};
 
};
 
template <typename TDomain, typename TAlgebra>
class IDomainConstraint : public IConstraint<TAlgebra>
{
  public:
    typedef TDomain domain_type;
 
    typedef TAlgebra algebra_type;
 
    typedef typename algebra_type::matrix_type matrix_type;
 
    typedef typename algebra_type::vector_type vector_type;
 
  public:
    IDomainConstraint() : IConstraint<TAlgebra>(),
        m_bDoErrEst(false), m_spErrEstData(SPNULL) {};
 
    virtual void set_approximation_space(SmartPtr<ApproximationSpace<TDomain> > approxSpace)
    {
      m_spApproxSpace = approxSpace;
    }
 
    SmartPtr<ApproximationSpace<TDomain> > approximation_space()
    {
      return m_spApproxSpace;
    }
 
    ConstSmartPtr<ApproximationSpace<TDomain> > approximation_space() const
    {
      return m_spApproxSpace;
    }
 
    virtual int type() const = 0;
 
    void set_ass_tuner(ConstSmartPtr<AssemblingTuner<TAlgebra> > spAssemblingTuner = NULL)
    {
      m_spAssTuner = spAssemblingTuner;
    }
 
  // //////////////////////////
  // Error estimator
  // //////////////////////////
  public:
 
    void set_error_estimator(SmartPtr<IErrEstData<TDomain> > ee) {m_spErrEstData = ee; m_bDoErrEst = true;}
 
    bool err_est_enabled() const {return m_bDoErrEst;}
 
    virtual SmartPtr<IErrEstData<TDomain> > err_est_data() {return m_spErrEstData;}
 
  private:
    bool m_bDoErrEst;
 
  protected:
    SmartPtr<IErrEstData<TDomain> > m_spErrEstData;
 
  // ///////////////////////////
 
 
  protected:
    ConstSmartPtr<DoFDistribution> dd(const GridLevel& gl) const
    {
      return m_spApproxSpace->dof_distribution(gl);
    }
 
  protected:
    SmartPtr<ApproximationSpace<TDomain> > m_spApproxSpace;
 
    ConstSmartPtr<AssemblingTuner<TAlgebra> > m_spAssTuner;
 
};
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__CONSTRAINTS__CONSTRAINTS__INTERFACE__ */