matrix_io.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2015:  G-CSC, Goethe University Frankfurt
 * Author: Torbjörn Klatt
 * 
 * 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 __H__UG__LIB_ALGEBRA__MATRIX_IO_H
#define __H__UG__LIB_ALGEBRA__MATRIX_IO_H
 
#include <string>
#include <fstream>
 
#include "common/util/file_util.h"
#include "common/assert.h"
#include "common/error.h"
#include "common/log.h"
#include "common/profiler/profiler.h"
#include "lib_algebra/lib_algebra.h"
#include "lib_algebra/cpu_algebra_types.h"
 
namespace ug
{
 
class MatrixFileType
{
  public:
    enum Type {
      UNDEFINED = 0,
      MATRIX_MARKET = 1,
      HARWELL_BOING = 2   // TODO: HarwellBoing format not yet implemented
    };
 
    MatrixFileType() : m_type( UNDEFINED ) {}
    MatrixFileType( int type ) : m_type() {
      UG_ASSERT( type >= 0 && type <= 2, "Unknown MatrixFileType code: " << type );
      m_type = type;
    }
    bool is_mm() const {
      return m_type == MATRIX_MARKET;
    }
    bool is_hb() const {
      return m_type == HARWELL_BOING;
    }
 
  private:
    int m_type;
};
 
class MatrixIO
{
  public:
    enum OpenMode {
      EXISTING = 1,
      NEW = 2
    };
    
  private:
    std::string *m_pMatFileName;
    std::fstream m_matFileStream;
    MatrixFileType m_matFileType;
    //int m_rows;
    //int m_cols;
    //int m_lines;
 
  public:
    MatrixIO();
    MatrixIO( std::string mFile, int openMode=EXISTING );
    ~MatrixIO();
 
    void set_mat_file_name( std::string mFile, int openMode=EXISTING );
    std::string get_mat_file_name() const;
 
  private:
    void open_file( std::ios_base::openmode mode=std::ios_base::in );
    void close_file();
};
 
// end group matrixio
 
} // namespace ug
 
// include specializations
#include "matrix_io_mtx.h"
 
#endif // __H__UG__LIB_ALGEBRA__MATRIXIO_H
 
// EOF