eddy_current_e_nedelec.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013-2014:  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.
 */
 
/*
 * FE-discretization of the time-harmonic E-based formulation of the eddy
 * current model.
 */
 
#ifndef __H__UG__PLUGINS__ELECTROMAGNETISM__EDDY_CURRENT_E_NEDELEC__
#define __H__UG__PLUGINS__ELECTROMAGNETISM__EDDY_CURRENT_E_NEDELEC__
 
// basic ug4 headers
#include "common/common.h"
 
// library-specific headers
#include "lib_grid/lg_base.h"
#include "lib_disc/spatial_disc/elem_disc/elem_disc_interface.h"
#include "lib_disc/spatial_disc/user_data/data_export.h"
#include "lib_disc/spatial_disc/user_data/data_import.h"
#include "lib_disc/function_spaces/grid_function.h"
 
/* Discretization's headers: */
#include "eddy_current_traits.h"
#include "../em_material.h"
#include "../nedelec_local_ass.h"
 
namespace ug{
namespace Electromagnetism{
 
 
 
template <typename TDomain, typename TAlgebra>
class EddyCurrent_E_Nedelec
  : public IElemDisc<TDomain>, public EddyCurrentTraits
{
private:
  typedef IElemDisc<TDomain> base_type;
 
  typedef EddyCurrent_E_Nedelec<TDomain,TAlgebra> this_type;
 
  typedef GridFunction<TDomain, TAlgebra> TGridFunction;
 
  typedef typename base_type::domain_type domain_type;
 
  typedef typename base_type::position_type position_type;
  
  static const int dim = base_type::dim;
 
  static const size_t maxNumEdges = element_list_traits<typename domain_traits<dim>::DimElemList>::maxEdges;
 
public:
  EddyCurrent_E_Nedelec
  (
    const char * functions,
    ConstSmartPtr<EMaterial<domain_type> > spSubsetData,
    number frequency
  );
 
public:
  void set_generator_current
  (
    SmartPtr<TGridFunction> spgfJG, 
    const char * cmp, 
    const char * ss_names = NULL 
  );
  void set_generator_current
  (
    SmartPtr<TGridFunction> spgfJG, 
    const char * cmp 
  )
  {
    set_generator_current (spgfJG, cmp, NULL);
  }
 
//---- Local discretization interface: ----
private:
  
  virtual void prepare_setting
  (
    const std::vector<LFEID> & vLfeID,
    bool bNonRegular
  );
 
//---- Assembling functions: ----
  
  template <typename TElem>
  void prepare_element_loop(ReferenceObjectID roid, int si);
 
  template <typename TElem>
  void prepare_element(const LocalVector& u, GridObject* elem, ReferenceObjectID roid, const position_type vCornerCoords[]);
 
  template <typename TElem>
  void finish_element_loop();
 
  template <typename TElem>
  void ass_JA_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const position_type vCornerCoords[]);
 
  template <typename TElem>
  void ass_JM_elem(LocalMatrix& J, const LocalVector& u, GridObject* elem, const position_type vCornerCoords[]);
 
  template <typename TElem>
  void ass_dA_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const position_type vCornerCoords[]);
 
  template <typename TElem>
  void ass_dM_elem(LocalVector& d, const LocalVector& u, GridObject* elem, const position_type vCornerCoords[]);
 
  template <typename TElem>
  void ass_rhs_elem(LocalVector& d, GridObject* elem, const position_type vCornerCoords[]);
 
//---- Registration of the template functions: ----
private:
  
  void register_all_loc_discr_funcs();
 
  struct RegisterLocalDiscr {
      RegisterLocalDiscr(this_type * pThis) : m_pThis(pThis){}
      this_type * m_pThis;
      template< typename TElem > void operator() (TElem &)
      {m_pThis->register_loc_discr_func<TElem> ();}
  };
 
  template <typename TElem>
  void register_loc_discr_func ();
 
//---- Auxiliary functions: ----
private:
 
  template<size_t numEdges>
  void ass_elem_stiffness
  (
    number perm, 
    number cond, 
    number S [2][numEdges] [2][numEdges] 
  );
 
//---- Physical parameters of the problem: ----
private:
  number m_omega;
 
  ConstSmartPtr<EMaterial<domain_type> > m_spSubsetData;
  
  struct tGeneratorCurrent
  {
    SmartPtr<TGridFunction> m_spGf; 
    size_t m_vFct[2]; 
    bool m_everywhere; 
    SubsetGroup m_ssGrp; 
    
    tGeneratorCurrent
    (
      SmartPtr<TGridFunction> & spGf,
      size_t vFct_Re, size_t vFct_Im,
      SubsetGroup & ssGrp,
      bool ew = false
    )
    : m_spGf (spGf), m_everywhere (ew), m_ssGrp (ssGrp)
    {
      m_vFct[_Re_] = vFct_Re; m_vFct[_Im_] = vFct_Im;
    }
  };
  
  std::vector<tGeneratorCurrent> m_vJG;
 
  tGeneratorCurrent * m_pSsJG;
 
//---- Temporary data used in the local discretization ----
private:
  
  number m_rot_rot_S [maxNumEdges][maxNumEdges];
  number m_rot_rot_M [maxNumEdges][maxNumEdges];
 
  number m_permeability;
 
  number m_conductivity;
 
}; // end class EddyCurrent_E_Nedelec
 
 
} // end namespace Electromagnetism
} // end namespace ug
 
#include "eddy_current_e_nedelec_impl.h"
 
#endif /* __H__UG__PLUGINS__ELECTROMAGNETISM__EDDY_CURRENT_E_NEDELEC__ */
 
/* End of File */