www.mooseframework.org
Functions
FileRangeBuilder.C File Reference

Go to the source code of this file.

Functions

template<>
InputParameters validParams< FileRangeBuilder > ()
 To be called in the validParams functions of classes that need to operate on ranges of files. More...
 

Function Documentation

To be called in the validParams functions of classes that need to operate on ranges of files.

Adds several non-required parameters that are parsed in the parseFileRange function.

Definition at line 17 of file FileRangeBuilder.C.

Referenced by validParams< ImageMesh >(), and validParams< ImageSampler >().

18 {
20  params.addParam<FileName>("file",
21  "Name of single image file to extract mesh parameters from. "
22  "If provided, a 2D mesh is created.");
23  params.addParam<FileNameNoExtension>("file_base",
24  "Image file base to open, use this option when "
25  "a stack of images must be read (ignored if "
26  "'file' is given)");
27  params.addParam<std::vector<unsigned int>>(
28  "file_range",
29  "Range of images to analyze, used with 'file_base' (ignored if 'file' is given)");
30  params.addParam<std::string>("file_suffix", "Suffix of the file to open, e.g. 'png'");
31  return params;
32 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters emptyInputParameters()
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...