data_import.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__DATA_IMPORT__
#define __H__UG__LIB_DISC__SPATIAL_DISC__DATA_IMPORT__
 
#include "user_data.h"
 
namespace ug{
 
// Data Import
 
enum DiscPart { NONE = 0,
        MASS = 1 << 0,
        STIFF = 1 << 1,
        RHS = 1 << 2,
        EXPL = 1 << 3,
        MAX_PART};
 
inline
std::ostream& operator<< (std::ostream& outStream, DiscPart part)
{
  switch(part)
  {
    case NONE: outStream << "(none)"; break;
    case MASS: outStream << "mass"; break;
    case STIFF: outStream << "stiff"; break;
    case RHS: outStream << "rhs"; break;
    case EXPL: outStream << "expl"; break;
    default: UG_THROW("Unknown DiscPart in operator<<");
  }
  return outStream;
};
 
 
template <int dim>
class IDataImport
{
  public:
    IDataImport(bool compLinDefect = true)
      : m_spICplUserData(NULL), m_part(STIFF),
       m_bCompLinDefect(compLinDefect)
    {}
 
    virtual ~IDataImport()  {}
 
    void set_part(DiscPart part) {m_part = part;}
 
    void set_none_part() {m_part = NONE;}
 
    void set_expl_part() {m_part = EXPL;}
 
    void set_mass_part() {m_part = MASS;}
 
    void set_rhs_part() {m_part = RHS;}
 
    void set_stiff_part() {m_part = STIFF;}
 
    void set_comp_lin_defect(bool b) {m_bCompLinDefect = b;}
 
    DiscPart part() const {return m_part;}
 
    virtual bool data_given() const = 0;
 
 
    virtual bool constant() const = 0;
 
 
    bool zero_derivative() const
    {
      if(!m_spICplUserData.valid()) return true;
      else if (m_spICplUserData->zero_derivative()) return true;
      else return !m_bCompLinDefect;
    }
 
    virtual SmartPtr<ICplUserData<dim> > data() = 0;
 
    void set_map(const FunctionIndexMapping& map){m_map = map;}
 
    const FunctionIndexMapping& map() const{return m_map;}
 
    const FunctionIndexMapping& conn_map() const{return m_spICplUserData->map();}
 
    size_t num_fct() const {return m_map.num_fct();}
 
    virtual void set_roid(ReferenceObjectID id) = 0;
 
    virtual void check_setup() = 0;
 
    virtual void compute_lin_defect(LocalVector& u) = 0;
 
    virtual void update_dof_sizes(const LocalIndices& ind) = 0;
 
    virtual void add_jacobian(LocalMatrix& J, const number scale) = 0;
 
    virtual void clear_ips() = 0;
 
  protected:
    SmartPtr<ICplUserData<dim> > m_spICplUserData;
 
    FunctionIndexMapping m_map;
 
  protected:
    DiscPart m_part;
 
    bool m_bCompLinDefect;
};
 
 
template <typename TData, int dim>
class DataImport : public IDataImport<dim>
{
  public:
    DataImport(bool bLinDefect = true) : IDataImport<dim>(bLinDefect),
      m_id(ROID_UNKNOWN),
      m_seriesID(-1), m_spUserData(NULL), m_vValue(NULL),
      m_numIP(0), m_spDependentUserData(NULL)
    {clear_fct();
    }
 
    ~DataImport();
 
    void set_data(SmartPtr<CplUserData<TData, dim> > spData);
 
    SmartPtr<ICplUserData<dim> > data() {return m_spUserData.template cast_dynamic<ICplUserData<dim> >();}
 
    SmartPtr<CplUserData<TData, dim> > user_data(){return m_spUserData;}
 
    virtual bool data_given() const {return m_spUserData.valid();}
 
 
  // Data
 
    virtual bool constant() const
    {
      if(data_given()) return m_spUserData->constant();
      else return false;
    }
 
    const TData& operator[](size_t ip) const{check_ip(ip); return m_vValue[ip];}
 
    const TData* values() const {check_values(); return m_vValue;}
 
    const TData* deriv(size_t ip, size_t fct) const
    {
      UG_ASSERT(m_spDependentUserData.valid(), "No Dependent Data set");
      UG_ASSERT(m_seriesID >= 0, "No series ticket set");
      return m_spDependentUserData->deriv(m_seriesID, ip, fct);
    }
 
    const TData& deriv(size_t ip, size_t fct, size_t dof) const
    {
      UG_ASSERT(m_spDependentUserData.valid(), "No Dependent Data set");
      UG_ASSERT(m_seriesID >= 0, "No series ticket set");
      return m_spDependentUserData->deriv(m_seriesID, ip, fct, dof);
    }
 
  // Positions
 
    size_t num_ip() const {return m_numIP;}
 
    template <int ldim>
    void set_local_ips(const MathVector<ldim>* vPos, size_t numIP, int timePointSpec,
                       bool bMayChange = true);
 
    void set_local_ips(const MathVector<dim>* vPos, size_t numIP, int timePointSpec,
                       bool bMayChange = true);
 
    template <int ldim>
    void set_local_ips(const MathVector<ldim>* vPos, size_t numIP,
                       bool bMayChange = true);
 
    void set_local_ips(const MathVector<dim>* vPos, size_t numIP,
                       bool bMayChange = true);
 
    void set_time_point(int timePointSpec);
 
    void set_global_ips(const MathVector<dim>* vPos, size_t numIP);
 
    const MathVector<dim>& position(size_t i) const
    {
      if(data_given()) return m_spUserData->ip(m_seriesID, i);
       UG_THROW("DataImport::position: "
               "No Data set, but positions requested.");
    }
 
    virtual void clear_ips();
 
  // Linearization of Defect
 
    size_t num_sh(size_t fct) const
    {
      UG_ASSERT(fct <  m_vvNumDoFPerFct[fct], "Invalid index");
      return m_vvNumDoFPerFct[fct];
    }
 
    TData* lin_defect(size_t ip, size_t fct)
      {check_ip_fct(ip,fct);return &(m_vvvLinDefect[ip][fct][0]);}
 
    const TData* lin_defect(size_t ip, size_t fct) const
      {check_ip_fct(ip,fct);return &(m_vvvLinDefect[ip][fct][0]);}
 
    TData& lin_defect(size_t ip, size_t fct, size_t sh)
      {check_ip_fct_sh(ip,fct,sh);return m_vvvLinDefect[ip][fct][sh];}
 
    const TData& lin_defect(size_t ip, size_t fct, size_t sh) const
      {check_ip_fct_sh(ip,fct,sh);return m_vvvLinDefect[ip][fct][sh];}
 
    void add_jacobian(LocalMatrix& J, const number scale);
 
    virtual void update_dof_sizes(const LocalIndices& ind);
 
  public:
    typedef boost::function<void (const LocalVector& u,
                                  std::vector<std::vector<TData> > vvvLinDefect[],
                                  const size_t nip)> LinDefectFunc;
 
    virtual void set_roid(ReferenceObjectID id);
 
    virtual void check_setup();
 
    template <typename TClass>
    void set_fct(ReferenceObjectID id, TClass* obj,
                 void (TClass::*func)(
                     const LocalVector& u,
                     std::vector<std::vector<TData> > vvvLinDefect[],
                     const size_t nip));
 
    void set_fct(ReferenceObjectID id,
           void (*func)(
               const LocalVector& u,
               std::vector<std::vector<TData> > vvvLinDefect[],
               const size_t nip));
 
    void clear_fct();
 
    virtual void compute_lin_defect(LocalVector& u)
    {
      if (! m_spUserData->at_current_time (m_seriesID))
        return;
      UG_ASSERT(m_vLinDefectFunc[m_id] != NULL, "No evaluation function.");
      UG_ASSERT(num_ip() == 0 || m_vvvLinDefect.size() >= num_ip(),
                "DataImport: Num ip "<<num_ip()<<", but memory: "<<m_vvvLinDefect.size());
      u.access_by_map(this->map());
      (m_vLinDefectFunc[m_id])(u, &m_vvvLinDefect[0], m_numIP);
    }
 
  protected:
    inline void check_ip_fct(size_t ip, size_t fct) const;
 
    inline void check_ip_fct_sh(size_t ip, size_t fct, size_t sh) const;
 
    inline void check_ip(size_t ip) const;
 
    inline void check_values() const;
 
    void cache_data_access();
 
    void resize_defect_array();
 
    ReferenceObjectID m_id;
 
    LinDefectFunc m_vLinDefectFunc[NUM_REFERENCE_OBJECTS];
 
    int m_seriesID;
 
    SmartPtr<CplUserData<TData, dim> > m_spUserData;
 
    const TData* m_vValue;
 
    size_t m_numIP;
 
    SmartPtr<DependentUserData<TData, dim> > m_spDependentUserData;
 
    std::vector<size_t> m_vvNumDoFPerFct;
 
    std::vector<std::vector<std::vector<TData> > > m_vvvLinDefect;
};
 
} // end namespace ug
 
// include implementation
#include "data_import_impl.h"
 
#endif /* __H__UG__LIB_DISC__SPATIAL_DISC__DATA_IMPORT__ */