DelimitedFileReader.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// STL includes
#include <vector>
#include <string>
#include <fstream>

#include "libmesh/parallel.h"

// MOOSE includes
#include "MooseEnum.h"
#include "MooseTypes.h"

namespace MooseUtils
{

class DelimitedFileReader
{
public:
  enum class HeaderFlag
  {
    OFF = 0,
    ON = 1,
    AUTO = 2
  };

  enum class FormatFlag
  {
    COLUMNS = 0,
    ROWS = 1
  };

  const std::size_t INVALID_SIZE = std::numeric_limits<std::size_t>::max();

  DelimitedFileReader(const std::string & filename,
                      const libMesh::Parallel::Communicator * comm = nullptr);

  void read();

  std::size_t numEntries() const;


  void setIgnoreEmptyLines(bool value) { _ignore_empty_lines = value; }
  bool getIgnoreEmptyLines() const { return _ignore_empty_lines; }

  void setFormatFlag(FormatFlag value) { _format_flag = value; }
  FormatFlag getFormatFlag() const { return _format_flag; }

  void setDelimiter(const std::string & value) { _delimiter = value; }
  const std::string & setDelimiter() const { return _delimiter; }

  void setHeaderFlag(HeaderFlag value) { _header_flag = value; }
  HeaderFlag getHeaderFlag() const { return _header_flag; }

  void setComment(const std::string & value) { _row_comment = value; }
  const std::string & getComment() const { return _row_comment; }

  void setFileName(const std::string & new_file) { _filename = new_file; }

  const std::vector<std::string> & getNames() const;

  const std::vector<std::vector<double>> & getData() const;

  const std::vector<Point> getDataAsPoints() const;


  const std::vector<double> & getData(const std::string & name) const;
  const std::vector<double> & getData(std::size_t index) const;


  void setHeaderFlag(bool value);
  const std::vector<std::string> & getColumnNames() const;
  const std::vector<std::vector<double>> & getColumnData() const;
  const std::vector<double> & getColumnData(const std::string & name) const;
  DelimitedFileReader(const std::string & filename,
                      const bool header,
                      const std::string delimiter,
                      const libMesh::Parallel::Communicator * comm = nullptr);

protected:
  std::string _filename;

  HeaderFlag _header_flag;

  std::string _delimiter;

  bool _ignore_empty_lines;

  std::vector<std::string> _names;

  std::vector<std::vector<double>> _data;

  const libMesh::Parallel::Communicator * const _communicator;

  FormatFlag _format_flag;

  std::vector<std::size_t> _row_offsets;

  std::string _row_comment;

private:

  void readColumnData(std::ifstream & stream_data, std::vector<double> & output);
  void readRowData(std::ifstream & stream_data, std::vector<double> & output);

  void processLine(const std::string & line, std::vector<double> & row, const unsigned int & num);

  bool preprocessLine(std::string & line, const unsigned int & num);

  const std::string & delimiter(const std::string & line);

  bool header(const std::string & line);
};
}