hrfblsm_discr.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.
 */
 
/*
 * High-resolution flux-based level set method
 */
#ifndef __H__UG__PLUGINS__LEVEL_SET__HR_FB_LSM_DISCR_H__
#define __H__UG__PLUGINS__LEVEL_SET__HR_FB_LSM_DISCR_H__
 
#include <string>
 
// ug4 headers
#include "common/common.h"
#include "lib_algebra/operator/debug_writer.h"
#include "lib_disc/function_spaces/grid_function.h"
#include "lib_disc/function_spaces/grid_function_user_data.h"
#ifdef UG_FOR_LUA
#include "bindings/lua/lua_user_data.h"
#endif
 
namespace ug{
namespace LevelSet{
 
template<typename TGridFunction>
class HiResFluxBasedLSM
: public DebugWritingObject<typename TGridFunction::algebra_type>
{
  typedef typename TGridFunction::domain_type domain_type;
  
  typedef typename TGridFunction::algebra_type algebra_type;
 
  static const int dim = domain_type::dim;
 
  typedef typename domain_type::grid_type grid_type;
 
  typedef typename domain_type::position_accessor_type position_accessor_type;
  
  typedef Attachment<MathVector<dim> > ADimVector;
 
  typedef typename Grid::VertexAttachmentAccessor<ANumber> t_aaVol;
 
  typedef typename Grid::VertexAttachmentAccessor<ADimVector> t_aaGrad;
  
  typedef typename Grid::VertexAttachmentAccessor<ANumber> t_aaUpd;
 
  typedef typename Grid::VertexAttachmentAccessor<ABool> t_aaCoIE;
 
  typedef typename TGridFunction::template dim_traits<dim>::grid_base_object ElemType;
 
  typedef typename TGridFunction::template traits<Edge>::const_iterator EdgeConstIterator;
 
  typedef typename TGridFunction::template traits<Vertex>::const_iterator VertexConstIterator;
  
  typedef typename TGridFunction::template dim_traits<dim>::const_iterator ElemIterator;
 
  static const size_t maxNumCo = DimFV1Geometry<dim>::maxNumSCV;
  static const size_t maxNumIP = DimFV1Geometry<dim>::maxNumSCVF;
  
  static number lsf_threshold () {return 1e-8;}
  
public:
 
  HiResFluxBasedLSM()
  : m_bVerbose (false), m_dt (0), m_nrOfSteps (1),
    m_time_control (false), m_maxCFL (0.95), m_minCFL (0.85),
    m_gamma (1), m_delta (0), m_divFree (false),
    m_firstOrder (false), m_antiderivSrc (false), m_elem_vel_vec (false),
    m_limiter (false),
    m_time (0), m_CFL (0)
  {
    set_source (0);
  }
 
  virtual ~HiResFluxBasedLSM() {};
  
//  Controls
 
  void set_verbose (bool b) { m_bVerbose = b; }
 
  void set_solutions
  (
    SmartPtr<TGridFunction> uOld, 
    SmartPtr<TGridFunction> uNew 
  )
  {
    m_oldSol = uOld; m_newSol = uNew;
  }
 
  void set_LSF (SmartPtr<TGridFunction> spLSF) { m_spLSF = spLSF; }
  
  void set_SDF (SmartPtr<TGridFunction> spSDF) { m_spSDF = spSDF; }
  
  void set_vel_potential (SmartPtr<TGridFunction> spVelPot) { m_spVelPot = spVelPot; }
 
  void set_dt (number dt) { m_dt = dt; }
  
  number get_dt () { return m_dt; }
  
  void set_time_control (number minCFL, number maxCFL)
    { m_time_control = true; m_minCFL = minCFL; m_maxCFL = maxCFL; }
    
  void set_time_control_off () { m_time_control = false; }
 
  void set_nr_of_steps (size_t n) { m_nrOfSteps = n; }
  
  void set_time (number t) { m_time = t; }
  number get_time () { return m_time; }
  number get_CFL () { return m_CFL; }
  
  void set_gamma (number gamma) { m_gamma = gamma; }
  
  void set_delta (number delta) { m_delta = delta; }
  
  void set_divfree (bool b) { m_divFree = b; }
  
  void set_first_order (bool b) { m_firstOrder = b; }
  
  void set_antideriv_src (bool b) { m_antiderivSrc = b; }
  
  void set_elem_vel_vec (bool b) { m_elem_vel_vec = b; }
  
  void set_limiter (bool b) { m_limiter = b; }
  
  void set_source (number val) { m_source_pos = val; m_source_neg = - val; }
  
  void set_source_neg (number val) { m_source_neg = val; }
 
  void set_source_pos (number val) { m_source_pos = val; }
  
  void set_velocity (SmartPtr<CplUserData<MathVector<dim>, dim> > vel) {m_imVelocity = vel;}
#ifdef UG_FOR_LUA
  void set_velocity (const char* fctName) { set_velocity (LuaUserDataFactory<MathVector<dim>,dim>::create (fctName)); }
#endif
  
  void set_normal_velocity (SmartPtr<CplUserData<number, dim> > vel) {m_imNormalVel = vel;}
#ifdef UG_FOR_LUA
  void set_normal_velocity (const char* fctName) { set_normal_velocity (LuaUserDataFactory<number,dim>::create (fctName)); }
#endif
  
  void set_interface_data (SmartPtr<CplUserData<number,dim> > d) { m_imInterfaceVal = d; }
#ifdef UG_FOR_LUA
  void set_interface_data (const char* fctName) { set_interface_data (LuaUserDataFactory<number,dim>::create (fctName)); }
#endif
 
  void set_dirichlet_data (SmartPtr<CplUserData<number,dim> > d) { m_imDirichlet = d; }
  void set_dirichlet_data (number val) { set_dirichlet_data (make_sp (new ConstUserNumber<dim> (val))); }
#ifdef UG_FOR_LUA
  void set_dirichlet_data (const char* fctName) { set_dirichlet_data (LuaUserDataFactory<number,dim>::create (fctName)); }
#endif
 
  void set_dirichlet_boundary (const char* subsets);
 
  void set_outflow_boundary (const char* subsets);
  
  void prepare_for_SDF
  (
    SmartPtr<TGridFunction> uOld, 
    SmartPtr<TGridFunction> uNew 
  )
  {
    set_solutions (uOld, uNew);
    set_SDF (uOld);
    set_vel_potential (uOld);
    set_delta (1);
    set_gamma (0);
    set_source (1);
  }
  
//  Computation
 
  void advect ();
  
  void compute_normal_vel
  (
    SmartPtr<CplUserData<MathVector<dim>, dim> > spVelField,
    SmartPtr<TGridFunction> spNormVel
  );
    
  void append_vertical_to_normal_vel
  (
    SmartPtr<CplUserData<number, dim> > spNVelField,
    SmartPtr<TGridFunction> spNormVel
  );
  
  void append_vertical_to_normal_vel
  (
    SmartPtr<TGridFunction> spNVelGF,
    const char * cmp,
    SmartPtr<TGridFunction> spNormVel
  )
  {
    append_vertical_to_normal_vel
    (
      SmartPtr<CplUserData<number, dim> > (new GridFunctionNumberData<TGridFunction> (spNVelGF, cmp)),
      spNormVel
    );
  }
  
#ifdef UG_FOR_LUA
  void compute_normal_vel
  (
    const char* fctName,
    SmartPtr<TGridFunction> spNormVel
  )
  {
    compute_normal_vel (LuaUserDataFactory<MathVector<dim>,dim>::create (fctName), spNormVel);
  }
#endif
  
  void compare_lsf_with
  (
    SmartPtr<TGridFunction> spLSF2, 
    number eps 
  );
  
  void save_CourantNumber_to
  (
    SmartPtr<TGridFunction> spCN 
  )
  {
    m_spCourant = spCN;
  }
 
private:
 
//  Auxiliary tools
 
  void limit_grad(TGridFunction& uOld, t_aaGrad& aaGradient);
 
  inline void sol_update
  (
    bool redOrder,
    const MathVector<dim>& ip,
    const MathVector<dim>& x_up,
    number u_up,
    const MathVector<dim>& grad_up,
    const MathVector<dim>& vel_up,
    const MathVector<dim>& x_down,
    number u_down,
    const MathVector<dim>& grad_down,
    const MathVector<dim>& vel_down,
    number& corr_up,
    number& curr_down,
    number& src_up,
    number& src_down
  );
  inline void bnd_sol_update
  (
    bool redOrder,
    const MathVector<dim>& bip,
    const MathVector<dim>& x,
    number u,
    const MathVector<dim>& grad,
    const MathVector<dim>& vel,
    number& curr
  );
  inline void get_nodal_vel
  (
    ElemType* elem,
    MathVector<dim> coCoord[],
    DimFV1Geometry<dim>& geo,
    LocalVector& u,
    MathVector<dim> grad[],
    MathVector<dim> co_vel[],
    int lsf_sign
  );
  void assemble_element
  (
    ElemType* elem,
    DimFV1Geometry<dim>& geo,
    domain_type& grid,
    LocalVector& uOld,
    t_aaGrad& aaGradient,
    t_aaGrad& aaVelGrad,
    t_aaVol& aaVolume,
    int sign,
    t_aaUpd& aaUpdate,
    t_aaUpd* aaSrc
  );
  void get_scvf_vel_on_if
  (
    DimFV1Geometry<dim>& geo,
    const typename DimFV1Geometry<dim>::SCVF& scvf,
    number u[],
    MathVector<dim> grad[],
    number lsf[],
    MathVector<dim>& from_co_vel,
    number& from_flux,
    MathVector<dim>& to_co_vel,
    number& to_flux
  );
  void get_bf_vel_on_if
  (
    DimFV1Geometry<dim>& geo,
    const typename DimFV1Geometry<dim>::BF& bf,
    number u[],
    MathVector<dim> grad[],
    number lsf[],
    MathVector<dim>& co_vel,
    number& flux
  );
  int assemble_cut_element
  (
    ElemType* elem,
    DimFV1Geometry<dim>& geo,
    domain_type& domain,
    LocalVector& uOld,
    LocalVector& locLSF,
    LocalVector& locVelPot,
    t_aaGrad& aaGradient,
    t_aaGrad& aaVelGrad,
    t_aaVol& aaVolume,
    t_aaUpd& aaUpdate,
    t_aaUpd* aaSrc,
    CplUserData<number,dim> * if_val_data,
    int si
  );
 
  void compute_volumes
  (
    TGridFunction& u,
    DimFV1Geometry<dim>& geo,
    ANumber& aVolume,
    t_aaVol& aaVolume
  );
  
  void compute_elem_grad
  (
    DimFV1Geometry<dim> & geo,
    number uValue [],
    MathVector<dim> co_grad [],
    number * lsf,
    CplUserData<number,dim> * if_val_data,
    int si
  );
  void compute_vertex_grad
  (
    TGridFunction& u,
    DimFV1Geometry<dim>& geo,
    t_aaVol& aaVolume,
    ADimVector& aGradient,
    t_aaGrad& aaGradient,
    TGridFunction * pLSF = NULL,
    CplUserData<number,dim> * if_val_data = NULL
  );
  
  inline int lsf_sign
  (
    size_t noc,
    number lsf []
  );
  
  inline void extrapolate_by_lsf
  (
    const CplUserData<number,dim> * if_val_data,
    int si,
    DimFV1Geometry<dim> & geo,
    number sol[],
    number lsf[],
    size_t base,
    number ext[]
  );
  
  void mark_CoIE
  (
    grid_type& grid,
    ABool& aCoIE,
    t_aaCoIE& aaCoIE
  );
 
  void assign_dirichlet
  (
    TGridFunction& numsol
  );
 
private:
 
//  Grid functions:
  
  SmartPtr<TGridFunction> m_oldSol; 
  SmartPtr<TGridFunction> m_newSol; 
  
  SmartPtr<TGridFunction> m_spLSF; 
  SmartPtr<TGridFunction> m_spSDF; 
  SmartPtr<TGridFunction> m_spVelPot; 
  
  SmartPtr<TGridFunction> m_spCourant; 
  
//  Parameters of the method:
 
  bool m_bVerbose; 
 
  number m_dt; 
  size_t m_nrOfSteps; 
  bool m_time_control; 
  number m_maxCFL; 
  number m_minCFL; 
  
  number m_gamma; 
  number m_delta; 
  bool m_divFree; 
  
  bool m_firstOrder; 
  bool m_antiderivSrc; 
  
  bool m_elem_vel_vec; 
  
  bool m_limiter; 
  
  SubsetGroup m_neumann_sg; 
  SubsetGroup m_dirichlet_sg; 
  
  SmartPtr<CplUserData<MathVector<dim>, dim> > m_imVelocity; 
  SmartPtr<CplUserData<number, dim> > m_imNormalVel; 
  SmartPtr<CplUserData<number,dim> > m_imDirichlet; 
  SmartPtr<CplUserData<number,dim> > m_imInterfaceVal; 
  
  number m_source_pos, m_source_neg;
  
//  Temporary and computed data
  
  number m_time; 
  number m_CFL; 
};
 
} // end namespace LevelSet
} // end namespace ug
 
// include implementation
#include "hrfblsm_discr_impl.h"
 
#endif /* __H__UG__PLUGINS__LEVEL_SET__HR_FB_LSM_DISCR_H__ */
 
/* End of File */