www.mooseframework.org
Classes | Namespaces | Functions
OversampleOutput.h File Reference

Go to the source code of this file.

Classes

class  libMesh::NumericVector< T >
 
class  OversampleOutput
 Based class for providing re-positioning and oversampling support to output objects. More...
 

Namespaces

 libMesh
 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.
 

Functions

template<>
InputParameters validParams< OversampleOutput > ()
 

Function Documentation

Definition at line 28 of file OversampleOutput.C.

Referenced by validParams< Exodus >(), validParams< GMVOutput >(), validParams< Tecplot >(), validParams< VTKOutput >(), and validParams< XDA >().

29 {
30 
31  // Get the parameters from the parent object
33  params.addParam<unsigned int>("refinements",
34  0,
35  "Number of uniform refinements for oversampling "
36  "(refinement levels beyond any uniform "
37  "refinements)");
38  params.addParam<Point>("position",
39  "Set a positional offset, this vector will get added to the "
40  "nodal coordinates to move the domain.");
41  params.addParam<MeshFileName>("file", "The name of the mesh file to read, for oversampling");
42 
43  // **** DEPRECATED AND REMOVED PARAMETERS ****
44  params.addDeprecatedParam<bool>("oversample",
45  false,
46  "Set to true to enable oversampling",
47  "This parameter is no longer active, simply set 'refinements' to "
48  "a value greater than zero to evoke oversampling");
49  params.addDeprecatedParam<bool>("append_oversample",
50  false,
51  "Append '_oversample' to the output file base",
52  "This parameter is no longer operational, to append "
53  "'_oversample' utilize the output block name or 'file_base'");
54 
55  // 'Oversampling' Group
56  params.addParamNamesToGroup("refinements position file", "Oversampling");
57 
58  return params;
59 }
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< AdvancedOutput >()
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...
void addParamNamesToGroup(const std::string &space_delim_names, const std::string group_name)
This method takes a space delimited list of parameter names and adds them to the specified group name...