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

Go to the source code of this file.

Classes

class  EigenExecutionerBase
 This class provides reusable routines for eigenvalue executioners. More...
 
class  EigenExecutionerBase::Chebyshev_Parameters
 

Functions

template<>
InputParameters validParams< EigenExecutionerBase > ()
 

Function Documentation

Definition at line 27 of file EigenExecutionerBase.C.

Referenced by validParams< InversePowerMethod >(), and validParams< NonlinearEigen >().

28 {
30  params.addRequiredParam<PostprocessorName>("bx_norm", "To evaluate |Bx| for the eigenvalue");
31  params.addParam<PostprocessorName>("normalization", "To evaluate |x| for normalization");
32  params.addParam<Real>("normal_factor", "Normalize x to make |x| equal to this factor");
33  params.addParam<bool>(
34  "output_before_normalization", true, "True to output a step before normalization");
35  params.addParam<bool>("auto_initialization", true, "True to ask the solver to set initial");
36  params.addParam<Real>("time", 0.0, "System time");
37 
38  params.addPrivateParam<bool>("_eigen", true);
39 
40  params.addParamNamesToGroup("normalization normal_factor output_before_normalization",
41  "Normalization");
42  params.addParamNamesToGroup("auto_initialization time", "Advanced");
43 
44  params.addPrivateParam<bool>("_eigen", true);
45 
46  return params;
47 }
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
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< Executioner >()
Definition: Executioner.C:30
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...