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

Go to the source code of this file.

Classes

class  MooseObject
 Every object that can be built by the factory should be derived from this class. More...
 

Functions

template<>
InputParameters validParams< MooseObject > ()
 
void callMooseErrorRaw (std::string &msg, MooseApp *app)
 

Function Documentation

◆ callMooseErrorRaw()

void callMooseErrorRaw ( std::string &  msg,
MooseApp app 
)

Definition at line 57 of file MooseObject.C.

Referenced by MooseObject::mooseError().

58 {
60  std::string prefix;
61  if (!app->isUltimateMaster())
62  prefix = app->name();
63  moose::internal::mooseErrorRaw(msg, prefix);
64 }
const std::string & name() const
Get the name of the object.
Definition: MooseApp.h:73
void mooseErrorRaw(std::string msg, const std::string prefix="")
Definition: MooseError.C:43
void mooseConsole()
Send current output buffer to Console output objects.
bool isUltimateMaster()
Whether or not this app is the ultimate master app.
Definition: MooseApp.h:528
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
Definition: MooseApp.C:1055

◆ validParams< MooseObject >()

Definition at line 25 of file MooseObject.C.

Referenced by validParams< AuxKernel >(), validParams< AuxScalarKernel >(), validParams< BoundaryCondition >(), validParams< Constraint >(), validParams< Control >(), validParams< Damper >(), validParams< DGKernelBase >(), validParams< DiracKernel >(), validParams< Distribution >(), validParams< Executioner >(), validParams< Function >(), validParams< Indicator >(), validParams< InitialConditionBase >(), validParams< InterfaceKernelBase >(), validParams< KernelBase >(), validParams< LineSearch >(), validParams< Marker >(), validParams< Material >(), validParams< MeshGenerator >(), validParams< MeshModifier >(), validParams< MooseMesh >(), validParams< MoosePartitioner >(), validParams< MoosePreconditioner >(), validParams< MultiApp >(), validParams< NodalKernel >(), validParams< Output >(), validParams< Predictor >(), validParams< Problem >(), validParams< RelationshipManager >(), validParams< Sampler >(), validParams< ScalarInitialCondition >(), validParams< ScalarKernel >(), validParams< Split >(), validParams< TimeIntegrator >(), validParams< TimeStepper >(), validParams< Transfer >(), and validParams< UserObject >().

26 {
28  params.addParam<bool>("enable", true, "Set the enabled status of the MooseObject.");
29  params.addParam<std::vector<std::string>>(
30  "control_tags",
31  "Adds user-defined labels for accessing object parameters via control logic.");
32  params.addParamNamesToGroup("enable control_tags", "Advanced");
33  params.addPrivateParam<std::string>("_type"); // The name of the class being built
34  params.addPrivateParam<std::string>("_object_name"); // The name passed to Factory::create
35  params.addPrivateParam<std::string>("_unique_name"); // The unique name generated in the warehouse
36  params.addPrivateParam<FEProblem *>("_fe_problem");
37  params.addPrivateParam<FEProblemBase *>("_fe_problem_base");
38  params.addPrivateParam<EigenProblem *>("_eigen_problem");
39  params.addPrivateParam<SubProblem *>("_subproblem");
40  params.addPrivateParam<SystemBase *>("_sys");
41  params.addPrivateParam<SystemBase *>("_nl_sys");
42  params.addPrivateParam<AuxiliarySystem *>("_aux_sys");
43  params.addPrivateParam<Transient *>("_executioner");
44  params.addPrivateParam<THREAD_ID>("_tid");
45  return params;
46 }
Transient executioners usually loop through a number of timesteps...
Definition: Transient.h:30
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...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblem.h:24
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Base class for a system (of equations)
Definition: SystemBase.h:92
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
InputParameters emptyInputParameters()
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:59
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...
Problem for solving eigenvalue problems.
Definition: EigenProblem.h:25
A system that holds auxiliary variables.
unsigned int THREAD_ID
Definition: MooseTypes.h:161
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...