linker.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-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__DATA_LINKER__
#define __H__UG__LIB_DISC__SPATIAL_DISC__DATA_LINKER__
 
#include "../std_user_data.h"
#include "lib_disc/common/groups_util.h"
 
namespace ug{
 
 
template <typename TImpl, typename TData, int dim>
class StdDataLinker
  : public StdUserData< StdDataLinker<TImpl, TData, dim>,
              TData, dim, void,
              DependentUserData<TData, dim> >
{
  public:
    virtual void operator() (TData& value,
                 const MathVector<dim>& globIP,
                 number time, int si) const;
 
    virtual void operator()(TData vValue[],
                const MathVector<dim> vGlobIP[],
                number time, int si, const size_t nip) const;
 
    template <int refDim>
    inline void evaluate(TData vValue[],
               const MathVector<dim> vGlobIP[],
               number time, int si,
               GridObject* elem,
               const MathVector<dim> vCornerCoords[],
               const MathVector<refDim> vLocIP[],
               const size_t nip,
               LocalVector* u,
               const MathMatrix<refDim, dim>* vJT = NULL) const;
 
    virtual void compute(LocalVector* u, GridObject* elem,
               const MathVector<dim> vCornerCoords[], bool bDeriv = false);
    virtual void compute(LocalVectorTimeSeries* u, GridObject* elem,
               const MathVector<dim> vCornerCoords[], bool bDeriv = false);
 
  protected:
    template <int refDim>
    void eval_deriv(LocalVector* u, GridObject* elem,
                    const MathVector<dim> vCornerCoords[], bool bDeriv = false);
    template <int refDim>
    void eval_deriv(LocalVectorTimeSeries* u, GridObject* elem,
                    const MathVector<dim> vCornerCoords[], bool bDeriv = false);
 
  public:
    virtual bool requires_grid_fct() const;
 
    virtual bool continuous() const;
 
    virtual bool zero_derivative() const;
 
  public:
    bool zero_derivative(size_t i) const
    {
      if(!m_vspICplUserData[i].valid()) return true;
      return m_vspICplUserData[i]->zero_derivative();
    }
 
    void set_num_input(size_t num)
    {
      m_vspICplUserData.resize(num);
      m_vspUserDataInfo.resize(num);
    }
 
    virtual void set_input(size_t i,
                           SmartPtr<ICplUserData<dim> > input,
                           SmartPtr<UserDataInfo> info)
    {
      UG_ASSERT(i < m_vspICplUserData.size(), "invalid index");
      m_vspICplUserData[i] = input;
      m_vspUserDataInfo[i] = info;
    }
 
    virtual size_t num_input() const {return num_needed_data();}
 
    virtual size_t num_needed_data() const {return m_vspICplUserData.size();}
 
    virtual SmartPtr<ICplUserData<dim> > needed_data(size_t i)
    {
      UG_ASSERT(i < m_vspICplUserData.size(), "Input not needed");
      UG_ASSERT(m_vspICplUserData[i].valid(), "Data input not valid");
      return m_vspICplUserData[i];
    }
 
    virtual void check_setup() const;
 
    virtual void set_function_pattern(ConstSmartPtr<FunctionPattern> fctPatt);
 
  protected:
    size_t input_num_fct(size_t i) const
    {
      UG_ASSERT(i < m_vspUserDataInfo.size(), "Input invalid");
      if(!m_vspUserDataInfo[i].valid()) return 0;
      return m_vspUserDataInfo[i]->num_fct();
    }
 
    size_t input_common_fct(size_t i, size_t fct) const
    {
      UG_ASSERT(i < m_vMap.size(), "Input Map invalid");
      UG_ASSERT(fct < m_vMap[i].num_fct(), "Input Map invalid for fct");
      return m_vMap[i][fct];
    }
 
    size_t series_id(size_t i, size_t s) const
    {
      UG_ASSERT(i < m_vvSeriesID.size(), "invalid index");
      UG_ASSERT(s < m_vvSeriesID[i].size(), "invalid index");
      return m_vvSeriesID[i][s];
    }
 
    virtual void local_ip_series_added(const size_t seriesID);
 
    virtual void local_ips_changed(const size_t seriesID, const size_t newNumIP);
 
    virtual void local_ip_series_to_be_cleared();
 
    virtual void global_ips_changed(const size_t seriesID, const MathVector<dim>* vPos, const size_t numIP);
 
  protected:
    std::vector<SmartPtr<ICplUserData<dim> > > m_vspICplUserData;
 
    std::vector<SmartPtr<UserDataInfo> > m_vspUserDataInfo;
 
    std::vector<FunctionIndexMapping> m_vMap;
 
    std::vector<std::vector<size_t> > m_vvSeriesID;
 
  protected:
    TImpl& getImpl() {return static_cast<TImpl&>(*this);}
 
    const TImpl& getImpl() const {return static_cast<const TImpl&>(*this);}
};
 
} // end namespace ug
 
//  include implementation
#include "linker_impl.h"
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__DATA_LINKER__ */