www.mooseframework.org
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
BicubicSplineFunction Class Reference

Function that uses spline interpolation. More...

#include <BicubicSplineFunction.h>

Inheritance diagram for BicubicSplineFunction:
[legend]

Public Member Functions

 BicubicSplineFunction (const InputParameters &parameters)
 
virtual Real value (Real t, const Point &p) const override
 Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero, you must override it. More...
 
virtual Real derivative (const Point &p, unsigned int deriv_var) const
 
virtual RealGradient gradient (Real t, const Point &p) const override
 Function objects can optionally provide a gradient at a point. More...
 
virtual Real secondDerivative (const Point &p, unsigned int deriv_var) const
 
virtual RealVectorValue vectorValue (Real t, const Point &p) const
 Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it. More...
 
virtual RealVectorValue vectorCurl (Real t, const Point &p) const
 Override this to evaluate the curl of the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it. More...
 
virtual Real timeDerivative (Real t, const Point &p) const
 Get the time derivative of the function. More...
 
virtual Real integral () const
 
virtual Real average () const
 
const std::string & type () const
 Get the type of this object. More...
 
virtual const std::string & name () const
 Get the name of the object. More...
 
const InputParametersparameters () const
 Get the parameters of the object. More...
 
template<typename T >
const T & getParamTempl (const std::string &name) const
 Retrieve a parameter for the object. More...
 
template<typename T >
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...
 
bool isParamValid (const std::string &name) const
 Test if the supplied parameter is valid. More...
 
MooseAppgetMooseApp () const
 Get the MooseApp this object is associated with. More...
 
virtual bool enabled () const
 Return the enabled status of the object. More...
 
template<typename... Args>
void paramError (const std::string &param, Args... args) const
 Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void paramWarning (const std::string &param, Args... args) const
 Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void paramInfo (const std::string &param, Args... args) const
 Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void mooseError (Args &&... args) const
 
template<typename... Args>
void mooseWarning (Args &&... args) const
 
template<typename... Args>
void mooseDeprecated (Args &&... args) const
 
template<typename... Args>
void mooseInfo (Args &&... args) const
 
virtual void initialSetup ()
 Gets called at the beginning of the simulation before this object is asked to do its job. More...
 
virtual void timestepSetup ()
 Gets called at the beginning of the timestep before this object is asked to do its job. More...
 
virtual void jacobianSetup ()
 Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
 
virtual void residualSetup ()
 Gets called just before the residual is computed and before this object is asked to do its job. More...
 
virtual void subdomainSetup ()
 Gets called when the subdomain changes (i.e. More...
 
const ExecFlagEnumgetExecuteOnEnum () const
 Return the execute on MultiMooseEnum for this object. More...
 
virtual const std::vector< ExecFlagType > & execFlags () const
 (DEPRECATED) Get the execution flag for the object TODO: ExecFlagType More...
 
ExecFlagType execBitFlags () const
 (DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType More...
 
bool isImplicit ()
 
bool hasPostprocessor (const std::string &name, unsigned int index=0) const
 Determine if the Postprocessor exists. More...
 
bool hasPostprocessorByName (const PostprocessorName &name)
 Determine if the Postprocessor exists. More...
 
unsigned int coupledPostprocessors (const std::string &name) const
 Returns number of Postprocessors coupled under parameter name. More...
 
bool singlePostprocessor (const std::string &name) const
 Checks if there is a single postprocessor coupled by parameter name. More...
 
template<class T >
const T & getUserObjectTempl (const std::string &name)
 Get an user object with a given parameter name. More...
 
template<class T >
const T & getUserObjectByNameTempl (const std::string &name)
 Get an user object with a given name. More...
 
const UserObjectgetUserObjectBase (const std::string &name)
 Get an user object with a given parameter name. More...
 
const UserObjectgetUserObjectBaseByName (const std::string &name)
 Get an user object with a given name. More...
 
virtual void meshChanged ()
 Called on this object when the mesh changes. More...
 
const std::vector< MooseVariableScalar * > & getCoupledMooseScalarVars ()
 Get the list of coupled scalar variables. More...
 
std::set< TagID > & getScalarVariableCoupleableVectorTags ()
 
std::set< TagID > & getScalarVariableCoupleableMatrixTags ()
 
void addScalarVariableCoupleableVectorTag (TagID tag)
 
void addScalarVariableCoupleableMatrixTag (TagID tag)
 
const FunctiongetFunction (const std::string &name) const
 Get a function with a given name. More...
 
const FunctiongetFunctionByName (const FunctionName &name) const
 Get a function with a given name. More...
 
const PostprocessorValuegetPostprocessorValue (const std::string &name, unsigned int index=0)
 doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values More...
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &name, unsigned int index=0)
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &name, unsigned int index=0)
 
const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name)
 Retrieve the value of the Postprocessor. More...
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name)
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name)
 
const PostprocessorValuegetDefaultPostprocessorValue (const std::string &name)
 Return the default postprocessor value. More...
 

Static Public Member Functions

static InputParameters validParams ()
 
static ExecFlagEnum getExecuteOptions ()
 (DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...
 

Public Attributes

const ConsoleStream _console
 An instance of helper class to write streams to the Console objects. More...
 

Protected Member Functions

template<typename T >
T & declareRestartableDataTempl (const std::string &data_name)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataTempl (const std::string &data_name, const T &init_value)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithContext (const std::string &data_name, void *context)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataWithContext (const std::string &data_name, const T &init_value, void *context)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithPrefixOverrideAndContext (const std::string &data_name, const std::string &prefix, void *context)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRecoverableData (const std::string &data_name)
 Declare a piece of data as "recoverable". More...
 
template<typename T >
T & declareRecoverableData (const std::string &data_name, const T &init_value)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context)
 Declare a piece of data as "restartable". More...
 
virtual bool isCoupledScalar (const std::string &var_name, unsigned int i=0)
 Returns true if a variables has been coupled_as name. More...
 
virtual unsigned int coupledScalarComponents (const std::string &var_name)
 Return the number of components to the coupled scalar variable. More...
 
virtual unsigned int coupledScalar (const std::string &var_name, unsigned int comp=0)
 Returns the index for a scalar coupled variable by name. More...
 
virtual Order coupledScalarOrder (const std::string &var_name, unsigned int comp=0)
 Returns the order for a scalar coupled variable by name. More...
 
virtual VariableValuecoupledScalarValue (const std::string &var_name, unsigned int comp=0)
 Returns value of a scalar coupled variable. More...
 
template<ComputeStage compute_stage>
const ADVariableValue & adCoupledScalarValueTempl (const std::string &var_name, unsigned int comp=0)
 Returns AD value of a scalar coupled variable. More...
 
virtual VariableValuecoupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
 Returns value of a scalar coupled variable. More...
 
virtual VariableValuecoupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
 Returns value of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarValueOld (const std::string &var_name, unsigned int comp=0)
 Returns the old (previous time step) value of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0)
 Returns the older (two time steps previous) value of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarDot (const std::string &var_name, unsigned int comp=0)
 Returns the time derivative of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarDotDot (const std::string &var_name, unsigned int comp=0)
 Returns the second time derivative of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarDotOld (const std::string &var_name, unsigned int comp=0)
 Returns the old time derivative of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0)
 Returns the old second time derivative of a scalar coupled variable. More...
 
virtual VariableValuecoupledScalarDotDu (const std::string &var_name, unsigned int comp=0)
 Time derivative of a scalar coupled variable with respect to the coefficients. More...
 
virtual VariableValuecoupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0)
 Second time derivative of a scalar coupled variable with respect to the coefficients. More...
 
VariableValuegetDefaultValue (const std::string &var_name)
 Helper method to return (and insert if necessary) the default value for an uncoupled variable. More...
 
template<ComputeStage compute_stage>
ADVariableValue * getADDefaultValue (const std::string &var_name)
 Helper method to return (and insert if necessary) the AD default value for an uncoupled variable. More...
 
void checkVar (const std::string &var_name)
 Check that the right kind of variable is being coupled in. More...
 
MooseVariableScalargetScalarVar (const std::string &var_name, unsigned int comp)
 Extract pointer to a scalar coupled variable. More...
 
void validateExecutionerType (const std::string &name, const std::string &fn_name) const
 Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in. More...
 

Protected Attributes

BicubicSplineInterpolation _ipol
 
unsigned int _normal_component
 
std::vector< Real > _x1
 
std::vector< Real > _x2
 
std::vector< Real > _yx11
 
std::vector< Real > _yx1n
 
std::vector< Real > _yx21
 
std::vector< Real > _yx2n
 
const Function_yx1
 
const Function_yx2
 
Real _x1_index
 
Real _x2_index
 
const InputParameters_pars
 Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...
 
MooseApp_app
 The MooseApp this object is associated with. More...
 
const std::string & _type
 The type of this object (the Class name) More...
 
const std::string & _name
 The name of this object, reference to value stored in InputParameters. More...
 
const bool & _enabled
 Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects. More...
 
const ExecFlagEnum_execute_enum
 Execute settings for this oejct. More...
 
const std::vector< ExecFlagType_exec_flags
 (DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType More...
 
const ExecFlagType_current_execute_flag
 Reference to FEProblemBase. More...
 
const InputParameters_ti_params
 
FEProblemBase_ti_feproblem
 
bool _is_implicit
 If the object is using implicit or explicit form. More...
 
Real & _t
 Time. More...
 
int & _t_step
 The number of the time step. More...
 
Real & _dt
 Time step size. More...
 
Real & _dt_old
 Size of the old time step. More...
 
bool _is_transient
 
FEProblemBase_mci_feproblem
 Reference to FEProblemBase instance. More...
 
const InputParameters_sc_parameters
 
const std::string & _sc_name
 The name of the object this interface is part of. More...
 
FEProblemBase_sc_fe_problem
 
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _coupled_scalar_vars
 Coupled vars whose values we provide. More...
 
std::unordered_map< std::string, std::unique_ptr< VariableValue > > _default_value
 Will hold the default value for optional coupled scalar variables. More...
 
std::unordered_map< std::string, std::unique_ptr< DualVariableValue > > _dual_default_value
 Will hold the default AD value for optional coupled scalar variables. More...
 
std::vector< MooseVariableScalar * > _coupled_moose_scalar_vars
 Vector of coupled variables. More...
 
bool _sc_is_implicit
 True if implicit value is required. More...
 
const InputParameters_coupleable_params
 Local InputParameters. More...
 
THREAD_ID _sc_tid
 Thread ID of the thread using this object. More...
 
const Real & _real_zero
 Scalar zero. More...
 
const VariableValue_scalar_zero
 Zero value of a scalar variable. More...
 
const Point & _point_zero
 Zero point. More...
 

Private Member Functions

template<typename... Args>
std::string paramErrorMsg (const std::string &param, Args... args) const
 
bool needThreadedCopy (const UserObject &uo) const
 Check if the threaded copy of the user object is needed. More...
 
RestartableDataValueregisterRestartableDataOnApp (const std::string &name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid)
 Helper function for actually registering the restartable data. More...
 
void registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
 Helper function for actually registering the restartable data. More...
 

Private Attributes

ExecFlagEnum _empty_execute_enum
 Empty ExecFlagEnum for the case when the "execute_on" parameter is not included. More...
 
const std::string _ti_name
 
const InputParameters_ppi_params
 PostprocessorInterface Parameters. More...
 
FEProblemBase_pi_feproblem
 Reference the the FEProblemBase class. More...
 
const InputParameters_uoi_params
 Parameters of the object with this interface. More...
 
FEProblemBase_uoi_feproblem
 Reference to the FEProblemBase instance. More...
 
THREAD_ID _uoi_tid
 Thread ID. More...
 
MooseApp_restartable_app
 Reference to the application. More...
 
std::string _restartable_name
 The name of the object. More...
 
std::string _restartable_system_name
 The system name this object is in. More...
 
THREAD_ID _restartable_tid
 The thread ID for this object. More...
 
std::unordered_map< std::string, std::vector< MooseVariableFEBase * > > _sc_coupled_vars
 Field variables coupled into this object (for error checking) More...
 
std::set< TagID_sc_coupleable_vector_tags
 
std::set< TagID_sc_coupleable_matrix_tags
 
const InputParameters_fni_params
 Parameters of the object with this interface. More...
 
FEProblemBase_fni_feproblem
 Reference to FEProblemBase instance. More...
 
const THREAD_ID _fni_tid
 Thread ID. More...
 

Detailed Description

Function that uses spline interpolation.

Definition at line 24 of file BicubicSplineFunction.h.

Constructor & Destructor Documentation

◆ BicubicSplineFunction()

BicubicSplineFunction::BicubicSplineFunction ( const InputParameters parameters)

Definition at line 44 of file BicubicSplineFunction.C.

46  FunctionInterface(this),
47  _normal_component(getParam<MooseEnum>("normal_component")),
48  _yx1(getFunction("yx1")),
49  _yx2(getFunction("yx2"))
50 {
51  _x1 = getParam<std::vector<Real>>("x1");
52  _x2 = getParam<std::vector<Real>>("x2");
53  std::vector<Real> yvec = getParam<std::vector<Real>>("y");
54  if (isParamValid("yx11"))
55  _yx11 = getParam<std::vector<Real>>("yx11");
56  if (isParamValid("yx1n"))
57  _yx1n = getParam<std::vector<Real>>("yx1n");
58  if (isParamValid("yx21"))
59  _yx21 = getParam<std::vector<Real>>("yx21");
60  if (isParamValid("yx2n"))
61  _yx2n = getParam<std::vector<Real>>("yx2n");
62 
63  unsigned int m = _x1.size(), n = _x2.size(), mn = yvec.size();
64  if (m * n != mn)
65  mooseError("The length of the supplied y must be equal to the lengths of x1 and x2 multiplied "
66  "together");
67 
68  std::vector<std::vector<Real>> y(m, std::vector<Real>(n));
69  unsigned int k = 0;
70  for (unsigned int i = 0; i < m; ++i)
71  for (unsigned int j = 0; j < n; ++j)
72  y[i][j] = yvec[k++];
73 
74  if (_yx11.empty())
75  _yx11.resize(n, 1e30);
76  else if (_yx11.size() != n)
77  mooseError("The length of the vectors holding the first derivatives of y with respect to x1 "
78  "must match the length of x2.");
79 
80  if (_yx1n.empty())
81  _yx1n.resize(n, 1e30);
82  else if (_yx1n.size() != n)
83  mooseError("The length of the vectors holding the first derivatives of y with respect to x1 "
84  "must match the length of x2.");
85 
86  if (_yx21.empty())
87  _yx21.resize(m, 1e30);
88  else if (_yx21.size() != m)
89  mooseError("The length of the vectors holding the first derivatives of y with respect to x2 "
90  "must match the length of x1.");
91 
92  if (_yx2n.empty())
93  _yx2n.resize(m, 1e30);
94  else if (_yx2n.size() != m)
95  mooseError("The length of the vectors holding the first derivatives of y with respect to x2 "
96  "must match the length of x1.");
97 
99 
100  if (_normal_component == 0)
101  {
102  // YZ plane
103  _x1_index = 1;
104  _x2_index = 2;
105  }
106  else if (_normal_component == 1)
107  {
108  // ZX plane
109  _x1_index = 2;
110  _x2_index = 0;
111  }
112  else
113  {
114  // XY plane
115  _x1_index = 0;
116  _x2_index = 1;
117  }
118 }

Member Function Documentation

◆ adCoupledScalarValueTempl()

template<ComputeStage compute_stage>
const ADVariableValue & ScalarCoupleable::adCoupledScalarValueTempl ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedinherited

Returns AD value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a ADVariableValue for the coupled variable

Definition at line 138 of file ScalarCoupleable.C.

139 {
140  checkVar(var_name);
141  if (!isCoupledScalar(var_name, comp))
142  return *getADDefaultValue<compute_stage>(var_name);
143 
144  MooseVariableScalar * var = getScalarVar(var_name, comp);
145 
146  if (_sc_is_implicit)
147  return var->adSln<compute_stage>();
148  else
149  mooseError("adCoupledValue for non-implicit calculations is not currently supported. Use "
150  "coupledValue instead for non-implicit");
151 }

◆ addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID  tag)
inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

55 { _sc_coupleable_matrix_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue().

◆ addScalarVariableCoupleableVectorTag()

void ScalarCoupleable::addScalarVariableCoupleableVectorTag ( TagID  tag)
inlineinherited

Definition at line 53 of file ScalarCoupleable.h.

53 { _sc_coupleable_vector_tags.insert(tag); }

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

◆ average()

Real Function::average ( ) const
virtualinherited

Reimplemented in PiecewiseConstant, and PiecewiseLinearBase.

Definition at line 77 of file Function.C.

78 {
79  mooseError("Average method not defined for function ", name());
80  return 0;
81 }

◆ checkVar()

void ScalarCoupleable::checkVar ( const std::string &  var_name)
protectedinherited

Check that the right kind of variable is being coupled in.

Parameters
var_nameThe name of the coupled variable

Definition at line 294 of file ScalarCoupleable.C.

295 {
296  auto it = _sc_coupled_vars.find(var_name);
297  if (it != _sc_coupled_vars.end())
298  {
299  std::string cvars;
300  for (auto jt : it->second)
301  cvars += " " + jt->name();
303  ": Trying to couple a field variable where scalar variable is expected, '",
304  var_name,
305  " =",
306  cvars,
307  "'");
308  }
309  // NOTE: non-existent variables are handled in the constructor
310 }

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalar(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

◆ coupledMatrixTagScalarValue()

VariableValue & ScalarCoupleable::coupledMatrixTagScalarValue ( const std::string &  var_name,
TagID  tag,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
tagTag ID of coupled matrix;
compComponent number for vector of coupled variables
Returns
Reference to a VariableValue for the coupled variable

Definition at line 199 of file ScalarCoupleable.C.

202 {
203  checkVar(var_name);
204  if (!isCoupledScalar(var_name, comp))
205  return *getDefaultValue(var_name);
206 
208 
209  MooseVariableScalar * var = getScalarVar(var_name, comp);
210  return var->matrixTagSln(tag);
211 }

◆ coupledPostprocessors()

unsigned int PostprocessorInterface::coupledPostprocessors ( const std::string &  name) const
inherited

Returns number of Postprocessors coupled under parameter name.

Parameters
nameThe name of the Postprocessor parameter
Returns
Number of coupled post-processors, 1 if it's a single

Definition at line 146 of file PostprocessorInterface.C.

147 {
148  if (singlePostprocessor(name))
149  return 1;
150  return _ppi_params.get<std::vector<PostprocessorName>>(name).size();
151 }

◆ coupledScalar()

unsigned int ScalarCoupleable::coupledScalar ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the index for a scalar coupled variable by name.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Index of coupled variable

Definition at line 95 of file ScalarCoupleable.C.

96 {
97  checkVar(var_name);
98  return getScalarVar(var_name, comp)->number();
99 }

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarComponents()

unsigned int ScalarCoupleable::coupledScalarComponents ( const std::string &  var_name)
protectedvirtualinherited

Return the number of components to the coupled scalar variable.

Parameters
var_nameThe of the coupled variable

Definition at line 341 of file ScalarCoupleable.C.

342 {
343  return _coupled_scalar_vars[var_name].size();
344 }

◆ coupledScalarDot()

VariableValue & ScalarCoupleable::coupledScalarDot ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the time derivative of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a time derivative VariableValue for the coupled variable

Definition at line 241 of file ScalarCoupleable.C.

242 {
243  checkVar(var_name);
244  validateExecutionerType(var_name, "coupledScalarDot");
245  MooseVariableScalar * var = getScalarVar(var_name, comp);
246  return var->uDot();
247 }

◆ coupledScalarDotDot()

VariableValue & ScalarCoupleable::coupledScalarDotDot ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the second time derivative of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a time derivative VariableValue for the coupled variable

Definition at line 250 of file ScalarCoupleable.C.

251 {
252  checkVar(var_name);
253  validateExecutionerType(var_name, "coupledScalarDotDot");
254  MooseVariableScalar * var = getScalarVar(var_name, comp);
255  return var->uDotDot();
256 }

◆ coupledScalarDotDotDu()

VariableValue & ScalarCoupleable::coupledScalarDotDotDu ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Second time derivative of a scalar coupled variable with respect to the coefficients.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Definition at line 285 of file ScalarCoupleable.C.

286 {
287  checkVar(var_name);
288  validateExecutionerType(var_name, "coupledScalarDotDotDu");
289  MooseVariableScalar * var = getScalarVar(var_name, comp);
290  return var->duDotDotDu();
291 }

◆ coupledScalarDotDotOld()

VariableValue & ScalarCoupleable::coupledScalarDotDotOld ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the old second time derivative of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a time derivative VariableValue for the coupled variable

Definition at line 268 of file ScalarCoupleable.C.

269 {
270  checkVar(var_name);
271  validateExecutionerType(var_name, "coupledScalarDotDotOld");
272  MooseVariableScalar * var = getScalarVar(var_name, comp);
273  return var->uDotDotOld();
274 }

◆ coupledScalarDotDu()

VariableValue & ScalarCoupleable::coupledScalarDotDu ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Time derivative of a scalar coupled variable with respect to the coefficients.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a VariableValue containing the time derivative of the coupled variable with respect to the coefficients

Definition at line 276 of file ScalarCoupleable.C.

277 {
278  checkVar(var_name);
279  validateExecutionerType(var_name, "coupledScalarDotDu");
280  MooseVariableScalar * var = getScalarVar(var_name, comp);
281  return var->duDotDu();
282 }

◆ coupledScalarDotOld()

VariableValue & ScalarCoupleable::coupledScalarDotOld ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the old time derivative of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a time derivative VariableValue for the coupled variable

Definition at line 259 of file ScalarCoupleable.C.

260 {
261  checkVar(var_name);
262  validateExecutionerType(var_name, "coupledScalarDotOld");
263  MooseVariableScalar * var = getScalarVar(var_name, comp);
264  return var->uDotOld();
265 }

◆ coupledScalarOrder()

Order ScalarCoupleable::coupledScalarOrder ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the order for a scalar coupled variable by name.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Order of coupled variable

Definition at line 102 of file ScalarCoupleable.C.

103 {
104  checkVar(var_name);
105  if (!isCoupledScalar(var_name, comp))
107 
108  return getScalarVar(var_name, comp)->order();
109 }

◆ coupledScalarValue()

VariableValue & ScalarCoupleable::coupledScalarValue ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a VariableValue for the coupled variable

Definition at line 126 of file ScalarCoupleable.C.

127 {
128  checkVar(var_name);
129  if (!isCoupledScalar(var_name, comp))
130  return *getDefaultValue(var_name);
131 
132  MooseVariableScalar * var = getScalarVar(var_name, comp);
133  return (_sc_is_implicit) ? var->sln() : var->slnOld();
134 }

Referenced by ParsedODEKernel::ParsedODEKernel().

◆ coupledScalarValueOld()

VariableValue & ScalarCoupleable::coupledScalarValueOld ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the old (previous time step) value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a old VariableValue for the coupled variable

Definition at line 214 of file ScalarCoupleable.C.

215 {
216  checkVar(var_name);
217  if (!isCoupledScalar(var_name, comp))
218  return *getDefaultValue(var_name);
219 
220  validateExecutionerType(var_name, "coupledScalarValueOld");
221  MooseVariableScalar * var = getScalarVar(var_name, comp);
222  return (_sc_is_implicit) ? var->slnOld() : var->slnOlder();
223 }

◆ coupledScalarValueOlder()

VariableValue & ScalarCoupleable::coupledScalarValueOlder ( const std::string &  var_name,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns the older (two time steps previous) value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
compComponent number for vector of coupled variables
Returns
Reference to a older VariableValue for the coupled variable

Definition at line 226 of file ScalarCoupleable.C.

227 {
228  checkVar(var_name);
229  if (!isCoupledScalar(var_name, comp))
230  return *getDefaultValue(var_name);
231 
232  validateExecutionerType(var_name, "coupledScalarValueOlder");
233  MooseVariableScalar * var = getScalarVar(var_name, comp);
234  if (_sc_is_implicit)
235  return var->slnOlder();
236  else
237  mooseError("Older values not available for explicit schemes");
238 }

◆ coupledVectorTagScalarValue()

VariableValue & ScalarCoupleable::coupledVectorTagScalarValue ( const std::string &  var_name,
TagID  tag,
unsigned int  comp = 0 
)
protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters
var_nameName of coupled variable
tagTag ID of coupled vector ;
compComponent number for vector of coupled variables
Returns
Reference to a VariableValue for the coupled variable

Definition at line 184 of file ScalarCoupleable.C.

187 {
188  checkVar(var_name);
189  if (!isCoupledScalar(var_name, comp))
190  return *getDefaultValue(var_name);
191 
193 
194  MooseVariableScalar * var = getScalarVar(var_name, comp);
195  return var->vectorTagSln(tag);
196 }

◆ declareRecoverableData() [1/2]

template<typename T >
T & Restartable::declareRecoverableData ( const std::string &  data_name)
protectedinherited

Declare a piece of data as "recoverable".

This means that in the event of a recovery this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)

Definition at line 295 of file Restartable.h.

296 {
297  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
298 
300 
301  return declareRestartableDataWithContext<T>(data_name, nullptr);
302 }

◆ declareRecoverableData() [2/2]

template<typename T >
T & Restartable::declareRecoverableData ( const std::string &  data_name,
const T &  init_value 
)
protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data

Definition at line 306 of file Restartable.h.

307 {
308  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
309 
311 
312  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
313 }

◆ declareRestartableDataTempl() [1/2]

template<typename T >
T & Restartable::declareRestartableDataTempl ( const std::string &  data_name)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)

Definition at line 222 of file Restartable.h.

223 {
224  return declareRestartableDataWithContext<T>(data_name, nullptr);
225 }

◆ declareRestartableDataTempl() [2/2]

template<typename T >
T & Restartable::declareRestartableDataTempl ( const std::string &  data_name,
const T &  init_value 
)
protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data

Definition at line 229 of file Restartable.h.

230 {
231  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
232 }

◆ declareRestartableDataWithContext() [1/2]

template<typename T >
T & Restartable::declareRestartableDataWithContext ( const std::string &  data_name,
const T &  init_value,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data
contextContext pointer that will be passed to the load and store functions

Definition at line 250 of file Restartable.h.

253 {
254  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
255 
256  // Here we will create the RestartableData even though we may not use this instance.
257  // If it's already in use, the App will return a reference to the existing instance and we'll
258  // return that one instead. We might refactor this to have the app create the RestartableData
259  // at a later date.
260  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
261  auto & restartable_data_ref = static_cast<RestartableData<T> &>(
262  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid));
263 
264  restartable_data_ref.set() = init_value;
265  return restartable_data_ref.get();
266 }

◆ declareRestartableDataWithContext() [2/2]

template<typename T >
T & Restartable::declareRestartableDataWithContext ( const std::string &  data_name,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
contextContext pointer that will be passed to the load and store functions

Definition at line 236 of file Restartable.h.

237 {
238  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
239  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
240 
241  // See comment in overloaded version of this function with "init_value"
242  auto & restartable_data_ref = static_cast<RestartableData<T> &>(
243  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid));
244 
245  return restartable_data_ref.get();
246 }

◆ declareRestartableDataWithObjectName()

template<typename T >
T & Restartable::declareRestartableDataWithObjectName ( const std::string &  data_name,
const std::string &  object_name 
)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
object_nameA supplied name for the object that is declaring this data.

Definition at line 270 of file Restartable.h.

272 {
273  return declareRestartableDataWithObjectNameWithContext<T>(data_name, object_name, nullptr);
274 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >
T & Restartable::declareRestartableDataWithObjectNameWithContext ( const std::string &  data_name,
const std::string &  object_name,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
object_nameA supplied name for the object that is declaring this data.
contextContext pointer that will be passed to the load and store functions

Definition at line 278 of file Restartable.h.

281 {
282  std::string old_name = _restartable_name;
283 
284  _restartable_name = object_name;
285 
286  T & value = declareRestartableDataWithContext<T>(data_name, context);
287 
288  _restartable_name = old_name;
289 
290  return value;
291 }

◆ declareRestartableDataWithPrefixOverrideAndContext()

template<typename T >
T& Restartable::declareRestartableDataWithPrefixOverrideAndContext ( const std::string &  data_name,
const std::string &  prefix,
void *  context 
)
protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters
data_nameThe name of the data (usually just use the same name as the member variable)
prefixThe prefix to prepend to the data_name, to retrieve data from another object.
contextContext pointer that will be passed to the load and store functions

◆ derivative()

Real BicubicSplineFunction::derivative ( const Point &  p,
unsigned int  deriv_var 
) const
virtual

Definition at line 144 of file BicubicSplineFunction.C.

145 {
146  Real yp1, ypn;
147  Point x1(0, 0, 0);
148  Point xn(0, 0, 0);
149  if (deriv_var == 1)
150  {
151  // Call yx11/yx1n with the correctly oriented points
152  Real x1_begin = _x1[0];
153  Real x1_end = p(_x2_index);
154  Real xn_begin = _x1.back();
155  Real xn_end = p(_x2_index);
156 
157  x1(_x1_index) = x1_begin;
158  x1(_x2_index) = x1_end;
159  xn(_x1_index) = xn_begin;
160  xn(_x2_index) = xn_end;
161 
162  yp1 = _yx1.value(0, x1);
163  ypn = _yx1.value(0, xn);
164  }
165  else if (deriv_var == 2)
166  {
167  // Call yx11/yx1n with the correctly oriented points
168  Real x1_begin = p(_x1_index);
169  Real x1_end = _x2[0];
170  Real xn_begin = p(_x1_index);
171  Real xn_end = _x2.back();
172 
173  x1(_x1_index) = x1_begin;
174  x1(_x2_index) = x1_end;
175  xn(_x1_index) = xn_begin;
176  xn(_x2_index) = xn_end;
177 
178  yp1 = _yx2.value(0, x1);
179  ypn = _yx2.value(0, xn);
180  }
181  else
182  mooseError("deriv_var must equal 1 or 2");
183 
184  return _ipol.sampleDerivative(p(_x1_index), p(_x2_index), deriv_var, yp1, ypn);
185 }

Referenced by gradient().

◆ enabled()

virtual bool MooseObject::enabled ( ) const
inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const
inherited

(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType

Definition at line 87 of file SetupInterface.C.

88 {
89  // TODO: ExecFlagType
90  mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
91  "ExecFlagEnum for execute flags. This method maintains the behavior of the "
92  "original method but the use of this method should be removed from your "
93  "application. The ExecFlagEnum should be inspected directly via the "
94  "getExecuteOnEnum() method.");
95 
96  unsigned int exec_bit_field = EXEC_NONE;
97  for (const auto & flag : _exec_flags)
98  exec_bit_field |= flag.id();
99  return ExecFlagType("deprecated", exec_bit_field);
100 }

◆ execFlags()

const std::vector< ExecFlagType > & SetupInterface::execFlags ( ) const
virtualinherited

(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType

Reimplemented in MultiAppTransfer.

Definition at line 75 of file SetupInterface.C.

76 {
77  // TODO: ExecFlagType
78  mooseDeprecated("The execFlags() method is being removed because MOOSE has been updated to use a "
79  "ExecFlagEnum for execute flags. The current flags should be retrieved from "
80  "the \"exeucte_on\" parameters of your object or by using the \"_execute_enum\" "
81  "reference to the parameter or the getExecuteOnEnum() method.");
82 
83  return _exec_flags;
84 }

◆ getADDefaultValue()

template<ComputeStage compute_stage>
ADVariableValue* ScalarCoupleable::getADDefaultValue ( const std::string &  var_name)
protectedinherited

Helper method to return (and insert if necessary) the AD default value for an uncoupled variable.

Parameters
var_namethe name of the variable for which to retrieve a default value
Returns
ADVariableValue * a pointer to the associated ADVariableValue.

◆ getCheckedPointerParam()

template<typename T >
T MooseObject::getCheckedPointerParam ( const std::string &  name,
const std::string &  error_string = "" 
) const
inlineinherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 91 of file MooseObject.h.

92  {
93  return parameters().getCheckedPointerParam<T>(name, error_string);
94  }

◆ getCoupledMooseScalarVars()

const std::vector< MooseVariableScalar * > & ScalarCoupleable::getCoupledMooseScalarVars ( )
inherited

Get the list of coupled scalar variables.

Returns
The list of coupled variables

Definition at line 68 of file ScalarCoupleable.C.

69 {
71 }

Referenced by AuxScalarKernel::AuxScalarKernel(), and ScalarInitialCondition::ScalarInitialCondition().

◆ getDefaultPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getDefaultPostprocessorValue ( const std::string &  name)
inherited

Return the default postprocessor value.

Parameters
nameThe name of the postprocessor parameter
Returns
A const reference to the default value

Definition at line 166 of file PostprocessorInterface.C.

167 {
169 }

Referenced by EigenKernel::EigenKernel().

◆ getDefaultValue()

VariableValue * ScalarCoupleable::getDefaultValue ( const std::string &  var_name)
protectedinherited

Helper method to return (and insert if necessary) the default value for an uncoupled variable.

Parameters
var_namethe name of the variable for which to retrieve a default value
Returns
VariableValue * a pointer to the associated VarirableValue.

Definition at line 112 of file ScalarCoupleable.C.

113 {
114  auto default_value_it = _default_value.find(var_name);
115  if (default_value_it == _default_value.end())
116  {
117  auto value = libmesh_make_unique<VariableValue>(
119  default_value_it = _default_value.insert(std::make_pair(var_name, std::move(value))).first;
120  }
121 
122  return default_value_it->second.get();
123 }

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const
inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 69 of file SetupInterface.C.

70 {
71  return _execute_enum;
72 }

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and MultiAppTransfer::checkMultiAppExecuteOn().

◆ getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )
staticinherited

(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType

Returns
A MooseEnum with the available 'execute_on' options, the default is 'residual'

Definition at line 103 of file SetupInterface.C.

104 {
105  // TODO: ExecFlagType
106  ::mooseDeprecated("The 'getExecuteOptions' was replaced by the ExecFlagEnum class because MOOSE "
107  "was updated to use this for the execute flags and the new function provides "
108  "additional arguments for modification of the enum.");
110 }

◆ getFunction()

const Function & FunctionInterface::getFunction ( const std::string &  name) const
inherited

Get a function with a given name.

Parameters
nameThe name of the parameter key of the function to retrieve
Returns
The function with name associated with the parameter 'name'

Definition at line 31 of file FunctionInterface.C.

32 {
33  return _fni_feproblem.getFunction(_fni_params.get<FunctionName>(name), _fni_tid);
34 }

Referenced by FunctionDT::FunctionDT().

◆ getFunctionByName()

const Function & FunctionInterface::getFunctionByName ( const FunctionName &  name) const
inherited

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const
inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getParamTempl()

template<typename T >
const T & MooseObject::getParamTempl ( const std::string &  name) const
inherited

◆ getPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValue ( const std::string &  name,
unsigned int  index = 0 
)
inherited

doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values

Parameters
nameThe name of the Postprocessor parameter (see below)
indexThe index of the Postprocessor
Returns
A reference to the desired value

The name required by this method is the name that is hard-coded into your source code. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 23 of file PostprocessorInterface.C.

24 {
25  if (singlePostprocessor(name) && index > 0)
26  mooseError("Postprocessor requested with index ",
27  index,
28  " when only a single postprocessor is coupled.");
29 
30  // Return the default if the Postprocessor does not exist and a default does, otherwise
31  // continue as usual
32  if (!hasPostprocessor(name, index) && _ppi_params.hasDefaultPostprocessorValue(name, index))
33  return _ppi_params.getDefaultPostprocessorValue(name, false, index);
34  else
35  {
36  if (singlePostprocessor(name))
37  return _pi_feproblem.getPostprocessorValue(_ppi_params.get<PostprocessorName>(name));
38 
39  // check size of parameter array here
40  if (index >= _ppi_params.get<std::vector<PostprocessorName>>(name).size())
41  mooseError("Postprocessor requested with index ",
42  index,
43  " but parameter ",
44  name,
45  " has only ",
46  _ppi_params.get<std::vector<PostprocessorName>>(name).size(),
47  " entries.");
48 
50  _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
51  }
52 }

Referenced by GeneralUserObject::getPostprocessorValue(), and AuxKernelTempl< ComputeValueType >::getPostprocessorValue().

◆ getPostprocessorValueByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueByName ( const PostprocessorName &  name)
inherited

Retrieve the value of the Postprocessor.

Parameters
namePostprocessor name (see below)
Returns
A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 119 of file PostprocessorInterface.C.

120 {
122 }

Referenced by EigenKernel::EigenKernel(), GeneralUserObject::getPostprocessorValueByName(), AuxKernelTempl< ComputeValueType >::getPostprocessorValueByName(), EigenExecutionerBase::inversePowerIteration(), and ParsedODEKernel::ParsedODEKernel().

◆ getPostprocessorValueOld()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOld ( const std::string &  name,
unsigned int  index = 0 
)
inherited

Definition at line 55 of file PostprocessorInterface.C.

56 {
57  if (singlePostprocessor(name) && index > 0)
58  mooseError("Postprocessor requested with index ",
59  index,
60  " when only a single postprocessor is coupled.");
61 
62  // Return the default if the Postprocessor does not exist and a default does, otherwise
63  // continue as usual
64  if (!hasPostprocessor(name, index) && _ppi_params.hasDefaultPostprocessorValue(name, index))
65  return _ppi_params.getDefaultPostprocessorValue(name, false, index);
66  else
67  {
68  if (singlePostprocessor(name))
69  return _pi_feproblem.getPostprocessorValueOld(_ppi_params.get<PostprocessorName>(name));
70 
71  // check size of parameter array here
72  if (index >= _ppi_params.get<std::vector<PostprocessorName>>(name).size())
73  mooseError("Postprocessor requested with index ",
74  index,
75  " but parameter ",
76  name,
77  " has only ",
78  _ppi_params.get<std::vector<PostprocessorName>>(name).size(),
79  " entries.");
80 
82  _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
83  }
84 }

◆ getPostprocessorValueOldByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOldByName ( const PostprocessorName &  name)
inherited

Definition at line 125 of file PostprocessorInterface.C.

126 {
128 }

Referenced by EigenKernel::EigenKernel().

◆ getPostprocessorValueOlder()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlder ( const std::string &  name,
unsigned int  index = 0 
)
inherited

Definition at line 87 of file PostprocessorInterface.C.

88 {
89  if (singlePostprocessor(name) && index > 0)
90  mooseError("Postprocessor requested with index ",
91  index,
92  " when only a single postprocessor is coupled.");
93 
94  // Return the default if the Postprocessor does not exist and a default does, otherwise
95  // continue as usual
96  if (!hasPostprocessor(name, index) && _ppi_params.hasDefaultPostprocessorValue(name, index))
97  return _ppi_params.getDefaultPostprocessorValue(name, false, index);
98  else
99  {
100  if (singlePostprocessor(name))
101  return _pi_feproblem.getPostprocessorValueOlder(_ppi_params.get<PostprocessorName>(name));
102 
103  // check size of parameter array here
104  if (index >= _ppi_params.get<std::vector<PostprocessorName>>(name).size())
105  mooseError("Postprocessor requested with index ",
106  index,
107  " but parameter ",
108  name,
109  " has only ",
110  _ppi_params.get<std::vector<PostprocessorName>>(name).size(),
111  " entries.");
112 
114  _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
115  }
116 }

◆ getPostprocessorValueOlderByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlderByName ( const PostprocessorName &  name)
inherited

Definition at line 131 of file PostprocessorInterface.C.

132 {
134 }

◆ getScalarVar()

MooseVariableScalar * ScalarCoupleable::getScalarVar ( const std::string &  var_name,
unsigned int  comp 
)
protectedinherited

Extract pointer to a scalar coupled variable.

Parameters
var_nameName of parameter desired
compComponent number of multiple coupled variables
Returns
Pointer to the desired variable

Definition at line 313 of file ScalarCoupleable.C.

314 {
315  if (_coupled_scalar_vars.find(var_name) != _coupled_scalar_vars.end())
316  {
317  if (comp < _coupled_scalar_vars[var_name].size())
318  return _coupled_scalar_vars[var_name][comp];
319  else
320  mooseError(_sc_name, ": Trying to get a non-existent component of variable '", var_name, "'");
321  }
322  else
323  mooseError(_sc_name, ": Trying to get a non-existent variable '", var_name, "'");
324 }

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalar(), ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), ScalarCoupleable::coupledVectorTagScalarValue(), and ParsedODEKernel::ParsedODEKernel().

◆ getScalarVariableCoupleableMatrixTags()

std::set<TagID>& ScalarCoupleable::getScalarVariableCoupleableMatrixTags ( )
inlineinherited

Definition at line 51 of file ScalarCoupleable.h.

◆ getScalarVariableCoupleableVectorTags()

std::set<TagID>& ScalarCoupleable::getScalarVariableCoupleableVectorTags ( )
inlineinherited

Definition at line 49 of file ScalarCoupleable.h.

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase ( const std::string &  name)
inherited

Get an user object with a given parameter name.

Parameters
nameThe name of the parameter key of the user object to retrieve
Returns
The user object with name associated with the parameter 'name'

Definition at line 24 of file UserObjectInterface.C.

25 {
26  return _uoi_feproblem.getUserObjectBase(_uoi_params.get<UserObjectName>(name));
27 }

Referenced by InitialConditionBase::getUserObjectBase(), AuxKernelTempl< ComputeValueType >::getUserObjectBase(), and UserObjectInterface::getUserObjectTempl().

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName ( const std::string &  name)
inherited

Get an user object with a given name.

Parameters
nameThe name of the user object to retrieve
Returns
The user object with the name

Definition at line 30 of file UserObjectInterface.C.

31 {
32  return _uoi_feproblem.getUserObjectBase(name);
33 }

Referenced by UserObjectInterface::getUserObjectByNameTempl().

◆ getUserObjectByNameTempl()

template<class T >
const T & UserObjectInterface::getUserObjectByNameTempl ( const std::string &  name)
inherited

Get an user object with a given name.

Parameters
nameThe name of the user object to retrieve
Returns
The user object with the name

Definition at line 93 of file UserObjectInterface.h.

94 {
95  unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
96  return _uoi_feproblem.getUserObjectTempl<T>(name, tid);
97 }

◆ getUserObjectTempl()

template<class T >
const T & UserObjectInterface::getUserObjectTempl ( const std::string &  name)
inherited

Get an user object with a given parameter name.

Parameters
nameThe name of the parameter key of the user object to retrieve
Returns
The user object with name associated with the parameter 'name'

Definition at line 85 of file UserObjectInterface.h.

86 {
87  unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
88  return _uoi_feproblem.getUserObjectTempl<T>(_uoi_params.get<UserObjectName>(name), tid);
89 }

◆ gradient()

RealGradient BicubicSplineFunction::gradient ( Real  t,
const Point &  p 
) const
overridevirtual

Function objects can optionally provide a gradient at a point.

By default this returns 0, you must override it.

Parameters
tThe time
pThe Point in space (x,y,z)
Returns
A gradient of the function evaluated at the time and location

Reimplemented from Function.

Definition at line 188 of file BicubicSplineFunction.C.

189 {
190  RealGradient grad = RealGradient(0, 0, 0);
191 
192  Real dF_dx1 = derivative(p, 1);
193  Real dF_dx2 = derivative(p, 2);
194 
195  grad(_x1_index) = dF_dx1;
196  grad(_x2_index) = dF_dx2;
197 
198  return grad;
199 }

◆ hasPostprocessor()

bool PostprocessorInterface::hasPostprocessor ( const std::string &  name,
unsigned int  index = 0 
) const
inherited

Determine if the Postprocessor exists.

Parameters
nameThe name of the Postprocessor parameter
indexThe index of the Postprocessor
Returns
True if the Postprocessor exists
See also
hasPostprocessorByName getPostprocessorValue

Definition at line 137 of file PostprocessorInterface.C.

138 {
139  if (singlePostprocessor(name))
140  return _pi_feproblem.hasPostprocessor(_ppi_params.get<PostprocessorName>(name));
142  _ppi_params.get<std::vector<PostprocessorName>>(name)[index]);
143 }

Referenced by EigenKernel::EigenKernel(), PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), PostprocessorInterface::getPostprocessorValueOlder(), and TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction().

◆ hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName &  name)
inherited

Determine if the Postprocessor exists.

Parameters
nameThe name of the Postprocessor
Returns
True if the Postprocessor exists
See also
hasPostprocessor getPostprocessorValueByName

Definition at line 160 of file PostprocessorInterface.C.

161 {
162  return _pi_feproblem.hasPostprocessor(name);
163 }

Referenced by VectorOfPostprocessors::VectorOfPostprocessors().

◆ initialSetup()

void SetupInterface::initialSetup ( )
virtualinherited

◆ integral()

Real Function::integral ( ) const
virtualinherited

Reimplemented in PiecewiseConstant, and PiecewiseLinearBase.

Definition at line 70 of file Function.C.

71 {
72  mooseError("Integral method not defined for function ", name());
73  return 0;
74 }

◆ isCoupledScalar()

bool ScalarCoupleable::isCoupledScalar ( const std::string &  var_name,
unsigned int  i = 0 
)
protectedvirtualinherited

Returns true if a variables has been coupled_as name.

Parameters
var_nameThe of the coupled variable
iBy default 0, in general the index to test in a vector of MooseVariable pointers.

Definition at line 74 of file ScalarCoupleable.C.

75 {
76  auto it = _coupled_scalar_vars.find(var_name);
77  if (it != _coupled_scalar_vars.end())
78  return (i < it->second.size());
79  else
80  {
81  // Make sure the user originally requested this value in the InputParameter syntax
82  if (!_coupleable_params.hasCoupledValue(var_name))
84  ": The coupled scalar variable \"",
85  var_name,
86  "\" was never added to this objects's "
87  "InputParameters, please double-check "
88  "your spelling");
89 
90  return false;
91  }
92 }

Referenced by ScalarCoupleable::adCoupledScalarValueTempl(), ScalarCoupleable::coupledMatrixTagScalarValue(), ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::coupledScalarValue(), ScalarCoupleable::coupledScalarValueOld(), ScalarCoupleable::coupledScalarValueOlder(), and ScalarCoupleable::coupledVectorTagScalarValue().

◆ isImplicit()

bool TransientInterface::isImplicit ( )
inlineinherited

Definition at line 42 of file TransientInterface.h.

42 { return _is_implicit; }

◆ isParamValid()

bool MooseObject::isParamValid ( const std::string &  name) const
inlineinherited

Test if the supplied parameter is valid.

Parameters
nameThe name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

Referenced by AdvancedOutput::AdvancedOutput(), BicubicSplineFunction(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), CSVReader::CSVReader(), DGKernelBase::DGKernelBase(), MultiAppNearestNodeTransfer::execute(), Executioner::Executioner(), Exodus::Exodus(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), ExtraNodesetGenerator::generate(), RenameBoundaryGenerator::generate(), RenameBlockGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementSubdomainIDGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MeshSideSetGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainMeshGenerator::generate(), MeshExtruderGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MultiAppNearestNodeTransfer::getLocalEntities(), MultiAppNearestNodeTransfer::getLocalEntitiesAndComponents(), MeshGenerator::getMesh(), MultiAppNearestNodeTransfer::getNearestNode(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), MooseParsedVectorFunction::initialSetup(), Console::initialSetup(), Receiver::initialSetup(), SolutionFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), MatDiffusionBase< Real >::MatDiffusionBase(), MeshGeneratorMesh::MeshGeneratorMesh(), BreakBoundaryOnSubdomain::modify(), MeshExtruder::modify(), MeshSideSet::modify(), LowerDBlockFromSideset::modify(), AssignElementSubdomainID::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), SubdomainBoundingBox::modify(), MooseMesh::MooseMesh(), EigenExecutionerBase::normalizeSolution(), Output::Output(), PetscOutput::PetscOutput(), PiecewiseBase::PiecewiseBase(), SolutionUserObject::readExodusII(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), SolutionUserObject::SolutionUserObject(), and TimePeriod::TimePeriod().

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )
virtualinherited

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in EqualValueEmbeddedConstraint.

Definition at line 54 of file SetupInterface.C.

55 {
56 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )
inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in DiracKernel, Console, Exodus, Nemesis, OversampleOutput, GhostingUserObject, ExplicitTimeIntegrator, EqualValueBoundaryConstraint, and GeometryBase.

Definition at line 39 of file MeshChangedInterface.h.

39 {}

◆ mooseDeprecated()

template<typename... Args>
void MooseObject::mooseDeprecated ( Args &&...  args) const
inlineinherited

Definition at line 156 of file MooseObject.h.

157  {
158  moose::internal::mooseDeprecatedStream(_console, false, std::forward<Args>(args)...);
159  }

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>
void MooseObject::mooseError ( Args &&...  args) const
inlineinherited

Definition at line 141 of file MooseObject.h.

142  {
143  std::ostringstream oss;
144  moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
145  std::string msg = oss.str();
146  callMooseErrorRaw(msg, &_app);
147  }

Referenced by GridPartitioner::_do_partition(), PetscExternalPartitioner::_do_partition(), FEProblemBase::addConstraint(), ADDGKernel< compute_stage >::ADDGKernel(), FEProblemBase::addInitialCondition(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), FEProblemBase::addOutput(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), MultiAppConservativeTransfer::adjustTransferedSolution(), MultiAppConservativeTransfer::adjustTransferedSolutionNearestPoint(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), Output::advancedExecuteOn(), MooseVariableBase::allDofIndices(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayConstantIC::ArrayConstantIC(), ArrayDGKernel::ArrayDGKernel(), ArrayDiffusion::ArrayDiffusion(), ArrayFunctionIC::ArrayFunctionIC(), ArrayReaction::ArrayReaction(), ArrayTimeDerivative::ArrayTimeDerivative(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), TiledMesh::buildMesh(), FileMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), ImageMeshGenerator::buildMesh3D(), ImageMesh::buildMesh3D(), MooseMesh::buildMeshBaseObject(), MooseMesh::buildRefinementMap(), MooseMesh::buildSideList(), CartesianMeshGenerator::CartesianMeshGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), SubProblem::checkBoundaryMatProps(), FEProblemBase::checkCoordinateSystems(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), MaterialBase::checkExecutionStage(), BreakMeshByBlockBase::checkInputParameter(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), ExplicitTimeIntegrator::checkLinearConvergence(), FEProblemBase::checkProblemIntegrity(), MaterialBase::checkStatefulSanity(), FEProblemBase::checkUserObjects(), MultiAppTransfer::checkVariable(), LibmeshPartitioner::clone(), MooseMesh::clone(), ComparisonPostprocessor::comparisonIsTrue(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), KernelBase::computeADOffDiagJacobian(), BlockWeightedPartitioner::computeElementWeight(), ArrayDGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighResidual(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), HistogramVectorPostprocessor::computeHistogram(), ArrayKernel::computeJacobian(), ArrayIntegratedBC::computeJacobian(), ArrayIntegratedBC::computeJacobianBlock(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), ArrayKernel::computeOffDiagJacobian(), MaterialBase::computeProperties(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), KernelValue::computeQpResidual(), ArrayKernel::computeResidual(), ArrayIntegratedBC::computeResidual(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualType(), StatisticsVectorPostprocessor::computeStatValue(), MaterialBase::computeSubdomainProperties(), ActuallyExplicitEuler::computeTimeDerivatives(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), ConditionalEnableControl::ConditionalEnableControl(), TimeStepper::constrainStep(), CoupledForce::CoupledForce(), CoupledForceNodalKernel::CoupledForceNodalKernel(), SidesetInfoVectorPostprocessor::dataHelper(), DebugResidualAux::DebugResidualAux(), FunctorRelationshipManager::delete_remote_elements(), derivative(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), FunctorRelationshipManager::dofmap_reinit(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementIntegerAux::ElementIntegerAux(), ElementQualityAux::ElementQualityAux(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ElementQualityChecker::execute(), NodalValueSampler::execute(), GreaterThanLessThanPostprocessor::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), InterfaceQpValueUserObject::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), TimeExtremeValue::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFit::execute(), LeastSquaresFitHistory::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus::Exodus(), ExplicitSSPRungeKutta::ExplicitSSPRungeKutta(), FileOutput::FileOutput(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), NearestPointIntegralVariablePostprocessor::finalize(), Transfer::find_sys(), BreakMeshByBlockBase::findFreeBoundaryId(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), WorkBalance::gather(), ExtraNodesetGenerator::generate(), RenameBoundaryGenerator::generate(), RenameBlockGenerator::generate(), ElementSubdomainIDGenerator::generate(), GeneratedMeshGenerator::generate(), CombinerGenerator::generate(), SideSetsFromBoundingBoxGenerator::generate(), MeshExtruderGenerator::generate(), StackGenerator::generate(), SpiralAnnularMeshGenerator::generate(), PatternedMeshGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), RandomICBase::generateRandom(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), DisplacedProblem::getArrayVariable(), FEProblemBase::getArrayVariable(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), MooseMesh::getCoarseningMap(), Control::getControllableParameterByName(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), GhostingUserObject::getElementalValue(), ElementGenerator::getElemType(), MultiApp::getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), DistributedGeneratedMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), AnnularMesh::getMinInDimension(), DistributedGeneratedMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMesh::GetPixelInfo(), ImageMeshGenerator::GetPixelInfo(), InterfaceQpValueUserObject::getQpValue(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObjectBase(), FEProblemBase::getUserObjectTempl(), NumRelationshipManagers::getValue(), PerformanceData::getValue(), Residual::getValue(), PerfGraphData::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), GhostingAux::GhostingAux(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), EigenExecutionerBase::init(), IterationAdaptiveDT::init(), Transient::init(), MooseMesh::init(), Sampler::init(), FEProblemBase::init(), NumPicardIterations::initialize(), PiecewiseLinearBase::initialSetup(), MultiAppConservativeTransfer::initialSetup(), FullSolveMultiApp::initialSetup(), ReferenceResidualProblem::initialSetup(), SolutionScalarAux::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), Exodus::initialSetup(), SolutionFunction::initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), MaterialBase::initStatefulProperties(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InterfaceTimeKernel::InterfaceTimeKernel(), AugmentSparsityOnInterface::internalInit(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredSideIntegral::LayeredSideIntegral(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), LowerBoundNodalKernel::LowerBoundNodalKernel(), PNGOutput::makePNG(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), FunctorRelationshipManager::mesh_reinit(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshSideSetGenerator::MeshSideSetGenerator(), SideSetsFromNormals::modify(), SideSetsFromPoints::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), BreakMeshByBlockBase::modify(), AssignElementSubdomainID::modify(), SmoothMesh::modify(), AddAllSideSetsByNormals::modify(), ElementDeleterBase::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), SubdomainBoundingBox::modify(), AddSideSetsFromBoundingBox::modify(), MooseGhostPointNeighbors::MooseGhostPointNeighbors(), MooseMesh::MooseMesh(), MooseVariableBase::MooseVariableBase(), MortarConstraintBase::MortarConstraintBase(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), RenameBlockGenerator::newBlockID(), RenameBlock::newBlockID(), RenameBlockGenerator::newBlockName(), RenameBlock::newBlockName(), NewmarkBeta::NewmarkBeta(), NodalConstraint::NodalConstraint(), NodalScalarKernel::NodalScalarKernel(), NodalVariableValue::NodalVariableValue(), NumDOFs::NumDOFs(), NumNonlinearIterations::NumNonlinearIterations(), NumVars::NumVars(), FunctorRelationshipManager::operator()(), RelationshipManager::operator==(), XDA::output(), SolutionHistory::output(), Exodus::output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), Console::outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), MooseObject::paramError(), PiecewiseBilinear::parse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), ExplicitTimeIntegrator::performExplicitSolve(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), Eigenvalue::postSolve(), Predictor::Predictor(), Transient::preExecute(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), DerivativeParsedMaterialHelper::recurseDerivative(), FunctorRelationshipManager::redistribute(), ReferenceResidualProblem::ReferenceResidualProblem(), EqualValueEmbeddedConstraint::reinitConstraint(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), ScalarComponentIC::ScalarComponentIC(), secondDerivative(), FEProblemBase::setCoordSystem(), PiecewiseBase::setData(), EigenProblem::setEigenproblemType(), FEProblemSolve::setInnerSolve(), Sampler::setNumberOfCols(), Sampler::setNumberOfRandomSeeds(), Sampler::setNumberOfRows(), Exodus::setOutputDimensionInExodusWriter(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SideSetsFromNormals::SideSetsFromNormals(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPoints::SideSetsFromPoints(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), SolutionUserObject::SolutionUserObject(), PicardSolve::solve(), FullSolveMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), NearestPointIntegralVariablePostprocessor::spatialValue(), UserObject::spatialValue(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), MaterialBase::subdomainSetup(), Console::systemInfoFlags(), TagMatrixAux::TagMatrixAux(), TagVectorAux::TagVectorAux(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), TiledMeshGenerator::TiledMeshGenerator(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppFieldTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), MooseVariableScalar::uDot(), MooseVariableScalar::uDotDot(), MooseVariableScalar::uDotDotOld(), FEProblemBase::uDotDotOldRequested(), MooseVariableScalar::uDotOld(), FEProblemBase::uDotOldRequested(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), UpperBoundNodalKernel::UpperBoundNodalKernel(), NearestPointIntegralVariablePostprocessor::userObjectValue(), BoundingBoxIC::value(), Axisymmetric2D3DSolutionFunction::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), MultiAppTransfer::variableIntegrityCheck(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), VectorNodalBC::VectorNodalBC(), VectorOfPostprocessors::VectorOfPostprocessors(), VectorPostprocessorFunction::VectorPostprocessorFunction(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), VolumeHistogram::VolumeHistogram(), VTKOutput::VTKOutput(), DOFMapOutput::writeStreamToFile(), and Console::writeStreamToFile().

◆ mooseInfo()

template<typename... Args>
void MooseObject::mooseInfo ( Args &&...  args) const
inlineinherited

◆ mooseWarning()

template<typename... Args>
void MooseObject::mooseWarning ( Args &&...  args) const
inlineinherited

◆ name()

virtual const std::string& MooseObject::name ( ) const
inlinevirtualinherited

Get the name of the object.

Returns
The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

Referenced by GridPartitioner::_do_partition(), FEProblemBase::addADJacobianInterfaceMaterial(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADKernel(), FEProblemBase::addADResidualInterfaceMaterial(), FEProblemBase::addADResidualMaterial(), Executioner::addAttributeReporter(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), ADDGKernel< compute_stage >::ADDGKernel(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), Output::advancedExecuteOn(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), ArrayDGKernel::ArrayDGKernel(), DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), Function::average(), MultiApp::backup(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), MaterialBase::checkStatefulSanity(), CoarsenedPiecewiseLinear::CoarsenedPiecewiseLinear(), CompositeFunction::CompositeFunction(), MaterialBase::computeProperties(), MaterialBase::computeSubdomainProperties(), FEProblemBase::computeUserObjectByName(), VectorPostprocessorVisualizationAux::computeValue(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), FEProblemBase::declareVectorPostprocessorVector(), DOFMapOutput::demangle(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), DumpObjectsProblem::dumpObjectHelper(), ElementValueSampler::ElementValueSampler(), MooseMesh::errorIfDistributedMesh(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), StatisticsVectorPostprocessor::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), PointValue::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppNearestNodeTransfer::execute(), HistogramVectorPostprocessor::execute(), MultiAppProjectionTransfer::execute(), Exodus::Exodus(), FancyExtruderGenerator::FancyExtruderGenerator(), MultiApp::fillPositions(), PointSamplerBase::finalize(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), GeneralUserObject::GeneralUserObject(), LowerDBlockFromSidesetGenerator::generate(), GeneratedMeshGenerator::generate(), StitchedMeshGenerator::generate(), Material::getADMaterialPropertyTempl(), MultiApp::getBoundingBox(), MooseObject::getCheckedPointerParam(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), MultiApp::getExecutioner(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), FEProblemBase::getInterfaceMaterial(), SolutionUserObject::getLocalVarIndex(), Marker::getMarkerValue(), FEProblemBase::getMaterial(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), Material::getMaterialPropertyOlderTempl(), InterfaceMaterial::getMaterialPropertyOlderTempl(), NodalPatchRecovery::getMaterialPropertyOlderTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOlderTempl(), Material::getMaterialPropertyOldTempl(), InterfaceMaterial::getMaterialPropertyOldTempl(), NodalPatchRecovery::getMaterialPropertyOldTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyOldTempl(), Material::getMaterialPropertyTempl(), InterfaceMaterial::getMaterialPropertyTempl(), NodalPatchRecovery::getMaterialPropertyTempl(), AuxKernelTempl< ComputeValueType >::getMaterialPropertyTempl(), MeshGenerator::getMesh(), InterfaceMaterial::getNeighborMaterialPropertyOld(), InterfaceMaterial::getNeighborMaterialPropertyOlder(), InterfaceMaterial::getNeighborMaterialPropertyTempl(), OutputWarehouse::getOutput(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), FEProblemBase::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), FEProblemBase::getPostprocessorValueOld(), FEProblemBase::getPostprocessorValueOlder(), FEProblemBase::getSampler(), FEProblemBase::getScatterVectorPostprocessorValue(), FEProblemBase::getScatterVectorPostprocessorValueOld(), Transient::getTimeStepperName(), InitialConditionBase::getUserObjectBase(), FEProblemBase::getUserObjectBase(), InitialConditionBase::getUserObjectByNameTempl(), InitialConditionBase::getUserObjectTempl(), FEProblemBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValue(), GeneralUserObject::getVectorPostprocessorValueByName(), FEProblemBase::getVectorPostprocessorValueOld(), FEProblemBase::hasFunction(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasUserObject(), FEProblemBase::hasVectorPostprocessor(), FEProblemBase::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), SolutionScalarAux::initialSetup(), MultiAppProjectionTransfer::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), MultiApp::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPostprocessorData(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), FEProblemBase::initVectorPostprocessorData(), Function::integral(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), Registry::isADObj(), MooseObject::isParamValid(), Registry::isRegisteredObj(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), MaterialOutputAction::materialOutputHelper(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshSideSetGenerator::MeshSideSetGenerator(), ElementDeleterBase::modify(), MooseVariableInterface< Real >::MooseVariableInterface(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), Registry::objData(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), ConsoleUtils::outputExecutionInformation(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), OversampleOutput::outputStep(), Output::outputStep(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), MultiAppConservativeTransfer::postExecute(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), MaterialBase::resetQpProperties(), MultiApp::restore(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), SpatialAverageBase::SpatialAverageBase(), UserObject::spatialValue(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), SubProblem::storeSubdomainZeroMatProp(), MaterialBase::subdomainSetup(), TaggingInterface::TaggingInterface(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), Function::timeDerivative(), VectorPostprocessorVisualizationAux::timestepSetup(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), and AdvancedOutput::wantOutput().

◆ needThreadedCopy()

bool UserObjectInterface::needThreadedCopy ( const UserObject uo) const
privateinherited

Check if the threaded copy of the user object is needed.

Definition at line 36 of file UserObjectInterface.C.

37 {
38  return (dynamic_cast<const DiscreteElementUserObject *>(&uo) != NULL) ||
39  (dynamic_cast<const ThreadedGeneralUserObject *>(&uo) != NULL);
40 }

Referenced by UserObjectInterface::getUserObjectByNameTempl(), and UserObjectInterface::getUserObjectTempl().

◆ paramError()

template<typename... Args>
void MooseObject::paramError ( const std::string &  param,
Args...  args 
) const
inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 215 of file MooseObject.h.

216 {
217  Moose::show_trace = false;
218  mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
219  Moose::show_trace = true;
220 }

Referenced by ADDGKernel< compute_stage >::ADDGKernel(), ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), ADVectorFunctionDirichletBC< compute_stage >::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), BlockWeightedPartitioner::BlockWeightedPartitioner(), checkComponent(), Coupleable::checkVar(), MultiAppTransfer::checkVariable(), CombinerGenerator::CombinerGenerator(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), ConstantVectorPostprocessor::ConstantVectorPostprocessor(), Coupleable::Coupleable(), DGKernel::DGKernel(), DGKernelBase::DGKernelBase(), Eigenvalue::Eigenvalue(), ElementValueSampler::ElementValueSampler(), Executioner::Executioner(), FancyExtruderGenerator::FancyExtruderGenerator(), RenameBoundaryGenerator::generate(), MeshCollectionGenerator::generate(), StackGenerator::generate(), StitchedMeshGenerator::generate(), CombinerGenerator::generate(), Sampler::getGlobalSamples(), Sampler::getLocalSamples(), Sampler::getNextLocalRow(), MultiApp::init(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), IntegratedBC::IntegratedBC(), InversePowerMethod::InversePowerMethod(), Kernel::Kernel(), PNGOutput::makeMeshFunc(), MeshCollectionGenerator::MeshCollectionGenerator(), MultiAppConservativeTransfer::MultiAppConservativeTransfer(), MultiAppInterpolationTransfer::MultiAppInterpolationTransfer(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppPostprocessorInterpolationTransfer::MultiAppPostprocessorInterpolationTransfer(), MultiAppPostprocessorToAuxScalarTransfer::MultiAppPostprocessorToAuxScalarTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), MultiAppProjectionTransfer::MultiAppProjectionTransfer(), MultiAppScalarToAuxScalarTransfer::MultiAppScalarToAuxScalarTransfer(), MultiAppTransfer::MultiAppTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), MultiAppVariableValueSampleTransfer::MultiAppVariableValueSampleTransfer(), MultiAppVectorPostprocessorTransfer::MultiAppVectorPostprocessorTransfer(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), PatchMeshGenerator::PatchMeshGenerator(), PatternedMeshGenerator::PatternedMeshGenerator(), PiecewiseFunctionTabulate::PiecewiseFunctionTabulate(), PlaneDeletionGenerator::PlaneDeletionGenerator(), RandomIC::RandomIC(), MooseMesh::setPartitioner(), MultiAppFieldTransfer::transfer(), Transfer::Transfer(), TransientMultiApp::TransientMultiApp(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), and VectorFunctionIC::VectorFunctionIC().

◆ paramErrorMsg()

template<typename... Args>
std::string MooseObject::paramErrorMsg ( const std::string &  param,
Args...  args 
) const
inlineprivateinherited

Definition at line 185 of file MooseObject.h.

186  {
187  auto prefix = paramErrorPrefix(_pars, param);
188  std::ostringstream oss;
189  moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
190  std::string msg = oss.str();
191 
192  // Wrap error message to a separate line from prefix if it is about to
193  // blow past 100 chars. But only wrap if the prefix is long enough (12
194  // chars) for the wrap to buy us much extra length.
195  if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
196  msg.find("\n") != std::string::npos)
197  {
198  if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
199  prefix += ":";
200  return prefix + "\n " + MooseUtils::replaceAll(msg, "\n", "\n ");
201  }
202  return prefix + " " + msg;
203  }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const
inlineinherited

Get the parameters of the object.

Returns
The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

Referenced by FEProblemBase::addADJacobianInterfaceMaterial(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADKernel(), FEProblemBase::addADResidualInterfaceMaterial(), FEProblemBase::addADResidualMaterial(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DisplacedProblem::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), FEProblemBase::addInterfaceMaterial(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addOutput(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), DisplacedProblem::addVariable(), FEProblemBase::addVectorPostprocessor(), ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), AdvancedOutput::AdvancedOutput(), ADVectorFunctionDirichletBC< compute_stage >::ADVectorFunctionDirichletBC(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), assemble_l2(), Moose::assemble_matrix(), AuxKernelTempl< ComputeValueType >::AuxKernelTempl(), AuxScalarKernel::AuxScalarKernel(), BoundsAux::BoundsAux(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), Console::Console(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), Exodus::Exodus(), FEProblem::FEProblem(), GapValueAux::GapValueAux(), MooseObject::getCheckedPointerParam(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), BlockRestrictable::initializeBlockRestrictable(), FEProblemBase::initNullSpaceVectors(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), isValid(), LayeredSideIntegral::LayeredSideIntegral(), MooseVariableInterface< Real >::MooseVariableInterface(), NodeFaceConstraint::NodeFaceConstraint(), PatchMeshGenerator::PatchMeshGenerator(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), MultiAppProjectionTransfer::projectSolution(), RandomIC::RandomIC(), InputParameterWarehouse::removeInputParameters(), EigenProblem::scaleEigenvector(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), DumpObjectsProblem::stringifyParameters(), Transient::Transient(), VectorBodyForce::VectorBodyForce(), VectorFunctionDirichletBC::VectorFunctionDirichletBC(), and VectorFunctionIC::VectorFunctionIC().

◆ paramInfo()

template<typename... Args>
void MooseObject::paramInfo ( const std::string &  param,
Args...  args 
) const
inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 231 of file MooseObject.h.

232 {
233  mooseInfo(paramErrorMsg(param, std::forward<Args>(args)...));
234 }

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>
void MooseObject::paramWarning ( const std::string &  param,
Args...  args 
) const
inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 224 of file MooseObject.h.

225 {
226  mooseWarning(paramErrorMsg(param, std::forward<Args>(args)...));
227 }

Referenced by Executioner::Executioner().

◆ registerRestartableDataOnApp()

RestartableDataValue & Restartable::registerRestartableDataOnApp ( const std::string &  name,
std::unique_ptr< RestartableDataValue data,
THREAD_ID  tid 
)
privateinherited

Helper function for actually registering the restartable data.

Definition at line 48 of file Restartable.C.

51 {
52  return _restartable_app.registerRestartableData(name, std::move(data), tid, false, false);
53 }

Referenced by Restartable::declareRestartableDataWithContext().

◆ registerRestartableNameWithFilterOnApp()

void Restartable::registerRestartableNameWithFilterOnApp ( const std::string &  name,
Moose::RESTARTABLE_FILTER  filter 
)
privateinherited

Helper function for actually registering the restartable data.

Definition at line 56 of file Restartable.C.

58 {
60 }

Referenced by Restartable::declareRecoverableData().

◆ residualSetup()

void SetupInterface::residualSetup ( )
virtualinherited

Gets called just before the residual is computed and before this object is asked to do its job.

Reimplemented in NodeFaceConstraint.

Definition at line 59 of file SetupInterface.C.

60 {
61 }

◆ secondDerivative()

Real BicubicSplineFunction::secondDerivative ( const Point &  p,
unsigned int  deriv_var 
) const
virtual

Definition at line 202 of file BicubicSplineFunction.C.

203 {
204  Real yp1, ypn;
205  Point x1(0, 0, 0);
206  Point xn(0, 0, 0);
207  if (deriv_var == 1)
208  {
209  // Call yx11/yx1n with the correctly oriented points
210  Real x1_begin = _x1[0];
211  Real x1_end = p(_x2_index);
212  Real xn_begin = _x1.back();
213  Real xn_end = p(_x2_index);
214 
215  x1(_x1_index) = x1_begin;
216  x1(_x2_index) = x1_end;
217  xn(_x1_index) = xn_begin;
218  xn(_x2_index) = xn_end;
219 
220  yp1 = _yx1.value(0, x1);
221  ypn = _yx1.value(0, xn);
222  }
223  else if (deriv_var == 2)
224  {
225  // Call yx11/yx1n with the correctly oriented points
226  Real x1_begin = p(_x1_index);
227  Real x1_end = _x2[0];
228  Real xn_begin = p(_x1_index);
229  Real xn_end = _x2.back();
230 
231  x1(_x1_index) = x1_begin;
232  x1(_x2_index) = x1_end;
233  xn(_x1_index) = xn_begin;
234  xn(_x2_index) = xn_end;
235 
236  yp1 = _yx2.value(0, x1);
237  ypn = _yx2.value(0, xn);
238  }
239  else
240  mooseError("deriv_var must equal 1 or 2");
241 
242  return _ipol.sample2ndDerivative(p(_x1_index), p(_x2_index), deriv_var, yp1, ypn);
243 }

◆ singlePostprocessor()

bool PostprocessorInterface::singlePostprocessor ( const std::string &  name) const
inherited

Checks if there is a single postprocessor coupled by parameter name.

Parameters
nameThe name of the Postprocessor parameter
Returns
Number of coupled post-processors, 1 if it's a single

Definition at line 154 of file PostprocessorInterface.C.

155 {
156  return _ppi_params.isSinglePostprocessor(name);
157 }

Referenced by PostprocessorInterface::coupledPostprocessors(), PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), PostprocessorInterface::getPostprocessorValueOlder(), and PostprocessorInterface::hasPostprocessor().

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )
virtualinherited

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in Constraint, MaterialBase, Material, GeneralUserObject, NodalUserObject, and ThreadedGeneralUserObject.

Definition at line 64 of file SetupInterface.C.

65 {
66 }

◆ timeDerivative()

Real Function::timeDerivative ( Real  t,
const Point &  p 
) const
virtualinherited

Get the time derivative of the function.

Parameters
tThe time
pThe point in space (x,y,z)
Returns
The time derivative of the function at the specified time and location

Reimplemented in PiecewiseConstant, PiecewiseLinearBase, and MooseParsedFunction.

Definition at line 51 of file Function.C.

52 {
53  mooseError("timeDerivative method not defined for function ", name());
54  return 0;
55 }

◆ timestepSetup()

void SetupInterface::timestepSetup ( )
virtualinherited

Gets called at the beginning of the timestep before this object is asked to do its job.

Reimplemented in SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, EqualValueEmbeddedConstraint, VectorMemoryUsage, and MemoryUsage.

Definition at line 49 of file SetupInterface.C.

50 {
51 }

◆ type()

const std::string& MooseObject::type ( ) const
inlineinherited

Get the type of this object.

Returns
the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), DumpObjectsProblem::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), DumpObjectsProblem::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), DumpObjectsProblem::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), DumpObjectsProblem::addKernel(), DumpObjectsProblem::addMaterial(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarVariable(), PhysicsBasedPreconditioner::addSystem(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addVariable(), FEProblemBase::advanceMultiApps(), FEProblemBase::backupMultiApps(), MooseMesh::buildRefinementAndCoarseningMaps(), FEProblemBase::computeAuxiliaryKernels(), DGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), FEProblemBase::computeMultiAppsDT(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), DGConvection::computeQpJacobian(), ArrayDGDiffusion::computeQpJacobian(), InterfaceReaction::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), DGConvection::computeQpResidual(), ArrayDGDiffusion::computeQpResidual(), InterfaceReaction::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeUserObjectByName(), FEProblemBase::computeUserObjects(), FEProblemBase::computeUserObjectsInternal(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finishMultiAppStep(), ElementSubdomainIDGenerator::generate(), ElementGenerator::getElemType(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getTransfers(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), AdvancedOutput::initShowHideLists(), RelationshipManager::isType(), AssignElementSubdomainID::modify(), ControlOutput::output(), Gnuplot::output(), CSV::output(), Exodus::output(), Console::output(), Nemesis::output(), AdvancedOutput::output(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), FEProblemBase::restoreMultiApps(), FEProblemBase::setCoupling(), PerfGraphOutput::shouldOutput(), FileOutput::shouldOutput(), Output::shouldOutput(), AdvancedOutput::shouldOutput(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), and AdvancedOutput::wantOutput().

◆ validateExecutionerType()

void ScalarCoupleable::validateExecutionerType ( const std::string &  name,
const std::string &  fn_name 
) const
protectedinherited

Checks to make sure that the current Executioner has set "_is_transient" when old/older values are coupled in.

Parameters
namethe name of the variable
fn_nameThe name of the function that called this method - used in the error message

Definition at line 327 of file ScalarCoupleable.C.

329 {
332  ": Calling '",
333  fn_name,
334  "' on variable \"",
335  name,
336  "\" when using a \"Steady\" executioner is not allowed. This value is available "
337  "only in transient simulations.");
338 }

Referenced by ScalarCoupleable::coupledScalarDot(), ScalarCoupleable::coupledScalarDotDot(), ScalarCoupleable::coupledScalarDotDotDu(), ScalarCoupleable::coupledScalarDotDotOld(), ScalarCoupleable::coupledScalarDotDu(), ScalarCoupleable::coupledScalarDotOld(), ScalarCoupleable::coupledScalarValueOld(), and ScalarCoupleable::coupledScalarValueOlder().

◆ validParams()

InputParameters BicubicSplineFunction::validParams ( )
static

Definition at line 17 of file BicubicSplineFunction.C.

18 {
20  MooseEnum normal_component("x=0 y=1 z=2", "z");
21  params.addParam<MooseEnum>(
22  "normal_component",
23  normal_component,
24  "The component of the geometry that is normal to the spline x1/x2 values");
25  params.addRequiredParam<std::vector<Real>>("x1", "The first independent coordinate.");
26  params.addRequiredParam<std::vector<Real>>("x2", "The second independent coordinate.");
27  params.addRequiredParam<std::vector<Real>>("y", "The dependent values");
28  params.addParam<std::vector<Real>>(
29  "yx11", "The values of the derivative wrt x1 on the lower interpolation grid points.");
30  params.addParam<std::vector<Real>>(
31  "yx1n", "The values of the derivative wrt x1 on the upper interpolation grid points.");
32  params.addParam<std::vector<Real>>(
33  "yx21", "The values of the derivative wrt x2 on the lower interpolation grid points.");
34  params.addParam<std::vector<Real>>(
35  "yx2n", "The values of the derivative wrt x2 on the upper interpolation grid points.");
36  params.addParam<FunctionName>(
37  "yx1", "1e30", "The functional form of the derivative with respect to x1.");
38  params.addParam<FunctionName>(
39  "yx2", "1e30", "The functional form of the derivative with respect to x2.");
40 
41  return params;
42 }

◆ value()

Real BicubicSplineFunction::value ( Real  t,
const Point &  p 
) const
overridevirtual

Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero, you must override it.

Parameters
tThe time
pThe Point in space (x,y,z)
Returns
A scalar of the function evaluated at the time and location

Reimplemented from Function.

Definition at line 121 of file BicubicSplineFunction.C.

122 {
123  // Call yx11/yx1n with the correctly oriented points
124  Real x1_begin = _x1[0];
125  Real x1_end = p(_x2_index);
126  Real xn_begin = _x1.back();
127  Real xn_end = p(_x2_index);
128 
129  Point x1(0, 0, 0);
130  Point xn(0, 0, 0);
131 
132  x1(_x1_index) = x1_begin;
133  x1(_x2_index) = x1_end;
134  xn(_x1_index) = xn_begin;
135  xn(_x2_index) = xn_end;
136 
137  Real yx11 = _yx1.value(0, x1);
138  Real yx1n = _yx1.value(0, xn);
139 
140  return _ipol.sample(p(_x1_index), p(_x2_index), yx11, yx1n);
141 }

◆ vectorCurl()

RealVectorValue Function::vectorCurl ( Real  t,
const Point &  p 
) const
virtualinherited

Override this to evaluate the curl of the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

Parameters
tThe time
pThe Point in space (x,y,z)
Returns
A vector of the curl of the function evaluated at the time and location

Reimplemented in MooseParsedVectorFunction.

Definition at line 64 of file Function.C.

65 {
66  return RealVectorValue(0, 0, 0);
67 }

◆ vectorValue()

RealVectorValue Function::vectorValue ( Real  t,
const Point &  p 
) const
virtualinherited

Override this to evaluate the vector function at a point (t,x,y,z), by default this returns a zero vector, you must override it.

Parameters
tThe time
pThe Point in space (x,y,z)
Returns
A vector of the function evaluated at the time and location

Reimplemented in MooseParsedFunction, MooseParsedGradFunction, MooseParsedVectorFunction, and LinearCombinationFunction.

Definition at line 58 of file Function.C.

59 {
60  return RealVectorValue(0, 0, 0);
61 }

Referenced by VectorFunctionDirichletBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), VectorFunctionAux::computeValue(), and VectorFunctionIC::value().

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app
protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Eigenvalue::postSolve(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console
inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), MultiApp::backup(), FEProblemBase::backupMultiApps(), ReferenceResidualProblem::checkNonlinearConvergence(), FEProblemBase::checkProblemIntegrity(), CoarsenedPiecewiseLinear::CoarsenedPiecewiseLinear(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), NonlinearSystem::computeScaling(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppCopyTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), Steady::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), MultiAppConservativeTransfer::postExecute(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), AutomaticMortarGeneration::projectMasterNodesSinglePair(), AutomaticMortarGeneration::projectSlaveNodesSinglePair(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), PicardSolve::solve(), NonlinearSystem::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Transient::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _coupleable_params

const InputParameters& ScalarCoupleable::_coupleable_params
protectedinherited

◆ _coupled_moose_scalar_vars

std::vector<MooseVariableScalar *> ScalarCoupleable::_coupled_moose_scalar_vars
protectedinherited

Vector of coupled variables.

Definition at line 214 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getCoupledMooseScalarVars(), and ScalarCoupleable::ScalarCoupleable().

◆ _coupled_scalar_vars

std::unordered_map<std::string, std::vector<MooseVariableScalar *> > ScalarCoupleable::_coupled_scalar_vars
protectedinherited

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag
protectedinherited

Reference to FEProblemBase.

Definition at line 99 of file SetupInterface.h.

◆ _default_value

std::unordered_map<std::string, std::unique_ptr<VariableValue> > ScalarCoupleable::_default_value
protectedinherited

Will hold the default value for optional coupled scalar variables.

Definition at line 208 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue().

◆ _dt

Real& TransientInterface::_dt
protectedinherited

Time step size.

Definition at line 64 of file TransientInterface.h.

Referenced by TotalVariableValue::execute(), and VariableTimeIntegrationAux::getIntegralValue().

◆ _dt_old

Real& TransientInterface::_dt_old
protectedinherited

Size of the old time step.

Definition at line 67 of file TransientInterface.h.

Referenced by VariableTimeIntegrationAux::getIntegralValue().

◆ _dual_default_value

std::unordered_map<std::string, std::unique_ptr<DualVariableValue> > ScalarCoupleable::_dual_default_value
protectedinherited

Will hold the default AD value for optional coupled scalar variables.

Definition at line 211 of file ScalarCoupleable.h.

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum
privateinherited

Empty ExecFlagEnum for the case when the "execute_on" parameter is not included.

This is private because others should not be messing with it.

Definition at line 89 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled
protectedinherited

Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _exec_flags

const std::vector<ExecFlagType> SetupInterface::_exec_flags
protectedinherited

(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType

Definition at line 96 of file SetupInterface.h.

Referenced by SetupInterface::execBitFlags(), MultiAppTransfer::execFlags(), and SetupInterface::execFlags().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum
protectedinherited

Execute settings for this oejct.

Definition at line 93 of file SetupInterface.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and SetupInterface::getExecuteOnEnum().

◆ _fni_feproblem

FEProblemBase& FunctionInterface::_fni_feproblem
privateinherited

Reference to FEProblemBase instance.

Definition at line 70 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _fni_params

const InputParameters& FunctionInterface::_fni_params
privateinherited

Parameters of the object with this interface.

Definition at line 67 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction().

◆ _fni_tid

const THREAD_ID FunctionInterface::_fni_tid
privateinherited

Thread ID.

Definition at line 73 of file FunctionInterface.h.

Referenced by FunctionInterface::getFunction(), and FunctionInterface::getFunctionByName().

◆ _ipol

BicubicSplineInterpolation BicubicSplineFunction::_ipol
mutableprotected

Definition at line 38 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction(), derivative(), secondDerivative(), and value().

◆ _is_implicit

bool TransientInterface::_is_implicit
protectedinherited

If the object is using implicit or explicit form.

This does NOT mean time scheme, but which values are going to be used in the object - either from current time or old time. Note that even explicit schemes have implicit form (it is the time derivative "kernel")

Definition at line 55 of file TransientInterface.h.

Referenced by EigenKernel::computeJacobian(), EigenKernel::computeOffDiagJacobian(), EigenKernel::EigenKernel(), EigenKernel::enabled(), and TransientInterface::isImplicit().

◆ _is_transient

bool TransientInterface::_is_transient
protectedinherited

Definition at line 70 of file TransientInterface.h.

Referenced by InterfaceTimeKernel::InterfaceTimeKernel().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem
protectedinherited

Reference to FEProblemBase instance.

Definition at line 43 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _name

const std::string& MooseObject::_name
protectedinherited

◆ _normal_component

unsigned int BicubicSplineFunction::_normal_component
protected

Definition at line 41 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction().

◆ _pars

const InputParameters& MooseObject::_pars
protectedinherited

◆ _pi_feproblem

FEProblemBase& PostprocessorInterface::_pi_feproblem
privateinherited

◆ _point_zero

const Point& ScalarCoupleable::_point_zero
protectedinherited

◆ _ppi_params

const InputParameters& PostprocessorInterface::_ppi_params
privateinherited

◆ _real_zero

const Real& ScalarCoupleable::_real_zero
protectedinherited

Scalar zero.

Definition at line 226 of file ScalarCoupleable.h.

◆ _restartable_app

MooseApp& Restartable::_restartable_app
privateinherited

Reference to the application.

Definition at line 208 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp(), and Restartable::registerRestartableNameWithFilterOnApp().

◆ _restartable_name

std::string Restartable::_restartable_name
privateinherited

◆ _restartable_system_name

std::string Restartable::_restartable_system_name
privateinherited

The system name this object is in.

Definition at line 214 of file Restartable.h.

Referenced by Restartable::declareRecoverableData(), and Restartable::declareRestartableDataWithContext().

◆ _restartable_tid

THREAD_ID Restartable::_restartable_tid
privateinherited

The thread ID for this object.

Definition at line 217 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithContext().

◆ _sc_coupleable_matrix_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_matrix_tags
privateinherited

◆ _sc_coupleable_vector_tags

std::set<TagID> ScalarCoupleable::_sc_coupleable_vector_tags
privateinherited

◆ _sc_coupled_vars

std::unordered_map<std::string, std::vector<MooseVariableFEBase *> > ScalarCoupleable::_sc_coupled_vars
privateinherited

Field variables coupled into this object (for error checking)

Definition at line 276 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), and ScalarCoupleable::ScalarCoupleable().

◆ _sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem
protectedinherited

◆ _sc_is_implicit

bool ScalarCoupleable::_sc_is_implicit
protectedinherited

◆ _sc_name

const std::string& ScalarCoupleable::_sc_name
protectedinherited

◆ _sc_parameters

const InputParameters& ScalarCoupleable::_sc_parameters
protectedinherited

Definition at line 59 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _sc_tid

THREAD_ID ScalarCoupleable::_sc_tid
protectedinherited

Thread ID of the thread using this object.

Definition at line 223 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::ScalarCoupleable().

◆ _scalar_zero

const VariableValue& ScalarCoupleable::_scalar_zero
protectedinherited

Zero value of a scalar variable.

Definition at line 229 of file ScalarCoupleable.h.

◆ _t

Real& TransientInterface::_t
protectedinherited

Time.

Definition at line 58 of file TransientInterface.h.

Referenced by GenericFunctionMaterial::computeQpFunctions(), AnalyticalIndicator::computeQpIntegral(), FunctionElementIntegral::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), ElementL2Error::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), ConvectiveFluxBC::computeQpResidual(), VectorFunctionDirichletBC::computeQpResidual(), FunctionGradientNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), FunctionNeumannBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), BodyForce::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), SinDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), FunctionDirichletBC::computeQpValue(), FunctionScalarAux::computeValue(), FunctionAux::computeValue(), SolutionScalarAux::computeValue(), VectorFunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), ConditionalFunctionEnableControl::conditionMet(), TimePeriod::conditionMet(), NodalL2Error::execute(), LineFunctionSampler::execute(), RealFunctionControl::execute(), LeastSquaresFitHistory::execute(), UserForcingFunction::f(), FunctionValuePostprocessor::getValue(), ScalarL2Error::getValue(), and SolutionUserObject::timestepSetup().

◆ _t_step

int& TransientInterface::_t_step
protectedinherited

The number of the time step.

Definition at line 61 of file TransientInterface.h.

Referenced by ChangeOverTimePostprocessor::getValue().

◆ _ti_feproblem

FEProblemBase& TransientInterface::_ti_feproblem
protectedinherited

Definition at line 47 of file TransientInterface.h.

Referenced by SolutionFunction::SolutionFunction().

◆ _ti_name

const std::string TransientInterface::_ti_name
privateinherited

Definition at line 73 of file TransientInterface.h.

◆ _ti_params

const InputParameters& TransientInterface::_ti_params
protectedinherited

Definition at line 45 of file TransientInterface.h.

◆ _type

const std::string& MooseObject::_type
protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _uoi_feproblem

FEProblemBase& UserObjectInterface::_uoi_feproblem
privateinherited

◆ _uoi_params

const InputParameters& UserObjectInterface::_uoi_params
privateinherited

Parameters of the object with this interface.

Definition at line 71 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectTempl().

◆ _uoi_tid

THREAD_ID UserObjectInterface::_uoi_tid
privateinherited

◆ _x1

std::vector<Real> BicubicSplineFunction::_x1
protected

Definition at line 43 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction(), derivative(), secondDerivative(), and value().

◆ _x1_index

Real BicubicSplineFunction::_x1_index
protected

◆ _x2

std::vector<Real> BicubicSplineFunction::_x2
protected

Definition at line 44 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction(), derivative(), and secondDerivative().

◆ _x2_index

Real BicubicSplineFunction::_x2_index
protected

◆ _yx1

const Function& BicubicSplineFunction::_yx1
protected

Definition at line 50 of file BicubicSplineFunction.h.

Referenced by derivative(), secondDerivative(), and value().

◆ _yx11

std::vector<Real> BicubicSplineFunction::_yx11
protected

Definition at line 45 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction().

◆ _yx1n

std::vector<Real> BicubicSplineFunction::_yx1n
protected

Definition at line 46 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction().

◆ _yx2

const Function& BicubicSplineFunction::_yx2
protected

Definition at line 51 of file BicubicSplineFunction.h.

Referenced by derivative(), and secondDerivative().

◆ _yx21

std::vector<Real> BicubicSplineFunction::_yx21
protected

Definition at line 47 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction().

◆ _yx2n

std::vector<Real> BicubicSplineFunction::_yx2n
protected

Definition at line 48 of file BicubicSplineFunction.h.

Referenced by BicubicSplineFunction().


The documentation for this class was generated from the following files:
InputParameters::getParamHelper
static const T & getParamHelper(const std::string &name, const InputParameters &pars, const T *the_type)
Definition: InputParameters.h:1517
FEProblemBase::getPostprocessorValue
PostprocessorValue & getPostprocessorValue(const PostprocessorName &name)
Get a reference to the value associated with the postprocessor.
Definition: FEProblemBase.C:3222
Function::Function
Function(const InputParameters &parameters)
Definition: Function.C:24
MooseObject::mooseInfo
void mooseInfo(Args &&... args) const
Definition: MooseObject.h:162
BicubicSplineFunction::_x2
std::vector< Real > _x2
Definition: BicubicSplineFunction.h:44
UserObjectInterface::needThreadedCopy
bool needThreadedCopy(const UserObject &uo) const
Check if the threaded copy of the user object is needed.
Definition: UserObjectInterface.C:36
moose::internal::mooseStreamAll
void mooseStreamAll(std::ostringstream &ss)
All of the following are not meant to be called directly - they are called by the normal macros (moos...
Definition: MooseError.C:88
MooseVariableScalar
Class for scalar variables (they are different).
Definition: MooseVariableScalar.h:30
InputParameters::hasDefaultPostprocessorValue
bool hasDefaultPostprocessorValue(const std::string &name, unsigned int index=0) const
Returns true if a default PostprocessorValue is defined.
Definition: InputParameters.C:683
PostprocessorInterface::hasPostprocessor
bool hasPostprocessor(const std::string &name, unsigned int index=0) const
Determine if the Postprocessor exists.
Definition: PostprocessorInterface.C:137
MooseObject::mooseError
void mooseError(Args &&... args) const
Definition: MooseObject.h:141
Function::value
virtual Real value(Real t, const Point &p) const
Override this to evaluate the scalar function at point (t,x,y,z), by default this returns zero,...
Definition: Function.C:39
ScalarCoupleable::isCoupledScalar
virtual bool isCoupledScalar(const std::string &var_name, unsigned int i=0)
Returns true if a variables has been coupled_as name.
Definition: ScalarCoupleable.C:74
TransientInterface::_is_implicit
bool _is_implicit
If the object is using implicit or explicit form.
Definition: TransientInterface.h:55
MooseObject::isParamValid
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition: MooseObject.h:100
MooseObject::_type
const std::string & _type
The type of this object (the Class name)
Definition: MooseObject.h:175
InputParameters::defaultCoupledValue
Real defaultCoupledValue(const std::string &coupling_name, unsigned int i=0) const
Get the default value for an optionally coupled variable.
Definition: InputParameters.C:479
UserObjectInterface::_uoi_tid
THREAD_ID _uoi_tid
Thread ID.
Definition: UserObjectInterface.h:77
Restartable::_restartable_name
std::string _restartable_name
The name of the object.
Definition: Restartable.h:211
FunctionInterface::_fni_params
const InputParameters & _fni_params
Parameters of the object with this interface.
Definition: FunctionInterface.h:67
FunctionInterface::_fni_feproblem
FEProblemBase & _fni_feproblem
Reference to FEProblemBase instance.
Definition: FunctionInterface.h:70
MooseEnumItem::id
const int & id() const
Return the numeric, name, or raw name.
Definition: MooseEnumItem.h:36
ScalarCoupleable::getScalarVar
MooseVariableScalar * getScalarVar(const std::string &var_name, unsigned int comp)
Extract pointer to a scalar coupled variable.
Definition: ScalarCoupleable.C:313
PostprocessorInterface::singlePostprocessor
bool singlePostprocessor(const std::string &name) const
Checks if there is a single postprocessor coupled by parameter name.
Definition: PostprocessorInterface.C:154
InputParameters::isSinglePostprocessor
bool isSinglePostprocessor(const std::string &pp_name) const
Getter for the _vector_of_postprocessors flag in parameters.
Definition: InputParameters.h:816
FunctionInterface::getFunction
const Function & getFunction(const std::string &name) const
Get a function with a given name.
Definition: FunctionInterface.C:31
BicubicSplineFunction::_x1
std::vector< Real > _x1
Definition: BicubicSplineFunction.h:43
ScalarCoupleable::getDefaultValue
VariableValue * getDefaultValue(const std::string &var_name)
Helper method to return (and insert if necessary) the default value for an uncoupled variable.
Definition: ScalarCoupleable.C:112
BicubicSplineFunction::_yx1n
std::vector< Real > _yx1n
Definition: BicubicSplineFunction.h:46
MooseVariableScalar::uDotDot
VariableValue & uDotDot()
Definition: MooseVariableScalar.h:79
FEProblemBase::getMaxScalarOrder
Order getMaxScalarOrder() const
Definition: FEProblemBase.C:1136
MooseEnum
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:31
ScalarCoupleable::_sc_coupleable_matrix_tags
std::set< TagID > _sc_coupleable_matrix_tags
Definition: ScalarCoupleable.h:280
Restartable::registerRestartableDataOnApp
RestartableDataValue & registerRestartableDataOnApp(const std::string &name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid)
Helper function for actually registering the restartable data.
Definition: Restartable.C:48
BicubicSplineFunction::_ipol
BicubicSplineInterpolation _ipol
Definition: BicubicSplineFunction.h:38
BicubicSplineFunction::_yx21
std::vector< Real > _yx21
Definition: BicubicSplineFunction.h:47
ScalarCoupleable::checkVar
void checkVar(const std::string &var_name)
Check that the right kind of variable is being coupled in.
Definition: ScalarCoupleable.C:294
InputParameters::addParam
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.
Definition: InputParameters.h:1198
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
ScalarCoupleable::_sc_coupleable_vector_tags
std::set< TagID > _sc_coupleable_vector_tags
Definition: ScalarCoupleable.h:278
MooseVariableScalar::adSln
const ADVariableValue & adSln() const
Return the solution with derivative information.
BicubicSplineInterpolation::sample
Real sample(Real x1, Real x2, Real yx11=_deriv_bound, Real yx1n=_deriv_bound)
Samples value at point (x1, x2)
Definition: BicubicSplineInterpolation.C:159
FEProblemBase::getUserObjectTempl
T & getUserObjectTempl(const std::string &name, unsigned int tid=0) const
Get the user object by its name.
Definition: FEProblemBase.h:755
MooseObject::_enabled
const bool & _enabled
Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.
Definition: MooseObject.h:181
RestartableData::set
T & set()
Definition: RestartableData.h:97
libMesh::RealVectorValue
VectorValue< Real > RealVectorValue
Definition: Assembly.h:30
moose::internal::mooseInfoStream
void mooseInfoStream(S &oss, Args &&... args)
Definition: MooseError.h:165
ScalarCoupleable::_sc_is_implicit
bool _sc_is_implicit
True if implicit value is required.
Definition: ScalarCoupleable.h:217
BicubicSplineInterpolation::setData
void setData(const std::vector< Real > &x1, const std::vector< Real > &x2, const std::vector< std::vector< Real >> &y, const std::vector< Real > &yx11=std::vector< Real >(), const std::vector< Real > &yx1n=std::vector< Real >(), const std::vector< Real > &yx21=std::vector< Real >(), const std::vector< Real > &yx2n=std::vector< Real >())
Set the x1, x2 and y values, and first derivatives at the edges.
Definition: BicubicSplineInterpolation.C:46
BicubicSplineInterpolation::sampleDerivative
Real sampleDerivative(Real x1, Real x2, unsigned int deriv_var, Real yp1=_deriv_bound, Real ypn=_deriv_bound)
Samples first derivative at point (x1, x2)
Definition: BicubicSplineInterpolation.C:171
BicubicSplineFunction::derivative
virtual Real derivative(const Point &p, unsigned int deriv_var) const
Definition: BicubicSplineFunction.C:144
BicubicSplineFunction::_normal_component
unsigned int _normal_component
Definition: BicubicSplineFunction.h:41
MooseVariableScalar::uDot
VariableValue & uDot()
Definition: MooseVariableScalar.h:67
MooseVariableScalar::slnOlder
VariableValue & slnOlder()
Definition: MooseVariableScalar.h:55
EXEC_NONE
const ExecFlagType EXEC_NONE
PostprocessorInterface::_pi_feproblem
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
Definition: PostprocessorInterface.h:131
UserObjectInterface::_uoi_params
const InputParameters & _uoi_params
Parameters of the object with this interface.
Definition: UserObjectInterface.h:71
ConsoleStreamInterface::_console
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
Definition: ConsoleStreamInterface.h:31
mooseError
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application.
Definition: MooseError.h:210
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
MooseVariableScalar::uDotDotOld
VariableValue & uDotDotOld()
Definition: MooseVariableScalar.h:105
ScalarCoupleable::_coupled_moose_scalar_vars
std::vector< MooseVariableScalar * > _coupled_moose_scalar_vars
Vector of coupled variables.
Definition: ScalarCoupleable.h:214
FEProblemBase::getUserObjectBase
const UserObject & getUserObjectBase(const std::string &name) const
Get the user object by its name.
Definition: FEProblemBase.C:3198
ScalarCoupleable::validateExecutionerType
void validateExecutionerType(const std::string &name, const std::string &fn_name) const
Checks to make sure that the current Executioner has set "_is_transient" when old/older values are co...
Definition: ScalarCoupleable.C:327
MooseVariableScalar::duDotDotDu
VariableValue & duDotDotDu()
Definition: MooseVariableScalar.h:124
BicubicSplineFunction::_yx2
const Function & _yx2
Definition: BicubicSplineFunction.h:51
ScalarCoupleable::_sc_coupled_vars
std::unordered_map< std::string, std::vector< MooseVariableFEBase * > > _sc_coupled_vars
Field variables coupled into this object (for error checking)
Definition: ScalarCoupleable.h:276
moose::internal::mooseDeprecatedStream
void mooseDeprecatedStream(S &oss, bool expired, Args &&... args)
Definition: MooseError.h:177
InputParameters::hasCoupledValue
bool hasCoupledValue(const std::string &coupling_name) const
Return whether or not the coupled variable exists.
Definition: InputParameters.C:458
BicubicSplineFunction::_x1_index
Real _x1_index
Definition: BicubicSplineFunction.h:54
BicubicSplineFunction::_x2_index
Real _x2_index
Definition: BicubicSplineFunction.h:55
FEProblemBase::isTransient
virtual bool isTransient() const override
Definition: FEProblemBase.h:447
MooseVariableScalar::vectorTagSln
VariableValue & vectorTagSln(TagID tag)
Definition: MooseVariableScalar.h:56
paramErrorPrefix
std::string paramErrorPrefix(const InputParameters &params, const std::string &param)
Generates a canonical paramError prefix for param-related error/warning/info messages.
Definition: MooseObject.C:24
MooseVariableScalar::duDotDu
VariableValue & duDotDu()
Definition: MooseVariableScalar.h:118
FEProblemBase::getPostprocessorValueOld
PostprocessorValue & getPostprocessorValueOld(const std::string &name)
Get the reference to the old value of a post-processor.
Definition: FEProblemBase.C:3228
ScalarCoupleable::_sc_name
const std::string & _sc_name
The name of the object this interface is part of.
Definition: ScalarCoupleable.h:62
MooseVariableBase::order
Order order() const
Get the order of this variable Note: Order enum can be implicitly converted to unsigned int.
Definition: MooseVariableBase.C:123
BicubicSplineFunction::_yx1
const Function & _yx1
Definition: BicubicSplineFunction.h:50
ScalarCoupleable::_sc_fe_problem
FEProblemBase & _sc_fe_problem
Definition: ScalarCoupleable.h:202
InputParameters::isParamValid
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another,...
Definition: InputParameters.C:257
ScalarCoupleable::_coupled_scalar_vars
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _coupled_scalar_vars
Coupled vars whose values we provide.
Definition: ScalarCoupleable.h:205
MooseVariableScalar::sln
VariableValue & sln()
Definition: MooseVariableScalar.h:46
UserObjectInterface::getUserObjectBase
const UserObject & getUserObjectBase(const std::string &name)
Get an user object with a given parameter name.
Definition: UserObjectInterface.C:24
ScalarCoupleable::_coupleable_params
const InputParameters & _coupleable_params
Local InputParameters.
Definition: ScalarCoupleable.h:220
mooseDeprecated
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:239
MooseApp::registerRestartableData
RestartableDataValue & registerRestartableData(const std::string &name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid, bool mesh_meta_data, bool read_only)
Definition: MooseApp.C:1156
callMooseErrorRaw
void callMooseErrorRaw(std::string &msg, MooseApp *app)
Definition: MooseObject.C:70
FEProblemBase::getPostprocessorValueOlder
PostprocessorValue & getPostprocessorValueOlder(const std::string &name)
Get the reference to the older value of a post-processor.
Definition: FEProblemBase.C:3234
BicubicSplineFunction::_yx11
std::vector< Real > _yx11
Definition: BicubicSplineFunction.h:45
SetupInterface::_exec_flags
const std::vector< ExecFlagType > _exec_flags
(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType
Definition: SetupInterface.h:96
ScalarCoupleable::addScalarVariableCoupleableVectorTag
void addScalarVariableCoupleableVectorTag(TagID tag)
Definition: ScalarCoupleable.h:53
MooseVariableScalar::matrixTagSln
VariableValue & matrixTagSln(TagID tag)
Definition: MooseVariableScalar.h:61
PostprocessorInterface::_ppi_params
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
Definition: PostprocessorInterface.h:128
Function::validParams
static InputParameters validParams()
Class constructor.
Definition: Function.C:15
UserObjectInterface::_uoi_feproblem
FEProblemBase & _uoi_feproblem
Reference to the FEProblemBase instance.
Definition: UserObjectInterface.h:74
FunctionInterface::FunctionInterface
FunctionInterface(const MooseObject *moose_object)
Definition: FunctionInterface.C:23
MooseUtils::replaceAll
std::string replaceAll(std::string str, const std::string &from, const std::string &to)
Replaces all occurences of from in str with to and returns the result.
Definition: MooseUtils.C:45
FEProblemBase::getFunction
virtual Function & getFunction(const std::string &name, THREAD_ID tid=0)
Definition: FEProblemBase.C:1878
InputParameters::getCheckedPointerParam
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller.
Definition: InputParameters.h:1162
BicubicSplineFunction::_yx2n
std::vector< Real > _yx2n
Definition: BicubicSplineFunction.h:48
Restartable::_restartable_app
MooseApp & _restartable_app
Reference to the application.
Definition: Restartable.h:208
Restartable::_restartable_tid
THREAD_ID _restartable_tid
The thread ID for this object.
Definition: Restartable.h:217
MooseVariableScalar::uDotOld
VariableValue & uDotOld()
Definition: MooseVariableScalar.h:92
UserObjectInterface::getUserObjectBaseByName
const UserObject & getUserObjectBaseByName(const std::string &name)
Get an user object with a given name.
Definition: UserObjectInterface.C:30
Moose::show_trace
bool show_trace
Set to true (the default) to print the stack trace with error and warning messages - false to omit it...
Definition: Moose.C:572
Moose::RESTARTABLE_FILTER::RECOVERABLE
FunctionInterface::_fni_tid
const THREAD_ID _fni_tid
Thread ID.
Definition: FunctionInterface.h:73
MooseApp::registerRestartableNameWithFilter
void registerRestartableNameWithFilter(const std::string &name, Moose::RESTARTABLE_FILTER filter)
NOTE: This is an internal function meant for MOOSE use only!
Definition: MooseApp.C:972
m
PetscInt m
Definition: PetscDMMoose.C:1504
ScalarCoupleable::_default_value
std::unordered_map< std::string, std::unique_ptr< VariableValue > > _default_value
Will hold the default value for optional coupled scalar variables.
Definition: ScalarCoupleable.h:208
MooseObject::_name
const std::string & _name
The name of this object, reference to value stored in InputParameters.
Definition: MooseObject.h:178
MooseObject::_pars
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:169
moose::internal::mooseWarningStream
void mooseWarningStream(S &oss, Args &&... args)
Definition: MooseError.h:136
InputParameters::getDefaultPostprocessorValue
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name, bool suppress_error=false, unsigned int index=0) const
Get the default value for a postprocessor added with addPostprocessor.
Definition: InputParameters.C:629
RestartableData
Concrete definition of a parameter value for a specified type.
Definition: RestartableData.h:76
MooseVariableScalar::slnOld
VariableValue & slnOld()
Definition: MooseVariableScalar.h:54
BicubicSplineInterpolation::sample2ndDerivative
Real sample2ndDerivative(Real x1, Real x2, unsigned int deriv_var, Real yp1=_deriv_bound, Real ypn=_deriv_bound)
Samples second derivative at point (x1, x2)
Definition: BicubicSplineInterpolation.C:202
InputParameters::addRequiredParam
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...
Definition: InputParameters.h:1176
MooseObject::_app
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:172
Restartable::_restartable_system_name
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:214
ExecFlagType
MooseEnumItem ExecFlagType
Definition: Moose.h:99
FEProblemBase::hasPostprocessor
bool hasPostprocessor(const std::string &name)
Check existence of the postprocessor.
Definition: FEProblemBase.C:3216
MooseObject::mooseWarning
void mooseWarning(Args &&... args) const
Definition: MooseObject.h:150
MooseObject::paramErrorMsg
std::string paramErrorMsg(const std::string &param, Args... args) const
Definition: MooseObject.h:185
MooseUtils::getDefaultExecFlagEnum
ExecFlagEnum getDefaultExecFlagEnum()
Return the default ExecFlagEnum for MOOSE.
Definition: MooseUtils.C:685
SetupInterface::_execute_enum
const ExecFlagEnum & _execute_enum
Execute settings for this oejct.
Definition: SetupInterface.h:93
MooseObject::name
virtual const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:70
RestartableData::get
T & get()
Definition: RestartableData.h:92
Restartable::registerRestartableNameWithFilterOnApp
void registerRestartableNameWithFilterOnApp(const std::string &name, Moose::RESTARTABLE_FILTER filter)
Helper function for actually registering the restartable data.
Definition: Restartable.C:56
ScalarCoupleable::addScalarVariableCoupleableMatrixTag
void addScalarVariableCoupleableMatrixTag(TagID tag)
Definition: ScalarCoupleable.h:55
MooseVariableBase::number
unsigned int number() const
Get variable number coming from libMesh.
Definition: MooseVariableBase.h:48
n
PetscInt n
Definition: PetscDMMoose.C:1504