Line data    Source code

       1              : /*
       2              :  * Copyright (c) 2013-2015:  G-CSC, Goethe University Frankfurt
       3              :  * Author: Susanne Höllbacher
       4              :  * 
       5              :  * This file is part of UG4.
       6              :  * 
       7              :  * UG4 is free software: you can redistribute it and/or modify it under the
       8              :  * terms of the GNU Lesser General Public License version 3 (as published by the
       9              :  * Free Software Foundation) with the following additional attribution
      10              :  * requirements (according to LGPL/GPL v3 §7):
      11              :  * 
      12              :  * (1) The following notice must be displayed in the Appropriate Legal Notices
      13              :  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
      14              :  * 
      15              :  * (2) The following notice must be displayed at a prominent place in the
      16              :  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
      17              :  * 
      18              :  * (3) The following bibliography is recommended for citation and must be
      19              :  * preserved in all covered files:
      20              :  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
      21              :  *   parallel geometric multigrid solver on hierarchically distributed grids.
      22              :  *   Computing and visualization in science 16, 4 (2013), 151-164"
      23              :  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
      24              :  *   flexible software system for simulating pde based models on high performance
      25              :  *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
      26              :  * 
      27              :  * This program is distributed in the hope that it will be useful,
      28              :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      29              :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
      30              :  * GNU Lesser General Public License for more details.
      31              :  */
      32              : 
      33              : #ifndef __H__UG__LIB_DISC__SPATIAL_DISC__LOCAL_TO_GLOBAL_MAPPER__
      34              : #define __H__UG__LIB_DISC__SPATIAL_DISC__LOCAL_TO_GLOBAL_MAPPER__
      35              : 
      36              : // extern headers
      37              : #include <vector>
      38              : 
      39              : // intern headers
      40              : #include "lib_disc/dof_manager/dof_distribution.h"
      41              : 
      42              : namespace ug{
      43              : 
      44              : /// interface for definition of special LocalToGlobal mappings
      45              : /**
      46              :  * \tparam      TAlgebra                        type of Algebra
      47              :  */
      48              : template <typename TAlgebra>
      49              : class ILocalToGlobalMapper
      50              : {
      51              :         public:
      52              :         ///     Algebra type
      53              :                 typedef TAlgebra algebra_type;
      54              : 
      55              :         ///     Type of algebra matrix
      56              :                 typedef typename algebra_type::matrix_type matrix_type;
      57              : 
      58              :         ///     Type of algebra vector
      59              :                 typedef typename algebra_type::vector_type vector_type;
      60              : 
      61              :         public:
      62              :         ///     default Constructor
      63            0 :                 ILocalToGlobalMapper() {};
      64              : 
      65              :         ///     send local entries to global matrix
      66              :                 virtual void add_local_vec_to_global(vector_type& vec, const LocalVector& lvec,
      67              :                                 ConstSmartPtr<DoFDistribution> dd) = 0;
      68              : 
      69              :         ///     send local entries to global rhs
      70              :                 virtual void add_local_mat_to_global(matrix_type& mat, const LocalMatrix& lmat,
      71              :                                 ConstSmartPtr<DoFDistribution> dd) = 0;
      72              : 
      73              :         ///     modifies local solution vector for adapted defect computation
      74              :                 virtual void modify_LocalSol(LocalVector& vecMod, const LocalVector& lvec, ConstSmartPtr<DoFDistribution> dd) = 0;
      75              : 
      76              :         ///     virtual destructor
      77              :                 virtual ~ILocalToGlobalMapper() {};
      78              : 
      79              : };
      80              : 
      81              : 
      82              : } // end namespace ug
      83              : 
      84              : #endif /* __H__UG__LIB_DISC__SPATIAL_DISC__LOCAL_TO_GLOBAL_MAPPER__*/