MooseUtils::MixedDataDelimitedFileReader Class Reference

Utility class for reading delimited data (e.g., CSV data). More...

#include <MixedDataDelimitedFileReader.h>

Inheritance diagram for MooseUtils::MixedDataDelimitedFileReader:

Public Types
enum class	HeaderFlag { OFF = 0 , ON = 1 , AUTO = 2 }
enum class	FormatFlag { COLUMNS = 0 , ROWS = 1 }

Public Member Functions
	MixedDataDelimitedFileReader (const std::string &filename)
	MixedDataDelimitedFileReader (const std::string &filename, const libMesh::Parallel::Communicator *comm)
template<typename T >
const std::vector< T >	getData (const std::string &name) const
	Converts a specific named column in the data set to a vector of a specified type.
template<typename T >
const std::vector< T >	getData (std::size_t index_column) const
	Converts a column in the data set to a vector of a specified type.
void	read ()
	Perform the actual data reading.
std::size_t	numEntries () const
	Get the total number of entries in the file.
void	setFileName (const std::string &new_file)
	Set the file name, used to change the file to read from We also reset the column/row names as a second read might have different names.
const std::vector< std::string > &	getNames () const
	Return the column/row names.
const std::vector< std::vector< T > > &	getData () const
	Return the rows/columns of data.
const std::vector< Point >	getDataAsPoints () const
	Get the data in Point format.
const std::vector< Point >	getDataAsPoints () const
void	setIgnoreEmptyLines (bool value)
	Set/Get methods for file format controls.
bool	getIgnoreEmptyLines () const
void	setFormatFlag (FormatFlag value)
FormatFlag	getFormatFlag () const
void	setDelimiter (const std::string &value)
const std::string &	setDelimiter () const
void	setHeaderFlag (HeaderFlag value)
HeaderFlag	getHeaderFlag () const
void	setComment (const std::string &value)
const std::string &	getComment () const

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

Protected Member Functions
template<typename T >
std::vector< T >	convertVector (const std::vector< std::string > &column) const
	Given a column of a data set this will convert it to a vector of the requested type.

Protected Attributes
std::string	_filename
	The supplied filename.
HeaderFlag	_header_flag
	Flag indicating if the file contains a header.
std::string	_delimiter
	The delimiter separating the supplied data entires.
bool	_ignore_empty_lines
	Flag for ignoring empty lines.
std::vector< std::string >	_names
	Storage for the read or generated column names.
std::vector< std::vector< T > >	_data
	Storage for the read data columns.
const libMesh::Parallel::Communicator *const	_communicator
	Communicator.
FormatFlag	_format_flag
	Format "rows" vs "columns".
std::vector< std::size_t >	_row_offsets
	Row offsets (only used with _format == "rows")
std::string	_row_comment
	Hide row comments.

Private Member Functions
void	processLine (const std::string &line, std::vector< T > &row, const unsigned int &num)
	Populate supplied vector with content from line.
bool	preprocessLine (std::string &line, const unsigned int &num)
	Check the content of the line and if it should be skipped.
const std::string &	delimiter (const std::string &line)
	Determine the delimiter.
bool	header (const std::string &line)
	Return the header flag, if it is set to AUTO attempt to determine if a header exists in line.
void	readColumnData (std::ifstream &stream_data, std::vector< T > &output)
	Read the numeric data as rows or columns into a single vector.
void	readRowData (std::ifstream &stream_data, std::vector< T > &output)

Detailed Description

Utility class for reading delimited data (e.g., CSV data).

where the csv has columns of mixed data types

Parameters

filename

A string for the filename to read.

This class allows csv files to contain columns of mixed data types. All of the data is internally stored as string data and then converted to the requested type when getData<T> is called. If a communicator is provide then it will only read on processor 0 and broadcast the data to all processors. If not provided it will read on all processors.

Definition at line 28 of file MixedDataDelimitedFileReader.h.

Member Enumeration Documentation

FormatFlag

template<typename T >

enum class MooseUtils::DelimitedFileReaderTempl::FormatFlag

stronginherited

Enumerator
COLUMNS
ROWS

Definition at line 46 of file DelimitedFileReader.h.

  {
    COLUMNS = 0,
    ROWS = 1
  };

HeaderFlag

template<typename T >

enum class MooseUtils::DelimitedFileReaderTempl::HeaderFlag

stronginherited

Enumerator
OFF
ON
AUTO

Definition at line 39 of file DelimitedFileReader.h.

  {
    OFF = 0,
    ON = 1,
    AUTO = 2
  };

Constructor & Destructor Documentation

MixedDataDelimitedFileReader() [1/2]

MooseUtils::MixedDataDelimitedFileReader::MixedDataDelimitedFileReader ( const std::string &  filename )

inline

Definition at line 31 of file MixedDataDelimitedFileReader.h.

                                                           : DelimitedFileOfStringReader(filename)
  {
  }

MixedDataDelimitedFileReader() [2/2]

MooseUtils::MixedDataDelimitedFileReader::MixedDataDelimitedFileReader ( const std::string &  filename, const libMesh::Parallel::Communicator *  comm  )

inline

Definition at line 35 of file MixedDataDelimitedFileReader.h.

    : DelimitedFileOfStringReader(filename, comm)
  {
  }

Member Function Documentation

convertVector()

template<typename T >

std::vector< T > MooseUtils::MixedDataDelimitedFileReader::convertVector ( const std::vector< std::string > &  column ) const

inlineprotected

Given a column of a data set this will convert it to a vector of the requested type.

Template Parameters

T	the type to convert the column to

Parameters

column

the column of the dataset provided as a string

Returns

The provided vector of strings converted to a vector of the requested type

Exceptions

mooseError	if the requested column index does not exist within the dataset
std::invalid_argument	if one of the entries in the requested column cannot be converted to the requested type

Definition at line 91 of file MixedDataDelimitedFileReader.h.

  {
    auto converted_data = std::vector<T>(column.size());
    for (size_t index_row = 0; index_row < column.size(); ++index_row)
    {
      convert<T>(column[index_row], converted_data[index_row], true);
    }
    return converted_data;
  }

delimiter()

template<typename T >

const std::string & MooseUtils::DelimitedFileReaderTempl< T >::delimiter ( const std::string &  line )

privateinherited

Determine the delimiter.

If the setDelimiter method is not called the data is inspected, if a ',' is found it is assumed to be the delimiter as is the case for \t. Otherwise a space is used.

Definition at line 389 of file DelimitedFileReader.C.

{
  if (_delimiter.empty())
  {
    if (line.find(",") != std::string::npos)
      _delimiter = ",";
    else if (line.find("\t") != std::string::npos)
      _delimiter = "\t";
    else
      _delimiter = " ";
  }
  return _delimiter;
}

getComment()

template<typename T >

const std::string & MooseUtils::DelimitedFileReaderTempl< T >::getComment ( ) const

inlineinherited

Definition at line 93 of file DelimitedFileReader.h.

{ return _row_comment; }

getData() [1/3]

template<typename T >

const std::vector< std::vector< T > > & MooseUtils::DelimitedFileReaderTempl< T >::getData ( ) const

inherited

Return the rows/columns of data.

The outer vector is column and the inner the rows.

Definition at line 146 of file DelimitedFileReader.C.

{
  return _data;
}

Referenced by TimedSubdomainModifier::buildFromFile(), PiecewiseTabularInterface::buildFromFile(), CSVFileTimes::CSVFileTimes(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), PropertyReadFile::getBlockData(), getData(), getData(), PropertyReadFile::getElementData(), PropertyReadFile::getFileNames(), PropertyReadFile::getNodeData(), PropertyReadFile::getVoronoiData(), PropertyReadFile::initVoronoiCenterPoints(), and PropertyReadFile::readData().

getData() [2/3]

template<typename T >

const std::vector< T > MooseUtils::MixedDataDelimitedFileReader::getData ( const std::string &  name ) const

inline

Converts a specific named column in the data set to a vector of a specified type.

Template Parameters

The	type to convert the column to

Parameters

name	the name of the column in the data file

Returns

the named column as a vector of the requested type

Exceptions

mooseError	if the requested column name does not exist within the dataset
std::invalid_argument	if one of the entries in the requested column cannot be converted to the requested type

Definition at line 54 of file MixedDataDelimitedFileReader.h.

  {
    return convertVector<T>(DelimitedFileOfStringReader::getData(name));
  }

Referenced by CSVTimeSequenceStepper::init().

getData() [3/3]

template<typename T >

const std::vector< T > MooseUtils::MixedDataDelimitedFileReader::getData ( std::size_t  index_column ) const

inline

Converts a column in the data set to a vector of a specified type.

Template Parameters

T	The type to convert the column to

Parameters

index_column

the index of the desired column

Returns

The requested column as a vector of the requested type

Exceptions

mooseError	if the requested column index does not exist within the dataset
std::invalid_argument	if one of the entries in the requested column cannot be converted to the requested type

Definition at line 72 of file MixedDataDelimitedFileReader.h.

  {
    return convertVector<T>(DelimitedFileOfStringReader::getData(index_column));
  }

getDataAsPoints() [1/2]

template<typename T >

const std::vector< Point > MooseUtils::DelimitedFileReaderTempl< T >::getDataAsPoints ( ) const

inherited

Get the data in Point format.

This performs checks that the data is of valid dimensions to do so.

Definition at line 185 of file DelimitedFileReader.C.

{
  mooseError("Not implemented");
}

Referenced by FilePositions::FilePositions(), NearestPointBase< UserObjectType, BaseType >::fillPoints(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), and XYDelaunayGenerator::XYDelaunayGenerator().

getDataAsPoints() [2/2]

const std::vector< Point > MooseUtils::DelimitedFileReaderTempl< double >::getDataAsPoints ( ) const

inherited

Definition at line 153 of file DelimitedFileReader.C.

{
  std::vector<Point> point_data;
 
  for (std::size_t i = 0; i < _data.size(); ++i)
  {
    Point point;
 
    // Other checks in this class ensure that each data entry has the same number of values;
    // here we just need to check that each data set has LIBMESH_DIM entries (which we could do by
    // equivalently checking that the total number of entries is divisibly by LIBMESH_DIM
    // _and_ one of these data sets has LIBMESH_DIM entries (consider the fringe case where
    // LIBMESH_DIM is 3, but you accidentally put a point file like
    //   0 0
    //   1 0
    //   2 0
    // where each point is the same length _and_ the total points is still divisible by 3.
    // This check here is more exact.
    if (_data.at(i).size() != LIBMESH_DIM)
      mooseError("Each point in file ", _filename, " must have ", LIBMESH_DIM, " entries");
 
    for (std::size_t j = 0; j < LIBMESH_DIM; ++j)
      point(j) = _data.at(i).at(j);
 
    point_data.push_back(point);
  }
 
  return point_data;
}

getFormatFlag()

template<typename T >

FormatFlag MooseUtils::DelimitedFileReaderTempl< T >::getFormatFlag ( ) const

inlineinherited

Definition at line 84 of file DelimitedFileReader.h.

{ return _format_flag; }

getHeaderFlag()

template<typename T >

HeaderFlag MooseUtils::DelimitedFileReaderTempl< T >::getHeaderFlag ( ) const

inlineinherited

Definition at line 90 of file DelimitedFileReader.h.

{ return _header_flag; }

getIgnoreEmptyLines()

template<typename T >

bool MooseUtils::DelimitedFileReaderTempl< T >::getIgnoreEmptyLines ( ) const

inlineinherited

Definition at line 81 of file DelimitedFileReader.h.

{ return _ignore_empty_lines; }

getNames()

template<typename T >

const std::vector< std::string > & MooseUtils::DelimitedFileReaderTempl< T >::getNames ( ) const

inherited

Return the column/row names.

Definition at line 139 of file DelimitedFileReader.C.

{
  return _names;
}

Referenced by TimedSubdomainModifier::buildFromFile(), PiecewiseTabularInterface::buildFromFile(), and CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor().

header()

template<typename T >

bool MooseUtils::DelimitedFileReaderTempl< T >::header ( const std::string &  line )

privateinherited

Return the header flag, if it is set to AUTO attempt to determine if a header exists in line.

Definition at line 405 of file DelimitedFileReader.C.

{
  switch (_header_flag)
  {
    case HeaderFlag::OFF:
      return false;
    case HeaderFlag::ON:
      return true;
    default:
 
      // Attempt to convert the line, if it fails assume it is a header
      std::vector<double> row;
      bool contains_alpha = !MooseUtils::tokenizeAndConvert<double>(line, row, delimiter(line));
 
      // Based on auto detect set the flag to TRUE|FALSE to short-circuit this check for each line
      // in the case of row data.
      _header_flag = contains_alpha ? HeaderFlag::ON : HeaderFlag::OFF;
      return contains_alpha;
  }
}

numEntries()

template<typename T >

std::size_t MooseUtils::DelimitedFileReaderTempl< T >::numEntries ( ) const

inherited

Get the total number of entries in the file.

Returns

number of entries in file

Definition at line 128 of file DelimitedFileReader.C.

{
  std::size_t n_entries = 0;
  for (std::size_t i = 0; i < _data.size(); ++i)
    n_entries += _data[i].size();
 
  return n_entries;
}

preprocessLine()

template<typename T >

bool MooseUtils::DelimitedFileReaderTempl< T >::preprocessLine ( std::string &  line, const unsigned int &  num  )

privateinherited

Check the content of the line and if it should be skipped.

Parameters

line	Complete line being read.
num	The current line number.

Returns

True if the line should be skipped.

Definition at line 342 of file DelimitedFileReader.C.

{
  // Handle row comments
  std::size_t index = _row_comment.empty() ? line.size() : line.find_first_of(_row_comment);
  line = MooseUtils::trim(line.substr(0, index));
 
  // Ignore empty lines
  if (line.empty())
  {
    if (_ignore_empty_lines)
      return true;
    else
      mooseError("Failed to read line ", num, " in file ", _filename, ". The line is empty.");
  }
  return false;
}

processLine()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::processLine ( const std::string &  line, std::vector< T > &  row, const unsigned int &  num  )

privateinherited

Populate supplied vector with content from line.

Parameters

line	The line to extract data from.
row	The vector to populate.
num	The current line number.

Definition at line 361 of file DelimitedFileReader.C.

{
  std::string line_copy = line;
  // Convert booleans to numeric
  if constexpr (!std::is_same_v<T, std::string>)
  {
    line_copy = MooseUtils::toLower(line_copy);
    line_copy = MooseUtils::replaceAll(line_copy, "true", "1");
    line_copy = MooseUtils::replaceAll(line_copy, "false", "0");
  }
 
  // Separate the row and error if it fails
  bool status = MooseUtils::tokenizeAndConvert<T>(line_copy, row, delimiter(line));
  if (!status)
    mooseError("Failed to convert a delimited data into double when reading line ",
               num,
               " in file ",
               _filename,
               ".\n  LINE ",
               num,
               ": ",
               line);
}

read()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::read ( )

inherited

Perform the actual data reading.

This is a separate method to allow for the filename to be read multiple times.

Definition at line 38 of file DelimitedFileReader.C.

{
  // Number of columns
  std::size_t n_cols;
 
  // Storage for the raw data
  std::vector<T> raw;
  std::size_t size_raw = 0;
  std::size_t size_offsets = 0;
 
  // Read data
  if (_communicator == nullptr || _communicator->rank() == 0)
  {
    // Check the file
    MooseUtils::checkFileReadable(_filename);
 
    // Create the file stream and do nothing if the file is empty
    std::ifstream stream_data(_filename);
    if (stream_data.peek() == std::ifstream::traits_type::eof())
      return;
 
    // Read/generate the header
    if (_format_flag == FormatFlag::ROWS)
      readRowData(stream_data, raw);
    else
      readColumnData(stream_data, raw);
 
    // Set the number of columns
    n_cols = _names.size();
 
    // Close the stream
    stream_data.close();
 
    // Set raw data vector size
    size_raw = raw.size();
    size_offsets = _row_offsets.size();
  }
 
  if (_communicator != nullptr)
  {
    // Broadcast column names
    _communicator->broadcast(n_cols);
    _names.resize(n_cols);
    _communicator->broadcast(_names);
 
    // Broadcast raw data
    _communicator->broadcast(size_raw);
    raw.resize(size_raw);
    _communicator->broadcast(raw);
 
    // Broadcast row offsets
    if (_format_flag == FormatFlag::ROWS)
    {
      _communicator->broadcast(size_offsets);
      _row_offsets.resize(size_offsets);
      _communicator->broadcast(_row_offsets);
    }
  }
 
  // Resize the internal storage
  _data.resize(n_cols);
 
  // Process "row" formatted data
  if (_format_flag == FormatFlag::ROWS)
  {
    typename std::vector<T>::iterator start = raw.begin();
    for (std::size_t j = 0; j < n_cols; ++j)
    {
      _data[j] = std::vector<T>(start, start + _row_offsets[j]);
      std::advance(start, _row_offsets[j]);
    }
  }
 
  // Process "column" formatted data
  else
  {
    mooseAssert(raw.size() % n_cols == 0,
                "The raw data is not evenly divisible by the number of columns.");
    const std::size_t n_rows = raw.size() / n_cols;
    for (std::size_t j = 0; j < n_cols; ++j)
    {
      _data[j].resize(n_rows);
      for (std::size_t i = 0; i < n_rows; ++i)
        _data[j][i] = raw[i * n_cols + j];
    }
  }
}

Referenced by TimedSubdomainModifier::buildFromFile(), PiecewiseTabularInterface::buildFromFile(), CSVFileTimes::CSVFileTimes(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), FilePositions::FilePositions(), NearestPointBase< UserObjectType, BaseType >::fillPoints(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), PropertyReadFile::getFileNames(), CSVTimeSequenceStepper::init(), PropertyReadFile::readData(), and XYDelaunayGenerator::XYDelaunayGenerator().

readColumnData()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::readColumnData ( std::ifstream &  stream_data, std::vector< T > &  output  )

privateinherited

Read the numeric data as rows or columns into a single vector.

Definition at line 217 of file DelimitedFileReader.C.

{
  // Local storage for the data being read
  std::string line;
  std::vector<T> row;
 
  // Keep track of the line number for error reporting
  unsigned int count = 0;
 
  // Number of columns expected based on the first row of the data
  std::size_t n_cols = INVALID_SIZE;
 
  // Read the lines
  while (std::getline(stream_data, line))
  {
    // Increment line counter and clear any tokenized data
    count++;
    row.clear();
 
    // Ignore empty and/or comment lines, if applicable
    if (preprocessLine(line, count))
      continue;
 
    // Read header, if the header exists and the column names do not exist.
    if (_names.empty() && header(line))
    {
      MooseUtils::tokenize(line, _names, 1, delimiter(line));
      for (std::string & str : _names)
        str = MooseUtils::trim(str);
      continue;
    }
 
    // Separate the row and error if it fails
    processLine(line, row, count);
 
    // Set the number of columns
    if (n_cols == INVALID_SIZE)
      n_cols = row.size();
 
    // Check number of columns
    if (row.size() != n_cols)
      mooseError("The number of columns read (",
                 row.size(),
                 ") does not match the number of columns expected (",
                 n_cols,
                 ") based on the first row of the file when reading row ",
                 count,
                 " in file ",
                 _filename,
                 ".");
 
    // Append data
    output.insert(output.end(), row.begin(), row.end());
  }
 
  // If the names have not been assigned, create the default names
  if (_names.empty())
  {
    _names.resize(n_cols);
    int padding = MooseUtils::numDigits(n_cols);
    for (std::size_t i = 0; i < n_cols; ++i)
    {
      std::stringstream ss;
      ss << "column_" << std::setw(padding) << std::setfill('0') << i;
      _names[i] = ss.str();
    }
  }
}

readRowData()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::readRowData ( std::ifstream &  stream_data, std::vector< T > &  output  )

privateinherited

Definition at line 288 of file DelimitedFileReader.C.

{
  // Local storage for the data being read
  std::string line;
  std::vector<T> row;
  unsigned int linenum = 0; // line number in file
 
  // Clear existing data
  _names.clear();
  _row_offsets.clear();
 
  // Read the lines
  while (std::getline(stream_data, line))
  {
    // Increment line counter and clear any tokenized data
    linenum++;
    row.clear();
 
    // Ignore empty lines
    if (preprocessLine(line, linenum))
      continue;
 
    if (header(line))
    {
      std::size_t index = line.find_first_of(delimiter(line));
      _names.push_back(line.substr(0, index));
      line = line.substr(index);
    }
 
    // Separate the row and error if it fails
    processLine(line, row, linenum);
 
    // Store row offsets to allow for un-even rows
    _row_offsets.push_back(row.size());
 
    // Append data
    output.insert(output.end(), row.begin(), row.end());
  }
 
  // Assign row names if not provided via header
  if (_names.empty())
  {
    int padding = MooseUtils::numDigits(_row_offsets.size());
    for (std::size_t i = 0; i < _row_offsets.size(); ++i)
    {
      std::stringstream ss;
      ss << "row_" << std::setw(padding) << std::setfill('0') << i;
      _names.push_back(ss.str());
    }
  }
}

setComment()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setComment ( const std::string &  value )

inlineinherited

Definition at line 92 of file DelimitedFileReader.h.

{ _row_comment = value; }

Referenced by TimedSubdomainModifier::buildFromFile(), and PiecewiseTabularInterface::buildFromFile().

setDelimiter() [1/2]

template<typename T >

const std::string & MooseUtils::DelimitedFileReaderTempl< T >::setDelimiter ( ) const

inlineinherited

Definition at line 87 of file DelimitedFileReader.h.

{ return _delimiter; }

setDelimiter() [2/2]

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setDelimiter ( const std::string &  value )

inlineinherited

Definition at line 86 of file DelimitedFileReader.h.

{ _delimiter = value; }

Referenced by TimedSubdomainModifier::buildFromFile(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), and CSVTimeSequenceStepper::init().

setFileName()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setFileName ( const std::string &  new_file )

inlineinherited

Set the file name, used to change the file to read from We also reset the column/row names as a second read might have different names.

Definition at line 98 of file DelimitedFileReader.h.

  {
    _filename = new_file;
    _names.clear();
  }

Referenced by PropertyReadFile::initialize().

setFormatFlag()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setFormatFlag ( FormatFlag  value )

inlineinherited

Definition at line 83 of file DelimitedFileReader.h.

{ _format_flag = value; }

Referenced by PiecewiseTabularInterface::buildFromFile(), CSVFileTimes::CSVFileTimes(), FilePositions::FilePositions(), NearestPointBase< UserObjectType, BaseType >::fillPoints(), SpatialUserObjectVectorPostprocessor::fillPoints(), CombinerGenerator::fillPositions(), MultiApp::fillPositions(), PropertyReadFile::readData(), and XYDelaunayGenerator::XYDelaunayGenerator().

setHeaderFlag()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setHeaderFlag ( HeaderFlag  value )

inlineinherited

Definition at line 89 of file DelimitedFileReader.h.

{ _header_flag = value; }

Referenced by TimedSubdomainModifier::buildFromFile(), CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor(), PropertyReadFile::getFileNames(), and CSVTimeSequenceStepper::init().

setIgnoreEmptyLines()

template<typename T >

void MooseUtils::DelimitedFileReaderTempl< T >::setIgnoreEmptyLines ( bool  value )

inlineinherited

Set/Get methods for file format controls.

IgnoreEmptyLines: When true all empty lines are ignored, when false an error is produced. FormatFlag: Set the file format (rows vs. columns). Delimiter: Set the file delimiter (if unset it will be detected). HeaderFlag: Set the header flag (TRUE used the first row has header, FALSE assumes no header, and AUTO will attempt to determine if a header exists). Comment: Set the comment character, by default no comment character is used.

Definition at line 80 of file DelimitedFileReader.h.

{ _ignore_empty_lines = value; }

Referenced by CSVReaderVectorPostprocessor::CSVReaderVectorPostprocessor().

Member Data Documentation

_communicator

template<typename T >

const libMesh::Parallel::Communicator* const MooseUtils::DelimitedFileReaderTempl< T >::_communicator

protectedinherited

Communicator.

Definition at line 150 of file DelimitedFileReader.h.

_data

template<typename T >

std::vector<std::vector<T> > MooseUtils::DelimitedFileReaderTempl< T >::_data

protectedinherited

Storage for the read data columns.

Definition at line 147 of file DelimitedFileReader.h.

_delimiter

template<typename T >

std::string MooseUtils::DelimitedFileReaderTempl< T >::_delimiter

protectedinherited

The delimiter separating the supplied data entires.

Definition at line 138 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::setDelimiter(), and MooseUtils::DelimitedFileReaderTempl< T >::setDelimiter().

_filename

template<typename T >

std::string MooseUtils::DelimitedFileReaderTempl< T >::_filename

protectedinherited

The supplied filename.

Definition at line 132 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::setFileName().

_format_flag

template<typename T >

FormatFlag MooseUtils::DelimitedFileReaderTempl< T >::_format_flag

protectedinherited

Format "rows" vs "columns".

Definition at line 153 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::getFormatFlag(), and MooseUtils::DelimitedFileReaderTempl< T >::setFormatFlag().

_header_flag

template<typename T >

HeaderFlag MooseUtils::DelimitedFileReaderTempl< T >::_header_flag

protectedinherited

Flag indicating if the file contains a header.

Definition at line 135 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::getHeaderFlag(), and MooseUtils::DelimitedFileReaderTempl< T >::setHeaderFlag().

_ignore_empty_lines

template<typename T >

bool MooseUtils::DelimitedFileReaderTempl< T >::_ignore_empty_lines

protectedinherited

Flag for ignoring empty lines.

Definition at line 141 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::getIgnoreEmptyLines(), and MooseUtils::DelimitedFileReaderTempl< T >::setIgnoreEmptyLines().

_names

template<typename T >

std::vector<std::string> MooseUtils::DelimitedFileReaderTempl< T >::_names

protectedinherited

Storage for the read or generated column names.

Definition at line 144 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::setFileName().

_row_comment

template<typename T >

std::string MooseUtils::DelimitedFileReaderTempl< T >::_row_comment

protectedinherited

Hide row comments.

Definition at line 159 of file DelimitedFileReader.h.

Referenced by MooseUtils::DelimitedFileReaderTempl< T >::getComment(), and MooseUtils::DelimitedFileReaderTempl< T >::setComment().

_row_offsets

template<typename T >

std::vector<std::size_t> MooseUtils::DelimitedFileReaderTempl< T >::_row_offsets

protectedinherited

Row offsets (only used with _format == "rows")

Definition at line 156 of file DelimitedFileReader.h.

INVALID_SIZE

template<typename T >

const std::size_t MooseUtils::DelimitedFileReaderTempl< T >::INVALID_SIZE = std::numeric_limits<std::size_t>::max()

inherited

Definition at line 52 of file DelimitedFileReader.h.

---

The documentation for this class was generated from the following file:

• include/utils/MixedDataDelimitedFileReader.h