sparsematrix_interface.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Martin Rupp
 * 
 * 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 SPARSEMATRIX_INTERFACE_H_
#define SPARSEMATRIX_INTERFACE_H_
 
template<typename T> class SparseMatrix
{
public:
  // export value_type
  typedef T value_type;
 
public:
  SparseMatrix();
  virtual ~SparseMatrix();
 
  bool resize(size_t newRows, size_t newCols);
 
  // blas2-funcionts
 
  // element access functions
public:
 
  value_type &operator() (size_t r, size_t c);
 
  const value_type &operator() (size_t r, size_t c) const;
 
  // information functions
public:
  inline size_t num_connections(size_t row) const;
  size_t num_rows() const { return rows; }
  size_t num_cols() const { return cols; }
  size_t total_num_connections() const { return iTotalNrOfConnections; }
 
 
  // iterators
  const_row_iterator begin_row(size_t row) const;
  row_iterator begin_row(size_t row);
  const_row_iterator end_row(size_t row) const;
  row_iterator end_row(size_t row);
 
  // connectivity functions
  //-------------------------
  const_row_iterator get_connection(size_t r, size_t c, bool &bFound) const;
  row_iterator get_connection(size_t r, size_t c, bool &bFound);
 
  const_row_iterator get_connection(size_t r, size_t c) const;
  row_iterator get_connection(size_t r, size_t c);
 
  // finalizing functions
  //----------------------
  void defragment();
 
}
 
 
// external functions which use the interface
 
// CreateAsMultiplyOf:
//-------------------------
template<typename ABC_type, typename A_type, typename B_type, typename C_type>
void CreateAsProductOf(ABC_type &M, const A_type &A, const B_type &B, const C_type &C);
 
 
// CreateAsMultiplyOf:
//-------------------------
template<typename AB_type, typename A_type, typename B_type>
void CreateAsMultiplyOf(AB_type &M, const A_type &A, const B_type &B);
 
// MatAdd:
//-------------------------
template<typename matrix_type>
void MatAdd(matrix_type &M, number &alpha1, const matrix_type &A, number &alpha2, const matrix_type &B);
 
 
// various SetDirichletRow and GetNeighborhood methods (see sparsematrix_util.h)
 
 
#endif /* SPARSEMATRIX_INTERFACE_H_ */