algebra_mixins.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_ALGEBRA_MIXINS_H
#define __HERMES_COMMON_ALGEBRA_MIXINS_H

#include "common.h"
#include "util/compat.h"
#include "algebra_utilities.h"
#include "exceptions.h"

namespace Hermes
{
  namespace Algebra
  {
    template<typename Scalar> class SparseMatrix;
    template<typename Scalar> class Vector;

    namespace Mixins
    {
      template<typename Scalar>
      class HERMES_API MatrixRhsOutput
      {
      public:
        MatrixRhsOutput();

        void process_matrix_output(Hermes::Algebra::SparseMatrix<Scalar>* matrix, int iteration);
        void process_matrix_output(Hermes::Algebra::SparseMatrix<Scalar>* matrix);

        void process_vector_output(Hermes::Algebra::Vector<Scalar>* rhs, int iteration);
        void process_vector_output(Hermes::Algebra::Vector<Scalar>* rhs);

        void output_matrix(bool only_last_iteration = true, int firstIterations = -1);
        void set_print_zero_matrix_entries(bool to_set);
        void set_matrix_filename(std::string name);
        void set_matrix_varname(std::string name);
        void set_matrix_export_format(Hermes::Algebra::MatrixExportFormat format);
        void set_matrix_number_format(char* number_format);

        void output_rhs(bool only_last_iteration = true, int firstIterations = -1);
        void set_rhs_filename(std::string name);
        void set_rhs_varname(std::string name);
        void set_rhs_export_format(Hermes::Algebra::MatrixExportFormat format);
        void set_rhs_number_format(char* number_format);

      protected:
        bool print_matrix_zero_values;
        bool output_matrixOn;
        bool only_lastMatrixIteration;
        int output_matrixIterations;
        std::string matrixFilename;
        std::string matrixVarname;
        Hermes::Algebra::MatrixExportFormat matrixFormat;
        char* matrix_number_format;

        bool output_rhsOn;
        bool only_lastRhsIteration;
        int output_rhsIterations;
        std::string RhsFilename;
        std::string RhsVarname;
        Hermes::Algebra::MatrixExportFormat RhsFormat;
        char* rhs_number_format;
      };

      template<typename Scalar>
      class HERMES_API MatrixRhsImportExport
      {
      public:
        virtual void export_to_file(const char* filename, const char* var_name, Algebra::MatrixExportFormat fmt, char* number_format = "%lf") = 0;
        void export_to_file(std::string filename, const char* var_name, Algebra::MatrixExportFormat fmt, char* number_format = "%lf");
        void export_to_file(std::string filename, std::string var_name, Algebra::MatrixExportFormat fmt, char* number_format = "%lf");

        virtual void import_from_file(const char* filename, const char* var_name, Algebra::MatrixExportFormat fmt) { throw Hermes::Exceptions::MethodNotOverridenException("MatrixRhsImportExport<Scalar>::import_from_file"); };
        void import_from_file(std::string filename, const char* var_name, Algebra::MatrixExportFormat fmt);
        void import_from_file(std::string filename, std::string var_name, Algebra::MatrixExportFormat fmt);
      };
    }
  }
}
#endif