ls_volume.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015:  G-CSC, Goethe University Frankfurt
 * Authors: Christian Wehner, 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.
 */
 
#ifndef __H__UG__PLUGINS__LEVEL_SET__LS_VOLUME_H__
#define __H__UG__PLUGINS__LEVEL_SET__LS_VOLUME_H__
 
// ug4 headers
#include "common/common.h"
#include "lib_grid/grid_objects/grid_objects.h"
#include "lib_grid/grid_objects/tetrahedron_rules.h"
#include "lib_disc/common/geometry_util.h"
 
namespace ug{
namespace LevelSet{
 
template <typename TGridFunc>
class LSVolume
{
public:
 
  typedef LSVolume<TGridFunc> this_type;
 
  typedef TGridFunc grid_func_type;
 
  typedef typename grid_func_type::domain_type domain_type;
  
  typedef typename grid_func_type::algebra_type algebra_type;
 
  typedef typename domain_type::position_accessor_type position_accessor_type;
  
  static const int dim = domain_type::dim;
  
public:
 
  LSVolume
  (
    SmartPtr<grid_func_type> spLSF 
  )
  : m_spLSF (spLSF),
    m_volume_plus (-1), m_volume_minus (-1), // dummy values
    m_check_positivity (false)
  {};
  
  void on_subsets
  (
    const char * ss_names 
  );
 
  void check_positivity (bool v) {m_check_positivity = v;}
  
  void compute ();
  
  void compute
  (
    SmartPtr<UserData<number, dim> > spDensity, 
    number time 
  );
  
  void compute
  (
    SmartPtr<UserData<number, dim> > spDensity 
  )
  {compute (spDensity, 0);}
  
#ifdef UG_FOR_LUA
  void compute (LuaFunctionHandle density_fct) {compute (make_sp(new LuaUserData<number, dim> (density_fct)));}
  void compute (const char * density_fct_name) {compute (LuaUserDataFactory<number, dim>::create(density_fct_name));}
#endif
  
  void volume_in_subsets
  (
    const char * ss_names, 
    number & vol_plus, 
    number & vol_minus 
  ) const;
  
  number volume_plus () const {return m_volume_plus;}
  
  number volume_plus_in_subsets
  (
    const char * ss_names 
  ) const
  {
    number vol_plus, vol_minus;
    volume_in_subsets (ss_names, vol_plus, vol_minus);
    return vol_plus;
  }
  
  number volume_minus () const {return m_volume_minus;}
  
  number volume_minus_in_subsets
  (
    const char * ss_names 
  ) const
  {
    number vol_plus, vol_minus;
    volume_in_subsets (ss_names, vol_plus, vol_minus);
    return vol_minus;
  }
  
  void print_details () const;
  
private:
 
  template <typename TElem>
  void add_volumes_of_all ();
  
  struct AddVolumes
  {
    this_type * m_pThis;
    
    AddVolumes
    (
      this_type * pThis 
    )
    : m_pThis (pThis) {}
    
    template <typename TElem> void operator() (TElem)
    {
      m_pThis->template add_volumes_of_all<TElem> ();
    }
  };
  
  template <typename TElem>
  void add_volumes_of_all
  (
    UserData<number, dim> * pDensity, 
    number time 
  );
  
  struct AddWeightedVolumes
  {
    this_type * m_pThis;
    UserData<number, dim> * m_pDensity;
    number m_time;
    
    AddWeightedVolumes
    (
      this_type * pThis, 
      UserData<number, dim> * pDensity, 
      number time 
    )
    : m_pThis (pThis), m_pDensity (pDensity), m_time (time) {}
    
    template <typename TElem> void operator() (TElem)
    {
      m_pThis->template add_volumes_of_all<TElem> (m_pDensity, m_time);
    }
  };
  
#ifdef UG_PARALLEL
//  Sum up the volumes from different processes
  void allreduce_volumes ();
#endif
 
private:
 
  SmartPtr<TGridFunc> m_spLSF; 
  
  SubsetGroup m_ssGrp; 
  
  number m_volume_plus; 
  number m_volume_minus; 
  
  std::vector<number> m_ss_vol_plus; 
  std::vector<number> m_ss_vol_minus; 
  
  bool m_check_positivity; 
};
 
template <typename TRefElem, int WDim>
class LSElementSize
{
public:
  
  typedef TRefElem ref_element_type; 
  static const int dim = WDim; 
  
public:
 
 
  static int compute
  (
    const MathVector<WDim> * corner, 
    const number * lsf, 
    number & vol_plus, 
    number & vol_minus 
  )
  {
    UG_THROW ("LSElementSize: Generic version not implemented");
    return 0; // never reached
  }
};
 
template <int WDim>
class LSElementSize<ReferenceEdge, WDim>
{
public:
  
  typedef ReferenceEdge ref_element_type; 
  static const int dim = WDim; 
  
public:
 
 
  static int compute
  (
    const MathVector<WDim> * corner, 
    const number * lsf, 
    number & vol_plus, 
    number & vol_minus 
  );
};
 
template <int WDim>
class LSElementSize<ReferenceTriangle, WDim>
{
public:
  
  typedef ReferenceTriangle ref_element_type; 
  static const int dim = WDim; 
  
public:
 
 
  static int compute
  (
    const MathVector<WDim> * corner, 
    const number * lsf, 
    number & vol_plus, 
    number & vol_minus 
  );
};
 
template <int WDim>
class LSElementSize<ReferenceTetrahedron, WDim>
{
public:
  
  typedef ReferenceTetrahedron ref_element_type; 
  static const int dim = WDim; 
  
public:
 
 
  static int compute
  (
    const MathVector<WDim> * corner, 
    const number * lsf, 
    number & vol_plus, 
    number & vol_minus 
  );
};
    
template <int WDim>
class LSElementSize<ReferencePrism, WDim>
{
public:
  
  typedef ReferencePrism ref_element_type; 
  static const int dim = WDim; 
  
public:
 
 
  static int compute
  (
    const MathVector<WDim> * corner, 
    const number * lsf, 
    number & vol_plus, 
    number & vol_minus 
  );
};
 
} // end namespace LevelSet
} // end namespace ug
 
// include implementation
#include "ls_volume_impl.h"
 
#endif // __H__UG__PLUGINS__LEVEL_SET__LS_VOLUME_H__
 
/* End of File */