subset_indicator_user_data.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015:  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.
 */
 
/*
 * User data of a subset indicator (1 in the subset, 0 everywhere else)
 */
#ifndef __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__SSIND_USER_DATA__
#define __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__SSIND_USER_DATA__
 
#include <vector>
 
// ug4 headers
#include "common/common.h"
#include "common/math/ugmath.h"
#include "lib_disc/spatial_disc/user_data/std_glob_pos_data.h"
 
namespace ug {
 
 
template <typename TDomain>
class SubsetIndicatorUserData
  : public StdUserData<SubsetIndicatorUserData<TDomain>, number, TDomain::dim, void, UserData<number, TDomain::dim, void> >
{
public:
  typedef TDomain domain_type;
  
  static const int dim = domain_type::dim;
  
  typedef typename domain_type::subset_handler_type subset_handler_type;
 
private:
  SubsetGroup m_ssGrp;
  
public:
 
  SubsetIndicatorUserData
  (
    ConstSmartPtr<domain_type> domain, 
    const char * ss_names 
  )
  : m_ssGrp (domain->subset_handler ())
  {
  // Parse the subset names:
    std::vector<std::string> vssNames;
    try
    {
      TokenizeString (ss_names, vssNames);
      for (size_t k = 0; k < vssNames.size (); k++)
        RemoveWhitespaceFromString (vssNames [k]);
      m_ssGrp.clear ();
      m_ssGrp.add (vssNames);
    } UG_CATCH_THROW ("SubsetIndicatorUserData: Failed to parse subset names.");
  }
 
  virtual bool continuous () const {return false;}
 
  virtual bool requires_grid_fct () const {return true;}
 
  template <int refDim>
  inline void evaluate
  (
    number 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
  {
  //  Get the subset index of the element
    int elem_si = m_ssGrp.subset_handler()->get_subset_index (elem);
  //  Check if the element is in one of the specified subsets:
    number indicator = (m_ssGrp.contains (elem_si))? 1 : 0;
  //  Return the indicator:
    for (size_t i = 0; i < nip; i++)
      vValue [i] = indicator;
  };
  
  void operator()
  (
    number & vValue,
    const MathVector<dim> & globIP,
    number time,
    int si
  )
  const
  {
  //  Check if si is in one of the specified subsets:
    vValue = (m_ssGrp.contains (si))? 1 : 0;
  }
 
  void operator()
  (
    number vValue [],
    const MathVector<dim> vGlobIP [],
    number time,
    int si,
    const size_t nip
  ) const
  {
  //  Check if si is in one of the specified subsets:
    number indicator = (m_ssGrp.contains (si))? 1 : 0;
  //  Return the indicator:
    for (size_t i = 0; i < nip; i++)
      vValue [i] = indicator;
  }
};
 
 
template <typename TDomain>
class ValueIndicatorUserData
  : public StdUserData<ValueIndicatorUserData<TDomain>, number, TDomain::dim, void, UserData<number, TDomain::dim, void> >
{
  static const int dim = TDomain::dim;
  
  typedef TDomain domain_type;
  
  typedef typename TDomain::grid_type grid_type;
  
  SmartPtr<UserData<number, dim, void> > m_spData;
  
  number m_threshold;
  
  bool m_greater;
  
public:
 
  ValueIndicatorUserData
  (
    SmartPtr<UserData<number, dim, void> > spData, 
    number threshold, 
    bool greater 
  )
  : m_spData (spData), m_threshold (threshold), m_greater (greater)
  {
    if (m_spData.invalid ())
      UG_THROW ("ValueIndicatorUserData: No userdata specified!");
  }
 
  virtual bool continuous () const {return m_spData->continuous ();}
 
  virtual bool requires_grid_fct () const {return m_spData->requires_grid_fct ();}
 
  template <int refDim>
  inline void evaluate
  (
    number 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
  {
  //  Call the original UserData, get the values
    (* m_spData) (vValue, vGlobIP, time, si, elem, vCornerCoords, vLocIP, nip, u, vJT);
  
  //  Reset the values
    reset_values (vValue, nip);
  };
  
  void operator()
  (
    number & vValue,
    const MathVector<dim> & globIP,
    number time,
    int si
  )
  const
  {
  //  Call the original UserData, get the values
    (* m_spData) (vValue, globIP, time, si);
  
  //  Reset the values
    reset_values (&vValue, 1);
  }
 
  void operator()
  (
    number vValue [],
    const MathVector<dim> vGlobIP [],
    number time,
    int si,
    const size_t nip
  ) const
  {
  //  Call the original UserData, get the values
    (* m_spData) (vValue, vGlobIP, time, si, nip);
  
  //  Reset the values
    reset_values (vValue, nip);
  }
  
private:
  
  void reset_values (number vValue [], const size_t nip) const
  {
    if (m_greater)
      for (size_t i = 0; i < nip; i++)
        if (vValue[i] >= m_threshold) vValue[i] = 1; else vValue[i] = 0;
    else
      for (size_t i = 0; i < nip; i++)
        if (vValue[i] <= m_threshold) vValue[i] = 1; else vValue[i] = 0;
  }
};
 
} // end namespace ug
 
#endif // __H__UG__LIB_DISC__SPATIAL_DISC__USER_DATA__SSIND_USER_DATA__
 
/* End of File */