matrix_vector_product.h

Go to the documentation of this file.

// LIC// ====================================================================
// LIC// This file forms part of oomph-lib, the object-oriented,
// LIC// multi-physics finite-element library, available
// LIC// at http://www.oomph-lib.org.
// LIC//
// LIC// Copyright (C) 2006-2022 Matthias Heil and Andrew Hazel
// LIC//
// LIC// This library is free software; you can redistribute it and/or
// LIC// modify it under the terms of the GNU Lesser General Public
// LIC// License as published by the Free Software Foundation; either
// LIC// version 2.1 of the License, or (at your option) any later version.
// LIC//
// LIC// This library is distributed in the hope that it will be useful,
// LIC// but WITHOUT ANY WARRANTY; without even the implied warranty of
// LIC// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// LIC// Lesser General Public License for more details.
// LIC//
// LIC// You should have received a copy of the GNU Lesser General Public
// LIC// License along with this library; if not, write to the Free Software
// LIC// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// LIC// 02110-1301  USA.
// LIC//
// LIC// The authors may be contacted at oomph-lib@maths.man.ac.uk.
// LIC//
// LIC//====================================================================
// Include guards
#ifndef OOMPH_MATRIX_VECTOR_PRODUCT_HEADER
#define OOMPH_MATRIX_VECTOR_PRODUCT_HEADER
 
 
// Config header generated by autoconfig
#ifdef HAVE_CONFIG_H
#include <oomph-lib-config.h>
#endif
 
#include "matrices.h"
#include "linear_algebra_distribution.h"
#ifdef OOMPH_HAS_TRILINOS
#include "trilinos_helpers.h"
#endif
 
namespace oomph
{
  //=============================================================================
  //=============================================================================
  class MatrixVectorProduct : public DistributableLinearAlgebraObject
  {
  public:
    MatrixVectorProduct()
    {
      // null pointers
#ifdef OOMPH_HAS_TRILINOS
      Epetra_matrix_pt = 0;
#endif
      Oomph_matrix_pt = 0;
      Column_distribution_pt = 0;
    }
 
    MatrixVectorProduct(const MatrixVectorProduct&) = delete;
 
    void operator=(const MatrixVectorProduct&) = delete;
 
    ~MatrixVectorProduct()
    {
      this->clean_up_memory();
    }
 
    void clean_up_memory()
    {
#ifdef OOMPH_HAS_TRILINOS
      delete Epetra_matrix_pt;
      Epetra_matrix_pt = 0;
#endif
      delete Oomph_matrix_pt;
      Oomph_matrix_pt = 0;
      delete Column_distribution_pt;
      Column_distribution_pt = 0;
    }
 
    void setup(CRDoubleMatrix* matrix_pt,
               const LinearAlgebraDistribution* col_dist_pt = 0);
 
    void multiply(const DoubleVector& x, DoubleVector& y) const;
 
    void multiply_transpose(const DoubleVector& x, DoubleVector& y) const;
 
    const unsigned& ncol() const
    {
      return Ncol;
    }
 
  private:
#ifdef OOMPH_HAS_TRILINOS
    void trilinos_multiply_helper(const DoubleVector& x, DoubleVector& y) const;
 
    void trilinos_multiply_transpose_helper(const DoubleVector& x,
                                            DoubleVector& y) const;
 
    Epetra_CrsMatrix* Epetra_matrix_pt;
#endif
 
    bool Using_trilinos;
 
    CRDoubleMatrix* Oomph_matrix_pt;
 
    LinearAlgebraDistribution* Column_distribution_pt;
 
    unsigned Ncol;
  };
} // namespace oomph
#endif