www.mooseframework.org
Classes | Functions
CSVTimeSequenceStepper.h File Reference

Go to the source code of this file.

Classes

class  CSVTimeSequenceStepper
 Solves the PDEs at a sequence of time points given as a column in a text table file (such as a *.csv file). More...
 

Functions

template<>
InputParameters validParams< CSVTimeSequenceStepper > ()
 

Function Documentation

Definition at line 19 of file CSVTimeSequenceStepper.C.

20 {
22  params.addRequiredParam<FileName>("file_name",
23  "name of the file in which the time sequence is read");
24  params.addParam<bool>("header",
25  "indicates whether the file contains a header with the column names");
26  params.addParam<std::string>("delimiter", ",", "delimiter used to parse the file");
27  params.addParam<std::string>(
28  "column_name", "time", "name of the column which contains the time sequence");
29  params.addParam<unsigned int>("column_index",
30  "index of the column which contains the time sequence");
31  params.addClassDescription(
32  "Solves the Transient problem at a sequence of given time points read in a file.");
33  return params;
34 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
InputParameters validParams< TimeSequenceStepperBase >()
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...