matrix_solver.h

Go to the documentation of this file.

// This file is part of HermesCommon
//
// Copyright (c) 2009 hp-FEM group at the University of Nevada, Reno (UNR).
// Email: hpfem-group@unr.edu, home page: http://www.hpfem.org/.
//
// Hermes2D is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published
// by the Free Software Foundation; either version 2 of the License,
// or (at your option) any later version.
//
// Hermes2D 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Hermes2D; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
#ifndef __HERMES_COMMON_MATRIX_SOLVER_H_
#define __HERMES_COMMON_MATRIX_SOLVER_H_

#include "mixins.h"
#include "util/compat.h"
#include "linear_matrix_solver.h"

namespace Hermes
{
  namespace Solvers
  {
    template <typename Scalar>
    class HERMES_API MatrixSolver : public Hermes::Mixins::Loggable
    {
    public:
      MatrixSolver(bool force_use_direct_solver = false);
      virtual ~MatrixSolver();

      enum UMFPACK_reporting_data_value
      {
        FactorizationSize = 0,
        PeakMemoryUsage = 1,
        Flops = 2
      };

      virtual Scalar *get_sln_vector();

      void set_jacobian_constant(bool to_set = true);

      virtual LinearMatrixSolver<Scalar>* get_linear_matrix_solver();

#ifdef WITH_UMFPACK
      virtual void set_UMFPACK_output(bool to_set = true, bool with_output = false);

      virtual double get_UMFPACK_reporting_data(UMFPACK_reporting_data_value data_value);
#endif

      SparseMatrix<Scalar>* get_jacobian();
      Vector<Scalar>* get_residual();

      virtual void set_verbose_output(bool to_set);

      Scalar* sln_vector;

    protected:
      Hermes::Solvers::LinearMatrixSolver<Scalar>* linear_matrix_solver;

      bool constant_jacobian;

      bool jacobian_reusable;

      int problem_size;

#ifdef WITH_UMFPACK
      bool do_UMFPACK_reporting;
      void handle_UMFPACK_reports();

      double UMFPACK_reporting_data[3];
#endif
    };
  }
}
#endif