LinearCombinationPostprocessor Class Reference

Computes a linear combination between an arbitrary number of post-processors. More...

#include <LinearCombinationPostprocessor.h>

Inheritance diagram for LinearCombinationPostprocessor:

Public Member Functions
	LinearCombinationPostprocessor (const InputParameters &parameters)
virtual void	initialize () override
	Called before execute() is ever called so that data can be cleared. More...
virtual void	execute () override
	Execute method. More...
virtual PostprocessorValue	getValue () override
	This will get called to actually grab the final value the postprocessor has calculated. More...
virtual void	finalize () override
	This is called after execute() and after threadJoin()! This is probably where you want to do MPI communication! Finalize is not required for Postprocessor implementations since work may be done in getValue(). More...
const std::set< std::string > &	getRequestedItems () override
	Return a set containing the names of items requested by the object. More...
const std::set< std::string > &	getSuppliedItems () override
	Return a set containing the names of items owned by the object. More...
SubProblem &	getSubProblem () const
	Returns a reference to the subproblem that this postprocessor is tied to. More...
bool	shouldDuplicateInitialExecution () const
	Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC. More...
virtual Real	spatialValue (const Point &) const
	Optional interface function for "evaluating" a UserObject at a spatial position. More...
template<typename T >
void	gatherSum (T &value)
	Gather the parallel sum of the variable passed in. More...
template<typename T >
void	gatherMax (T &value)
template<typename T >
void	gatherMin (T &value)
template<typename T1 , typename T2 >
void	gatherProxyValueMax (T1 &value, T2 &proxy)
void	setPrimaryThreadCopy (UserObject *primary)
UserObject *	primaryThreadCopy ()
const std::string &	type () const
	Get the type of this object. More...
const std::string &	name () const
	Get the name of the object. More...
const InputParameters &	parameters () const
	Get the parameters of the object. More...
template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object. More...
template<typename T >
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...
MooseApp &	getMooseApp () 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)
	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)
	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)
	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...
const ExecFlagEnum &	getExecuteOnEnum () 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...
Function &	getFunction (const std::string &name)
	Get a function with a given name. More...
Function &	getFunctionByName (const FunctionName &name)
	Get a function 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)
template<typename T >
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)
	Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file. More...
template<typename T >
const MaterialProperty< T > &	getZeroMaterialProperty (const std::string &prop_name)
	Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material. More...
std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)
	Retrieve the block ids that the material property is defined. More...
std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)
	Retrieve the block names that the material property is defined. More...
std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)
	Retrieve the boundary ids that the material property is defined. More...
std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)
	Retrieve the boundary namess that the material property is defined. More...
void	checkBlockAndBoundaryCompatibility (std::shared_ptr< Material > discrete)
	Check if block and boundary restrictions of a given material are compatible with the current material. More...
template<>
Material &	getMaterialByName (const std::string &name, bool no_warn)
template<>
Material &	getMaterialByName (const std::string &name, bool no_warn)
void	statefulPropertiesAllowed (bool)
	Derived classes can declare whether or not they work with stateful material properties. More...
bool	getMaterialPropertyCalled () const
	Returns true if getMaterialProperty() has been called, false otherwise. More...
const std::set< unsigned int > &	getMatPropDependencies () const
	Retrieve the set of material properties that this object depends on. More...
template<>
const MaterialProperty< Real > *	defaultMaterialProperty (const std::string &name)
bool	isImplicit ()
template<class T >
const T &	getUserObject (const std::string &name)
	Get an user object with a given parameter name. More...
template<class T >
const T &	getUserObjectByName (const std::string &name)
	Get an user object with a given name. More...
const UserObject &	getUserObjectBase (const std::string &name)
	Get an user object with a given parameter name. More...
const UserObject &	getUserObjectBaseByName (const std::string &name)
	Get an user object with a given name. More...
std::string	PPName ()
	Returns the name of the Postprocessor. More...
void	buildOutputHideVariableList (std::set< std::string > variable_names)
	Builds hide lists for output objects NOT listed in the 'outputs' parameter. More...
const std::set< OutputName > &	getOutputs ()
	Get the list of output objects that this class is restricted. More...
virtual void	threadJoin (const UserObject &) override
	This method is not used and should not be used in a custom GeneralUserObject. More...
virtual void	subdomainSetup () override
	Gets called when the subdomain changes (i.e. More...
virtual const PostprocessorValue &	getPostprocessorValue (const std::string &name)
	Store dependency among same object types for proper execution order. More...
virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name)
virtual const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &name, const std::string &vector_name) override
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &name, const std::string &vector_name, bool use_broadcast) override
	Retrieve the value of a VectorPostprocessor. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) override
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool use_broadcast) override
	Retrieve the value of the VectorPostprocessor. More...
const Distribution &	getDistribution (const std::string &name) const
	Get a distribution with a given name. More...
template<typename T >
const T &	getDistribution (const std::string &name) const
const Distribution &	getDistributionByName (const DistributionName &name) const
	Get a distribution with a given name. More...
template<typename T >
const T &	getDistributionByName (const std::string &name) const
template<typename T >
const MaterialProperty< T > &	getMaterialProperty (const std::string &name)
	Retrieve reference to material property or one of it's old or older values. More...
template<typename T >
const ADMaterialPropertyObject< T > &	getADMaterialProperty (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name)
	Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file. More...
template<typename T >
const ADMaterialPropertyObject< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)
template<typename T >
const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)
Material &	getMaterial (const std::string &name)
	Return a Material reference - usable for computing directly. More...
template<ComputeStage >
Material &	getMaterial (const std::string &name)
Material &	getMaterialByName (const std::string &name, bool no_warn=false)
template<ComputeStage >
Material &	getMaterialByName (const std::string &name, bool no_warn=false)
template<typename T >
bool	hasMaterialProperty (const std::string &name)
	Check if the material property exists. More...
template<typename T >
bool	hasMaterialPropertyByName (const std::string &name)

Static Public Member Functions
static ExecFlagEnum	getExecuteOptions ()
	(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...
template<typename T >
static void	sort (typename std::vector< T > &vector)
	Given a vector, sort using the getRequested/SuppliedItems sets. More...
template<typename T >
static void	cyclicDependencyError (CyclicDependencyException< T > &e, const std::string &header)
	A helper method for cyclic errors. 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 &	declareRestartableData (std::string data_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithContext (std::string data_name, void *context)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithContext (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 &	declareRecoverableData (std::string data_name)
	Declare a piece of data as "recoverable". More...
template<typename T >
T &	declareRecoverableData (std::string data_name, const T &init_value)
	Declare a piece of data as "restartable" and initialize it. More...
template<typename T >
T &	declareRestartableDataWithObjectName (std::string data_name, std::string object_name)
	Declare a piece of data as "restartable". More...
template<typename T >
T &	declareRestartableDataWithObjectNameWithContext (std::string data_name, 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 VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...
virtual VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...
virtual VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0)
	Returns value of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0)
	Returns the old (previous time step) value of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0)
	Returns the older (two time steps previous) value of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0)
	Returns the time derivative of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0)
	Returns the second time derivative of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0)
	Returns the old time derivative of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0)
	Returns the old second time derivative of a scalar coupled variable. More...
virtual VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0)
	Time derivative of a scalar coupled variable with respect to the coefficients. More...
virtual VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0)
	Second time derivative of a scalar coupled variable with respect to the coefficients. More...
VariableValue *	getDefaultValue (const std::string &var_name)
	Helper method to return (and insert if necessary) the 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...
MooseVariableScalar *	getScalarVar (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...
PerfID	registerTimedSection (const std::string &section_name, const unsigned int level)
	Call to register a named section for timing. More...
void	checkMaterialProperty (const std::string &name)
	A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method. More...
void	markMatPropRequested (const std::string &)
	A proxy method for _mi_feproblem.markMatPropRequested(name) More...
std::string	deducePropertyName (const std::string &name)
	Small helper to look up a material property name through the input parameter keys. More...
template<typename T >
const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...
template<typename T >
const ADMaterialPropertyObject< T > *	defaultADMaterialProperty (const std::string &name)
	Helper function to parse default material property values. More...
template<>
const ADMaterialPropertyObject< Real > *	defaultADMaterialProperty (const std::string &name)
template<>
const ADMaterialPropertyObject< RealVectorValue > *	defaultADMaterialProperty (const std::string &name)
bool	hasPostprocessor (const std::string &name) const
	Determine if the Postprocessor exists. More...
bool	hasPostprocessorByName (const PostprocessorName &name)
	Determine if the Postprocessor exists. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name)
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name, bool needs_broadcast)
	Retrieve the old value of a VectorPostprocessor. More...
const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name)
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...
virtual const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast)
	Retrieve the old value of a VectorPostprocessor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &name, const std::string &vector_name)
	Return the scatter value for the post processor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const std::string &name, const std::string &vector_name)
	Return the scatter value for the post processor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &name, const std::string &vector_name)
	Return the old scatter value for the post processor. More...
virtual const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const std::string &name, const std::string &vector_name)
	Return the old scatter value for the post processor. More...
bool	hasVectorPostprocessor (const std::string &name) const
	Determine if the VectorPostprocessor exists. More...
bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
	Determine if the VectorPostprocessor exists. More...
const PostprocessorValue &	getPostprocessorValueOld (const std::string &name)
const PostprocessorValue &	getPostprocessorValueOlder (const std::string &name)
const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name)
const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name)
const PostprocessorValue &	getDefaultPostprocessorValue (const std::string &name)
	Return the default postprocessor value. More...

Protected Attributes
const std::vector< PostprocessorName > &	_pp_names
	List of names of post-processors to include in linear combination. More...
const unsigned int	_n_pp
	Number of post-processors in linear combination. More...
const std::vector< Real > &	_pp_coefs
	List of linear combination coefficients for each post-processor value. More...
const Real	_b_value
	Additional value to add to sum. More...
std::vector< const PostprocessorValue * >	_pp_values
	List of post-processor values. More...
std::set< std::string >	_depend_vars
std::set< std::string >	_supplied_vars
SubProblem &	_subproblem
	Reference to the Subproblem for this user object. More...
FEProblemBase &	_fe_problem
	Reference to the FEProblemBase for this user object. More...
THREAD_ID	_tid
	Thread ID of this postprocessor. More...
Assembly &	_assembly
const Moose::CoordinateSystemType &	_coord_sys
	Coordinate system. More...
const bool	_duplicate_initial_execution
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...
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::map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars
	Coupled vars whose values we provide. More...
std::map< std::string, VariableValue * >	_default_value
	Will hold the default 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...
const InputParameters *	_pg_params
	Params. More...
PerfGraph &	_perf_graph
	The performance graph to add to. More...
std::string	_prefix
	A prefix to use for all sections. More...
const InputParameters &	_mi_params
	Parameters of the object with this interface. More...
const std::string	_mi_name
	The name of the object that this interface belongs to. More...
Moose::MaterialDataType	_material_data_type
	The type of data. More...
std::shared_ptr< MaterialData >	_material_data
	Pointer to the material data class that stores properties. More...
FEProblemBase &	_mi_feproblem
	Reference to the FEProblemBase class. More...
const THREAD_ID	_mi_tid
	Current threaded it. More...
bool	_stateful_allowed
	True by default. More...
bool	_get_material_property_called
	Initialized to false. More...
std::vector< std::unique_ptr< MaterialProperty< Real > > >	_default_real_properties
	Storage vector for MaterialProperty<Real> default objects. More...
std::vector< std::unique_ptr< ADMaterialPropertyObject< Real > > >	_default_ad_real_properties
	Storage vector for ADMaterialPropertyObject<Real> default objects. More...
std::vector< std::unique_ptr< ADMaterialPropertyObject< RealVectorValue > > >	_default_ad_real_vector_properties
	Storage vector for ADMaterialPropertyObject<RealVectorValue> default objects. More...
std::set< unsigned int >	_material_property_dependencies
	The set of material properties (as given by their IDs) that this object depends on. 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
std::string	_pp_name

Detailed Description

Computes a linear combination between an arbitrary number of post-processors.

This computes a linear combination of post-processors \(x_i\):

\[ y = \sum\limits_i c_i x_i + b \,, \]

where \(c_i\) is the combination coefficient for \(x_i\) and \(b\) is an additional value to add to the sum.

Definition at line 30 of file LinearCombinationPostprocessor.h.

Constructor & Destructor Documentation

LinearCombinationPostprocessor()

LinearCombinationPostprocessor::LinearCombinationPostprocessor

(

const InputParameters &

parameters

)

Definition at line 28 of file LinearCombinationPostprocessor.C.

  : GeneralPostprocessor(parameters),
    _pp_names(getParam<std::vector<PostprocessorName>>("pp_names")),
    _n_pp(_pp_names.size()),
    _pp_coefs(getParam<std::vector<Real>>("pp_coefs")),
    _b_value(getParam<Real>("b"))
{
  if (_pp_coefs.size() != _n_pp)
    mooseError("The list parameters 'pp_names' and 'pp_coefs' must have the same length");

  _pp_values.resize(_n_pp);
  for (unsigned int i = 0; i < _n_pp; i++)
    _pp_values[i] = &getPostprocessorValueByName(_pp_names[i]);
}

Member Function Documentation

addScalarVariableCoupleableMatrixTag()

void ScalarCoupleable::addScalarVariableCoupleableMatrixTag ( TagID  tag )

inlineinherited

Definition at line 59 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledMatrixTagScalarValue().

{ _sc_coupleable_matrix_tags.insert(tag); }

addScalarVariableCoupleableVectorTag()

void ScalarCoupleable::addScalarVariableCoupleableVectorTag ( TagID  tag )

inlineinherited

Definition at line 57 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledVectorTagScalarValue().

{ _sc_coupleable_vector_tags.insert(tag); }

buildOutputHideVariableList()

void OutputInterface::buildOutputHideVariableList ( std::set< std::string >  variable_names )

inherited

Builds hide lists for output objects NOT listed in the 'outputs' parameter.

Parameters

variable_names

A set of variables for which the 'outputs' parameter controls

By default this is called by the constructor and passes the block name as the list of variables. This needs to be called explicitly if the build_list flag is set to False in the constructor. The latter cases is needed by the Material object to work correctly with the automatic material output capability.

Definition at line 62 of file OutputInterface.C.

Referenced by CheckOutputAction::checkVariableOutput(), and OutputInterface::OutputInterface().

{
  // Set of available names
  const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();

  // Check for 'none'; hide variables on all outputs
  if (_oi_outputs.find("none") != _oi_outputs.end())
    for (const auto & name : avail)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);

  // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
  // these cases
  else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
    return;

  // Limit the variable output to Output objects listed
  else
  {
    // Create a list of outputs where the variable should be hidden
    std::set<OutputName> hide;
    std::set_difference(avail.begin(),
                        avail.end(),
                        _oi_outputs.begin(),
                        _oi_outputs.end(),
                        std::inserter(hide, hide.begin()));

    // If 'outputs' is specified add the object name to the list of items to hide
    for (const auto & name : hide)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
  }
}

checkBlockAndBoundaryCompatibility()

void MaterialPropertyInterface::checkBlockAndBoundaryCompatibility ( std::shared_ptr< Material >  discrete )

inherited

Check if block and boundary restrictions of a given material are compatible with the current material.

Error out otherwise.

Definition at line 205 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterialByName().

{
  // Check block compatibility
  if (!discrete->hasBlocks(_mi_block_ids))
  {
    std::ostringstream oss;
    oss << "The Material object '" << discrete->name()
        << "' is defined on blocks that are incompatible with the retrieving object '" << _mi_name
        << "':\n";
    oss << "  " << discrete->name();
    for (const auto & sbd_id : discrete->blockIDs())
      oss << " " << sbd_id;
    oss << "\n";
    oss << "  " << _mi_name;
    for (const auto & block_id : _mi_block_ids)
      oss << " " << block_id;
    oss << "\n";
    mooseError(oss.str());
  }

  // Check boundary compatibility
  if (!discrete->hasBoundary(_mi_boundary_ids))
  {
    std::ostringstream oss;
    oss << "The Material object '" << discrete->name()
        << "' is defined on boundaries that are incompatible with the retrieving object '"
        << _mi_name << "':\n";
    oss << "  " << discrete->name();
    for (const auto & bnd_id : discrete->boundaryIDs())
      oss << " " << bnd_id;
    oss << "\n";
    oss << "  " << _mi_name;
    for (const auto & bnd_id : _mi_boundary_ids)
      oss << " " << bnd_id;
    oss << "\n";
    mooseError(oss.str());
  }
}

checkMaterialProperty()

void MaterialPropertyInterface::checkMaterialProperty ( const std::string &  name )

protectedinherited

A helper method for checking material properties This method was required to avoid a compiler problem with the template getMaterialProperty method.

Definition at line 173 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByName(), and MaterialPropertyInterface::getMaterialPropertyByName().

{
  // If the material property is boundary restrictable, add to the list of materials to check
  if (_mi_boundary_restricted)
    for (const auto & bnd_id : _mi_boundary_ids)
      _mi_feproblem.storeBoundaryDelayedCheckMatProp(_mi_name, bnd_id, name);

  // The default is to assume block restrictions
  else
    for (const auto & blk_ids : _mi_block_ids)
      _mi_feproblem.storeSubdomainDelayedCheckMatProp(_mi_name, blk_ids, name);
}

checkVar()

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

protectedinherited

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

Parameters

var_name

The name of the coupled variable

Definition at line 257 of file ScalarCoupleable.C.

Referenced by 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().

{
  auto it = _sc_coupled_vars.find(var_name);
  if (it != _sc_coupled_vars.end())
  {
    std::string cvars;
    for (auto jt : it->second)
      cvars += " " + jt->name();
    mooseError(_sc_name,
               ": Trying to couple a field variable where scalar variable is expected, '",
               var_name,
               " =",
               cvars,
               "'");
  }
  // NOTE: non-existent variables are handled in the constructor
}

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_name	Name of coupled variable
tag	Tag ID of coupled matrix;
comp	Component number for vector of coupled variables

Returns

Reference to a VariableValue for the coupled variable

Definition at line 162 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return *getDefaultValue(var_name);

  addScalarVariableCoupleableMatrixTag(tag);

  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->matrixTagSln(tag);
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Index of coupled variable

Definition at line 105 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

{
  checkVar(var_name);
  return getScalarVar(var_name, comp)->number();
}

coupledScalarComponents()

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

protectedvirtualinherited

Return the number of components to the coupled scalar variable.

Parameters

var_name

The of the coupled variable

Definition at line 304 of file ScalarCoupleable.C.

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

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a time derivative VariableValue for the coupled variable

Definition at line 204 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDot");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->uDot();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a time derivative VariableValue for the coupled variable

Definition at line 213 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDotDot");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->uDotDot();
}

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_name	Name of coupled variable
comp	Component 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 248 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDotDotDu");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->duDotDotDu();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a time derivative VariableValue for the coupled variable

Definition at line 231 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDotDotOld");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->uDotDotOld();
}

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_name	Name of coupled variable
comp	Component 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 239 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDotDu");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->duDotDu();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a time derivative VariableValue for the coupled variable

Definition at line 222 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  validateExecutionerType(var_name, "coupledScalarDotOld");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->uDotOld();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Order of coupled variable

Definition at line 112 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return _sc_fe_problem.getMaxScalarOrder();

  return getScalarVar(var_name, comp)->order();
}

coupledScalarValue()

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

protectedvirtualinherited

Returns value of a scalar coupled variable.

Parameters

var_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a VariableValue for the coupled variable

Definition at line 136 of file ScalarCoupleable.C.

Referenced by ParsedODEKernel::ParsedODEKernel().

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return *getDefaultValue(var_name);

  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return (_sc_is_implicit) ? var->sln() : var->slnOld();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a old VariableValue for the coupled variable

Definition at line 177 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return *getDefaultValue(var_name);

  validateExecutionerType(var_name, "coupledScalarValueOld");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return (_sc_is_implicit) ? var->slnOld() : var->slnOlder();
}

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_name	Name of coupled variable
comp	Component number for vector of coupled variables

Returns

Reference to a older VariableValue for the coupled variable

Definition at line 189 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return *getDefaultValue(var_name);

  validateExecutionerType(var_name, "coupledScalarValueOlder");
  MooseVariableScalar * var = getScalarVar(var_name, comp);
  if (_sc_is_implicit)
    return var->slnOlder();
  else
    mooseError("Older values not available for explicit schemes");
}

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_name	Name of coupled variable
tag	Tag ID of coupled vector ;
comp	Component number for vector of coupled variables

Returns

Reference to a VariableValue for the coupled variable

Definition at line 147 of file ScalarCoupleable.C.

{
  checkVar(var_name);
  if (!isCoupledScalar(var_name, comp))
    return *getDefaultValue(var_name);

  addScalarVariableCoupleableVectorTag(tag);

  MooseVariableScalar * var = getScalarVar(var_name, comp);
  return var->vectorTagSln(tag);
}

cyclicDependencyError()

template<typename T >

void DependencyResolverInterface::cyclicDependencyError ( CyclicDependencyException< T > &  e, const std::string &  header  )

staticinherited

A helper method for cyclic errors.

Definition at line 95 of file DependencyResolverInterface.h.

{
  std::ostringstream oss;

  oss << header << ":\n";
  const typename std::multimap<T, T> & depends = e.getCyclicDependencies();
  for (typename std::multimap<T, T>::const_iterator it = depends.begin(); it != depends.end(); ++it)
    oss << (static_cast<T>(it->first))->name() << " -> " << (static_cast<T>(it->second))->name()
        << "\n";
  mooseError(oss.str());
}

declareRecoverableData() [1/2]

template<typename T >

T & Restartable::declareRecoverableData ( 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_name

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

Definition at line 269 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;

  registerRecoverableDataOnApp(full_name);

  return declareRestartableDataWithContext<T>(data_name, nullptr);
}

declareRecoverableData() [2/2]

template<typename T >

T & Restartable::declareRecoverableData ( 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_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 280 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;

  registerRecoverableDataOnApp(full_name);

  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
}

declareRestartableData() [1/2]

template<typename T >

T & Restartable::declareRestartableData ( 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_name

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

Definition at line 202 of file Restartable.h.

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

declareRestartableData() [2/2]

template<typename T >

T & Restartable::declareRestartableData ( 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_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data

Definition at line 209 of file Restartable.h.

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

declareRestartableDataWithContext() [1/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext ( 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_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions

Definition at line 216 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  T & restartable_data_ref = data_ptr->get();

  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);

  return restartable_data_ref;
}

declareRestartableDataWithContext() [2/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext ( 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_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 229 of file Restartable.h.

{
  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  data_ptr->set() = init_value;

  T & restartable_data_ref = data_ptr->get();
  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);

  return restartable_data_ref;
}

declareRestartableDataWithObjectName()

template<typename T >

T & Restartable::declareRestartableDataWithObjectName ( std::string  data_name, 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_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.

Definition at line 245 of file Restartable.h.

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

declareRestartableDataWithObjectNameWithContext()

template<typename T >

T & Restartable::declareRestartableDataWithObjectNameWithContext ( std::string  data_name, 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_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
context	Context pointer that will be passed to the load and store functions

Definition at line 252 of file Restartable.h.

{
  std::string old_name = _restartable_name;

  _restartable_name = object_name;

  T & value = declareRestartableDataWithContext<T>(data_name, context);

  _restartable_name = old_name;

  return value;
}

deducePropertyName()

std::string MaterialPropertyInterface::deducePropertyName ( const std::string &  name )

protectedinherited

Small helper to look up a material property name through the input parameter keys.

Definition at line 55 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getADMaterialProperty(), Material::getADMaterialProperty(), MaterialPropertyInterface::getMaterialProperty(), Material::getMaterialProperty(), MaterialPropertyInterface::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), MaterialPropertyInterface::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), TwoMaterialPropertyInterface::getNeighborMaterialProperty(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyOld(), TwoMaterialPropertyInterface::getNeighborMaterialPropertyOlder(), and MaterialPropertyInterface::hasMaterialProperty().

{
  if (_mi_params.have_parameter<MaterialPropertyName>(name))
    return _mi_params.get<MaterialPropertyName>(name);
  else
    return name;
}

defaultADMaterialProperty() [1/3]

template<typename T >

const ADMaterialPropertyObject< T > * MaterialPropertyInterface::defaultADMaterialProperty ( const std::string &  name )

protectedinherited

Helper function to parse default material property values.

This is implemented as a specialization for supported types and returns NULL in all other cases.

Definition at line 394 of file MaterialPropertyInterface.h.

{
  return NULL;
}

defaultADMaterialProperty() [2/3]

const ADMaterialPropertyObject< Real > * MaterialPropertyInterface::defaultADMaterialProperty ( const std::string &  name )

protectedinherited

Definition at line 93 of file MaterialPropertyInterface.C.

{
  std::istringstream ss(name);
  Real real_value;

  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_ad_real_properties.emplace_back(libmesh_make_unique<ADMaterialPropertyObject<Real>>());
    auto & default_property = _default_ad_real_properties.back();

    // resize to accomodate maximum number obf qpoints
    auto nqp = _mi_feproblem.getMaxQps();
    default_property->resize(nqp);

    // set values for all qpoints to the given default
    for (decltype(nqp) qp = 0; qp < nqp; ++qp)
      (*default_property)[qp] = real_value;

    // return the raw pointer inside the shared pointer
    return default_property.get();
  }

  return nullptr;
}

defaultADMaterialProperty() [3/3]

const ADMaterialPropertyObject< RealVectorValue > * MaterialPropertyInterface::defaultADMaterialProperty ( const std::string &  name )

protectedinherited

Definition at line 121 of file MaterialPropertyInterface.C.

{
  std::istringstream ss(name);
  Real real_value;

  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_ad_real_vector_properties.emplace_back(
        libmesh_make_unique<ADMaterialPropertyObject<RealVectorValue>>());
    auto & default_property = _default_ad_real_vector_properties.back();

    // resize to accomodate maximum number obf qpoints
    auto nqp = _mi_feproblem.getMaxQps();
    default_property->resize(nqp);

    // set values for all qpoints to the given default
    for (decltype(nqp) qp = 0; qp < nqp; ++qp)
      (*default_property)[qp] = real_value;

    // return the raw pointer inside the shared pointer
    return default_property.get();
  }

  return nullptr;
}

defaultMaterialProperty() [1/2]

template<typename T >

const MaterialProperty< T > * MaterialPropertyInterface::defaultMaterialProperty ( const std::string &  name )

protectedinherited

Helper function to parse default material property values.

This is implemented as a specialization for supported types and returns NULL in all other cases.

Definition at line 386 of file MaterialPropertyInterface.h.

{
  return NULL;
}

defaultMaterialProperty() [2/2]

const MaterialProperty< Real > * MaterialPropertyInterface::defaultMaterialProperty ( const std::string &  name )

inherited

Definition at line 65 of file MaterialPropertyInterface.C.

{
  std::istringstream ss(name);
  Real real_value;

  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_real_properties.emplace_back(libmesh_make_unique<MaterialProperty<Real>>());
    auto & default_property = _default_real_properties.back();

    // resize to accomodate maximum number obf qpoints
    auto nqp = _mi_feproblem.getMaxQps();
    default_property->resize(nqp);

    // set values for all qpoints to the given default
    for (decltype(nqp) qp = 0; qp < nqp; ++qp)
      (*default_property)[qp] = real_value;

    // return the raw pointer inside the shared pointer
    return default_property.get();
  }

  return nullptr;
}

enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 96 of file MooseObject.h.

Referenced by EigenKernel::enabled().

{ return _enabled; }

execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const

inherited

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

Definition at line 85 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
                  "ExecFlagEnum for execute flags. This method maintains the behavior of the "
                  "original method but the use of this method should be removed from your "
                  "application. The ExecFlagEnum should be inspected directly via the "
                  "getExecuteOnEnum() method.");

  unsigned int exec_bit_field = EXEC_NONE;
  for (const auto & flag : _exec_flags)
    exec_bit_field |= flag.id();
  return ExecFlagType("deprecated", exec_bit_field);
}

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 73 of file SetupInterface.C.

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

  return _exec_flags;
}

execute()

void LinearCombinationPostprocessor::execute ( )

overridevirtual

Execute method.

Implements UserObject.

Definition at line 49 of file LinearCombinationPostprocessor.C.

{
}

finalize()

virtual void GeneralPostprocessor::finalize ( )

inlineoverridevirtualinherited

This is called after execute() and after threadJoin()! This is probably where you want to do MPI communication! Finalize is not required for Postprocessor implementations since work may be done in getValue().

Implements UserObject.

Reimplemented in MemoryUsage, and PointValue.

Definition at line 39 of file GeneralPostprocessor.h.

{}

gatherMax()

template<typename T >

void UserObject::gatherMax ( T &  value )

inlineinherited

Definition at line 110 of file UserObject.h.

Referenced by MemoryUsage::finalize(), NodalMaxValue::getValue(), NodalExtremeValue::getValue(), and ElementExtremeValue::getValue().

  {
    _communicator.max(value);
  }

gatherMin()

template<typename T >

void UserObject::gatherMin ( T &  value )

inlineinherited

Definition at line 116 of file UserObject.h.

Referenced by PointValue::execute(), MemoryUsage::finalize(), ScalarVariable::getValue(), NodalExtremeValue::getValue(), and ElementExtremeValue::getValue().

  {
    _communicator.min(value);
  }

gatherProxyValueMax()

template<typename T1 , typename T2 >

void UserObject::gatherProxyValueMax ( T1 &  value, T2 &  proxy  )

inlineinherited

Definition at line 122 of file UserObject.h.

Referenced by ElementVariablesDifferenceMax::finalize(), and NodalProxyMaxValue::getValue().

  {
    unsigned int rank;
    _communicator.maxloc(value, rank);
    _communicator.broadcast(proxy, rank);
  }

gatherSum()

template<typename T >

void UserObject::gatherSum ( T &  value )

inlineinherited

Gather the parallel sum of the variable passed in.

It takes care of values across all threads and CPUs (we DO hybrid parallelism!)

After calling this, the variable that was passed in will hold the gathered value.

Definition at line 104 of file UserObject.h.

Referenced by SphericalAverage::finalize(), LayeredAverage::finalize(), VolumeHistogram::finalize(), LayeredSideAverage::finalize(), MemoryUsage::finalize(), SideFluxAverage::getValue(), AverageNodalVariableValue::getValue(), NodalL2Error::getValue(), NodalSum::getValue(), AverageElementSize::getValue(), NodalL2Norm::getValue(), ElementAverageValue::getValue(), SideAverageValue::getValue(), SideIntegralPostprocessor::getValue(), ElementIntegralPostprocessor::getValue(), ElementalVariableValue::getValue(), NodalVariableValue::getValue(), SideIntegralUserObject::getValue(), and ElementIntegralUserObject::getValue().

  {
    _communicator.sum(value);
  }

getADMaterialProperty()

template<typename T >

const ADMaterialPropertyObject< T > & MaterialPropertyInterface::getADMaterialProperty ( const std::string &  name )

inherited

Definition at line 328 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = deducePropertyName(name);

  // Check if it's just a constant
  const ADMaterialPropertyObject<T> * default_property = defaultADMaterialProperty<T>(prop_name);
  if (default_property)
    return *default_property;

  return getADMaterialPropertyByName<T>(prop_name);
}

getADMaterialPropertyByName()

template<typename T >

const ADMaterialPropertyObject< T > & MaterialPropertyInterface::getADMaterialPropertyByName ( const MaterialPropertyName &  name )

inherited

Definition at line 432 of file MaterialPropertyInterface.h.

{
  _mi_feproblem.usingADMatProps(true);

  checkExecutionStage();
  checkMaterialProperty(name);

  // mark property as requested
  markMatPropRequested(name);

  // Update the boolean flag.
  _get_material_property_called = true;

  _material_property_dependencies.insert(_material_data->getPropertyId(name));

  return _material_data->getADProperty<T>(name);
}

getBlockMaterialProperty()

template<typename T >

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > MaterialPropertyInterface::getBlockMaterialProperty ( const MaterialPropertyName &  name )

inherited

Retrieve pointer to a material property with the mesh blocks where it is defined The name required by this method is the name defined in the input file.

This function can be thought as the combination of getMaterialPropertyByName and getMaterialPropertyBlocks. It can be called after the action of all actions.

Parameters

name	The name of the material property to retrieve

Returns

Pointer to the material property with the name 'name' and the set of blocks where the property is valid

Definition at line 488 of file MaterialPropertyInterface.h.

{
  if (_mi_block_ids.empty())
    mooseError("getBlockMaterialProperty must be called by a block restrictable object");

  if (!hasMaterialPropertyByName<T>(name))
    return std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>(NULL,
                                                                         std::set<SubdomainID>());

  _material_property_dependencies.insert(_material_data->getPropertyId(name));

  return std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>(
      &_material_data->getProperty<T>(name), _mi_feproblem.getMaterialPropertyBlocks(name));
}

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 77 of file MooseObject.h.

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

getCoupledMooseScalarVars()

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

inherited

Get the list of coupled scalar variables.

Returns

The list of coupled variables

Definition at line 77 of file ScalarCoupleable.C.

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

{
  return _coupled_moose_scalar_vars;
}

getDefaultPostprocessorValue()

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

inherited

Return the default postprocessor value.

Parameters

name	The name of the postprocessor parameter

Returns

A const reference to the default value

Definition at line 86 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

{
  return _ppi_params.getDefaultPostprocessorValue(name);
}

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_name

the name of the variable for which to retrieve a default value

Returns

VariableValue * a pointer to the associated VarirableValue.

Definition at line 122 of file ScalarCoupleable.C.

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

{
  std::map<std::string, VariableValue *>::iterator default_value_it = _default_value.find(var_name);
  if (default_value_it == _default_value.end())
  {
    VariableValue * value = new VariableValue(_sc_fe_problem.getMaxScalarOrder(),
                                              _coupleable_params.defaultCoupledValue(var_name));
    default_value_it = _default_value.insert(std::make_pair(var_name, value)).first;
  }

  return default_value_it->second;
}

getDistribution() [1/2]

const Distribution & DistributionInterface::getDistribution ( const std::string &  name ) const

inherited

Get a distribution with a given name.

Parameters

name	The name of the parameter key of the distribution to retrieve

Returns

The distribution with name associated with the parameter 'name'

Definition at line 30 of file DistributionInterface.C.

Referenced by DistributionInterface::getDistribution(), and DistributionInterface::getDistributionByName().

{
  DistributionName dist_name = _dni_params.get<DistributionName>(name);
  return _dni_feproblem.getDistribution(dist_name);
}

getDistribution() [2/2]

template<typename T >

const T & DistributionInterface::getDistribution ( const std::string &  name ) const

inherited

Definition at line 78 of file DistributionInterface.h.

{
  try
  {
    const T & dist = dynamic_cast<const T &>(getDistribution(name));
    return dist;
  }
  catch (std::bad_cast & exception)
  {
    DistributionName dist_name = _dni_params.get<DistributionName>(name);
    mooseError("The '",
               _dni_moose_object_ptr->name(),
               "' object failed to retrieve '",
               dist_name,
               "' distribution with the desired type.");
  }
}

getDistributionByName() [1/2]

const Distribution & DistributionInterface::getDistributionByName ( const DistributionName &  name ) const

inherited

Get a distribution with a given name.

Parameters

name	The name of the distribution to retrieve

Returns

The distribution with name 'name'

Definition at line 37 of file DistributionInterface.C.

Referenced by RandomIC::RandomIC(), and Sampler::Sampler().

{
  return _dni_feproblem.getDistribution(name);
}

getDistributionByName() [2/2]

template<typename T >

const T & DistributionInterface::getDistributionByName ( const std::string &  name ) const

inherited

Definition at line 98 of file DistributionInterface.h.

{
  try
  {
    const T & dist = dynamic_cast<const T &>(getDistribution(name));
    return dist;
  }
  catch (std::bad_cast & exception)
  {
    mooseError("The '",
               _dni_moose_object_ptr->name(),
               "' object failed to retrieve '",
               name,
               "' distribution with the desired type.");
  }
}

getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 67 of file SetupInterface.C.

Referenced by ExecuteMooseObjectWarehouse< Transfer >::addObjectMask(), EigenExecutionerBase::init(), AttribExecOns::initFrom(), and MultiAppTransfer::MultiAppTransfer().

{
  return _execute_enum;
}

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 101 of file SetupInterface.C.

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

getFunction()

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

inherited

Get a function with a given name.

Parameters

name	The name of the parameter key of the function to retrieve

Returns

The function with name associated with the parameter 'name'

Definition at line 30 of file FunctionInterface.C.

Referenced by FunctionDT::FunctionDT().

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

getFunctionByName()

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

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns

The function with name 'name'

Definition at line 36 of file FunctionInterface.C.

Referenced by CompositeFunction::CompositeFunction(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterial::GenericFunctionMaterial(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

{
  return _fni_feproblem.getFunction(name, _fni_tid);
}

getMaterial() [1/2]

template Material & MaterialPropertyInterface::getMaterial< JACOBIAN > ( const std::string &  name )

inherited

Return a Material reference - usable for computing directly.

Parameters

name	The name of the input parameter or explicit material name.
no_warn	If true, suppress warning about retrieving the material potentially during its calculation. If you don't know what this is/means, then you don't need it.

Definition at line 199 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterialByName().

{
  return getMaterialByName(_mi_params.get<MaterialName>(name));
}

getMaterial() [2/2]

template<ComputeStage compute_stage>

Material & MaterialPropertyInterface::getMaterial ( const std::string &  name )

inherited

Definition at line 255 of file MaterialPropertyInterface.C.

{
  return getMaterialByName<compute_stage>(_mi_params.get<MaterialName>(name));
}

getMaterialByName() [1/4]

Material & MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn = false  )

inherited

Definition at line 245 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getMaterial(), and MaterialVectorPostprocessor::MaterialVectorPostprocessor().

{
  std::shared_ptr<Material> discrete =
      _mi_feproblem.getMaterial(name, _material_data_type, _mi_tid, no_warn);
  checkBlockAndBoundaryCompatibility(discrete);
  return *discrete;
}

getMaterialByName() [2/4]

template<ComputeStage >

Material& MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn = false  )

inherited

getMaterialByName() [3/4]

template<>

Material& MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn  )

inherited

Definition at line 262 of file MaterialPropertyInterface.C.

{
  return getMaterialByName(name, no_warn);
}

getMaterialByName() [4/4]

template<>

Material& MaterialPropertyInterface::getMaterialByName ( const std::string &  name, bool  no_warn  )

inherited

Definition at line 269 of file MaterialPropertyInterface.C.

{
  std::shared_ptr<Material> discrete =
      _mi_feproblem.getMaterial(name + "_jacobian", _material_data_type, _mi_tid, no_warn);
  checkBlockAndBoundaryCompatibility(discrete);
  return *discrete;
}

getMaterialProperty()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialProperty ( const std::string &  name )

inherited

Retrieve reference to material property or one of it's old or older values.

The name required by this method is the name that is hard-coded into your source code as the input parameter key. If no input parameter is found this behaves like the getMaterialPropertyByName family as a fall back.

Parameters

name	The name of the parameter key of the material property to retrieve

Returns

Reference to the desired material property

Definition at line 313 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = deducePropertyName(name);

  // Check if it's just a constant
  const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
  if (default_property)
    return *default_property;

  return getMaterialPropertyByName<T>(prop_name);
}

getMaterialPropertyBlockNames()

std::vector< SubdomainName > MaterialPropertyInterface::getMaterialPropertyBlockNames ( const std::string &  name )

inherited

Retrieve the block names that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block names for the property

Definition at line 155 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBlockNames(name);
}

getMaterialPropertyBlocks()

std::set< SubdomainID > MaterialPropertyInterface::getMaterialPropertyBlocks ( const std::string &  name )

inherited

Retrieve the block ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the block ids for the property

Definition at line 149 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBlocks(name);
}

getMaterialPropertyBoundaryIDs()

std::set< BoundaryID > MaterialPropertyInterface::getMaterialPropertyBoundaryIDs ( const std::string &  name )

inherited

Retrieve the boundary ids that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary ids for the property

Definition at line 161 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryIDs(name);
}

getMaterialPropertyBoundaryNames()

std::vector< BoundaryName > MaterialPropertyInterface::getMaterialPropertyBoundaryNames ( const std::string &  name )

inherited

Retrieve the boundary namess that the material property is defined.

Parameters

name	The name of the material property

Returns

A vector the the boundary names for the property

Definition at line 167 of file MaterialPropertyInterface.C.

{
  return _mi_feproblem.getMaterialPropertyBoundaryNames(name);
}

getMaterialPropertyByName()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialPropertyByName ( const MaterialPropertyName &  name )

inherited

Retrieve reference to material property or its old or older value The name required by this method is the name defined in the input file.

Parameters

name	The name of the material property to retrieve

Returns

Reference to the material property with the name 'name'

Definition at line 414 of file MaterialPropertyInterface.h.

{
  checkExecutionStage();
  checkMaterialProperty(name);

  // mark property as requested
  markMatPropRequested(name);

  // Update the boolean flag.
  _get_material_property_called = true;

  _material_property_dependencies.insert(_material_data->getPropertyId(name));

  return _material_data->getProperty<T>(name);
}

getMaterialPropertyCalled()

bool MaterialPropertyInterface::getMaterialPropertyCalled ( ) const

inlineinherited

Returns true if getMaterialProperty() has been called, false otherwise.

Definition at line 187 of file MaterialPropertyInterface.h.

{ return _get_material_property_called; }

getMaterialPropertyOld()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialPropertyOld ( const std::string &  name )

inherited

Definition at line 343 of file MaterialPropertyInterface.h.

{
  if (!_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " Old property for \"",
               name,
               "\" was requested.");

  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = deducePropertyName(name);

  // Check if it's just a constant
  const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
  if (default_property)
    return *default_property;

  return getMaterialPropertyOldByName<T>(prop_name);
}

getMaterialPropertyOldByName()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialPropertyOldByName ( const MaterialPropertyName &  name )

inherited

Definition at line 452 of file MaterialPropertyInterface.h.

{
  if (!_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " Old property for \"",
               name,
               "\" was requested.");

  // mark property as requested
  markMatPropRequested(name);

  _material_property_dependencies.insert(_material_data->getPropertyId(name));

  return _material_data->getPropertyOld<T>(name);
}

getMaterialPropertyOlder()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialPropertyOlder ( const std::string &  name )

inherited

Definition at line 364 of file MaterialPropertyInterface.h.

{
  if (!_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " Older property for \"",
               name,
               "\" was requested.");

  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = deducePropertyName(name);

  // Check if it's just a constant
  const MaterialProperty<T> * default_property = defaultMaterialProperty<T>(prop_name);
  if (default_property)
    return *default_property;

  return getMaterialPropertyOlderByName<T>(prop_name);
}

getMaterialPropertyOlderByName()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getMaterialPropertyOlderByName ( const MaterialPropertyName &  name )

inherited

Definition at line 470 of file MaterialPropertyInterface.h.

{
  if (!_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " Older property for \"",
               name,
               "\" was requested.");

  // mark property as requested
  markMatPropRequested(name);

  _material_property_dependencies.insert(_material_data->getPropertyId(name));

  return _material_data->getPropertyOlder<T>(name);
}

getMatPropDependencies()

const std::set<unsigned int>& MaterialPropertyInterface::getMatPropDependencies ( ) const

inlineinherited

Retrieve the set of material properties that this object depends on.

Returns

The IDs corresponding to the material properties that MUST be reinited before evaluating this object

Definition at line 195 of file MaterialPropertyInterface.h.

Referenced by NodalPatchRecovery::reinitPatch().

  {
    return _material_property_dependencies;
  }

getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 91 of file MooseObject.h.

Referenced by RestartableDataIO::createBackup(), RestartableDataIO::deserializeRestartableData(), ConsoleUtils::outputMeshInformation(), Resurrector::restartRestartableData(), and RestartableDataIO::restoreBackup().

{ return _app; }

getOutputs()

const std::set< OutputName > & OutputInterface::getOutputs ( )

inherited

Get the list of output objects that this class is restricted.

Returns

A set of OutputNames

Definition at line 95 of file OutputInterface.C.

{
  return _oi_outputs;
}

getParam()

template<typename T >

const T & MooseObject::getParam ( const std::string &  name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns

The value of the parameter

Definition at line 188 of file MooseObject.h.

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromXandY(), MultiApp::createApp(), DerivativeParsedMaterial::DerivativeParsedMaterial(), EigenKernel::EigenKernel(), FEProblemBase::FEProblemBase(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), SideSetsBetweenSubdomainsGenerator::generate(), ExtraNodesetGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsAroundSubdomainGenerator::generate(), GenericConstantRankTwoTensor::GenericConstantRankTwoTensor(), TimeSequenceStepper::init(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), AdvancedOutput::initialSetup(), SideSetsBetweenSubdomains::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), SideSetsAroundSubdomain::modify(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterial::ParsedMaterial(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), and VectorOfPostprocessors::VectorOfPostprocessors().

{
  return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
}

getPostprocessorValue()

const PostprocessorValue & GeneralUserObject::getPostprocessorValue ( const std::string &  name )

virtualinherited

Store dependency among same object types for proper execution order.

Definition at line 49 of file GeneralUserObject.C.

{
  _depend_vars.insert(_pars.get<PostprocessorName>(name));
  return PostprocessorInterface::getPostprocessorValue(name);
}

getPostprocessorValueByName()

const PostprocessorValue & GeneralUserObject::getPostprocessorValueByName ( const PostprocessorName &  name )

virtualinherited

Definition at line 56 of file GeneralUserObject.C.

Referenced by LinearCombinationPostprocessor(), Terminator::Terminator(), and VectorOfPostprocessors::VectorOfPostprocessors().

{
  _depend_vars.insert(name);
  return PostprocessorInterface::getPostprocessorValueByName(name);
}

getPostprocessorValueOld()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOld ( const std::string &  name )

inherited

Definition at line 34 of file PostprocessorInterface.C.

{
  // Return the default if the Postprocessor does not exist and a default does, otherwise
  // continue as usual
  if (!hasPostprocessor(name) && _ppi_params.hasDefaultPostprocessorValue(name))
    return _ppi_params.getDefaultPostprocessorValue(name);
  else
    return _pi_feproblem.getPostprocessorValueOld(_ppi_params.get<PostprocessorName>(name));
}

getPostprocessorValueOldByName()

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

inherited

Definition at line 62 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

{
  return _pi_feproblem.getPostprocessorValueOld(name);
}

getPostprocessorValueOlder()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlder ( const std::string &  name )

inherited

Definition at line 45 of file PostprocessorInterface.C.

{
  // Return the default if the Postprocessor does not exist and a default does, otherwise
  // continue as usual
  if (!hasPostprocessor(name) && _ppi_params.hasDefaultPostprocessorValue(name))
    return _ppi_params.getDefaultPostprocessorValue(name);
  else
    return _pi_feproblem.getPostprocessorValueOlder(_ppi_params.get<PostprocessorName>(name));
}

getPostprocessorValueOlderByName()

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

inherited

Definition at line 68 of file PostprocessorInterface.C.

{
  return _pi_feproblem.getPostprocessorValueOlder(name);
}

getRequestedItems()

const std::set< std::string > & GeneralUserObject::getRequestedItems ( )

overridevirtualinherited

Return a set containing the names of items requested by the object.

Implements DependencyResolverInterface.

Definition at line 37 of file GeneralUserObject.C.

{
  return _depend_vars;
}

getScalarVar()

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

protectedinherited

Extract pointer to a scalar coupled variable.

Parameters

var_name	Name of parameter desired
comp	Component number of multiple coupled variables

Returns

Pointer to the desired variable

Definition at line 276 of file ScalarCoupleable.C.

Referenced by 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().

{
  if (_coupled_scalar_vars.find(var_name) != _coupled_scalar_vars.end())
  {
    if (comp < _coupled_scalar_vars[var_name].size())
      return _coupled_scalar_vars[var_name][comp];
    else
      mooseError(_sc_name, "Trying to get a non-existent component of variable '", var_name, "'");
  }
  else
    mooseError(_sc_name, "Trying to get a non-existent variable '", var_name, "'");
}

getScalarVariableCoupleableMatrixTags()

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

inlineinherited

Definition at line 55 of file ScalarCoupleable.h.

{ return _sc_coupleable_matrix_tags; }

getScalarVariableCoupleableVectorTags()

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

inlineinherited

Definition at line 53 of file ScalarCoupleable.h.

{ return _sc_coupleable_vector_tags; }

getScatterVectorPostprocessorValue()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValue ( const std::string &  name, const std::string &  vector_name  )

virtualinherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns

The reference to the current scatter value

Reimplemented in AuxKernel.

Definition at line 92 of file VectorPostprocessorInterface.C.

Referenced by AuxKernel::getScatterVectorPostprocessorValue().

{
  return _vpi_feproblem.getScatterVectorPostprocessorValue(
      _vpi_params.get<VectorPostprocessorName>(name), vector_name);
}

getScatterVectorPostprocessorValueByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueByName ( const std::string &  name, const std::string &  vector_name  )

virtualinherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

vpp_name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns

The reference to the current scatter value

Reimplemented in AuxKernel.

Definition at line 100 of file VectorPostprocessorInterface.C.

Referenced by AuxKernel::getScatterVectorPostprocessorValueByName().

{
  return _vpi_feproblem.getScatterVectorPostprocessorValue(name, vector_name);
}

getScatterVectorPostprocessorValueOld()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld ( const std::string &  name, const std::string &  vector_name  )

virtualinherited

Return the old scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns

The reference to the old scatter value

Definition at line 107 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getScatterVectorPostprocessorValueOld(
      _vpi_params.get<VectorPostprocessorName>(name), vector_name);
}

getScatterVectorPostprocessorValueOldByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOldByName ( const std::string &  name, const std::string &  vector_name  )

virtualinherited

Return the old scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

vpp_name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns

The reference to the old scatter value

Definition at line 115 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getScatterVectorPostprocessorValueOld(name, vector_name);
}

getSubProblem()

SubProblem& UserObject::getSubProblem ( ) const

inlineinherited

Returns a reference to the subproblem that this postprocessor is tied to.

Definition at line 71 of file UserObject.h.

{ return _subproblem; }

getSuppliedItems()

const std::set< std::string > & GeneralUserObject::getSuppliedItems ( )

overridevirtualinherited

Return a set containing the names of items owned by the object.

Implements DependencyResolverInterface.

Definition at line 43 of file GeneralUserObject.C.

{
  return _supplied_vars;
}

getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject ( const std::string &  name )

inherited

Get an user object with a given parameter name.

Parameters

name	The 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 81 of file UserObjectInterface.h.

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

getUserObjectBase()

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

inherited

Get an user object with a given parameter name.

Parameters

name	The 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.

Referenced by UserObjectInterface::getUserObject(), InitialConditionBase::getUserObjectBase(), and AuxKernel::getUserObjectBase().

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

getUserObjectBaseByName()

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

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns

The user object with the name

Definition at line 30 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObjectByName().

{
  return _uoi_feproblem.getUserObjectBase(name);
}

getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName ( const std::string &  name )

inherited

Get an user object with a given name.

Parameters

name	The name of the user object to retrieve

Returns

The user object with the name

Definition at line 89 of file UserObjectInterface.h.

{
  unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
  return _uoi_feproblem.getUserObject<T>(name, tid);
}

getValue()

PostprocessorValue LinearCombinationPostprocessor::getValue ( )

overridevirtual

This will get called to actually grab the final value the postprocessor has calculated.

Implements Postprocessor.

Definition at line 54 of file LinearCombinationPostprocessor.C.

{
  Real linear_combination = _b_value;
  for (unsigned int i = 0; i < _n_pp; i++)
    linear_combination += _pp_coefs[i] * *(_pp_values[i]);

  return linear_combination;
}

getVectorPostprocessorValue() [1/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValue ( const std::string &  name, const std::string &  vector_name  )

overridevirtualinherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of a VectorPostprocessor

Parameters

name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Reimplemented from VectorPostprocessorInterface.

Definition at line 63 of file GeneralUserObject.C.

{
  _depend_vars.insert(_pars.get<VectorPostprocessorName>(name));
  return VectorPostprocessorInterface::getVectorPostprocessorValue(name, vector_name);
}

getVectorPostprocessorValue() [2/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValue ( const std::string &  name, const std::string &  vector_name, bool  needs_broadcast  )

overridevirtualinherited

Retrieve the value of a VectorPostprocessor.

Parameters

name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Reimplemented from VectorPostprocessorInterface.

Definition at line 79 of file GeneralUserObject.C.

{
  _depend_vars.insert(_pars.get<VectorPostprocessorName>(name));
  return VectorPostprocessorInterface::getVectorPostprocessorValue(
      name, vector_name, use_broadcast);
}

getVectorPostprocessorValueByName() [1/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValueByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  )

overridevirtualinherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of the VectorPostprocessor

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Reimplemented from VectorPostprocessorInterface.

Definition at line 71 of file GeneralUserObject.C.

{
  _depend_vars.insert(name);
  return VectorPostprocessorInterface::getVectorPostprocessorValueByName(name, vector_name);
}

getVectorPostprocessorValueByName() [2/2]

const VectorPostprocessorValue & GeneralUserObject::getVectorPostprocessorValueByName ( const VectorPostprocessorName &  name, const std::string &  vector_name, bool  needs_broadcast  )

overridevirtualinherited

Retrieve the value of the VectorPostprocessor.

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Reimplemented from VectorPostprocessorInterface.

Definition at line 89 of file GeneralUserObject.C.

{
  _depend_vars.insert(name);
  return VectorPostprocessorInterface::getVectorPostprocessorValueByName(
      name, vector_name, use_broadcast);
}

getVectorPostprocessorValueOld() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld ( const std::string &  name, const std::string &  vector_name  )

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.

Returns

The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 40 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getVectorPostprocessorValueOld(
      _vpi_params.get<VectorPostprocessorName>(name), vector_name, _broadcast_by_default);
}

getVectorPostprocessorValueOld() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld ( const std::string &  name, const std::string &  vector_name, bool  needs_broadcast  )

virtualinherited

Retrieve the old value of a VectorPostprocessor.

Parameters

name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns

The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 73 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getVectorPostprocessorValueOld(
      _vpi_params.get<VectorPostprocessorName>(name),
      vector_name,
      needs_broadcast || _broadcast_by_default);
}

getVectorPostprocessorValueOldByName() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName ( const VectorPostprocessorName &  name, const std::string &  vector_name  )

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.

Returns

The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 48 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getVectorPostprocessorValueOld(name, vector_name, _broadcast_by_default);
}

getVectorPostprocessorValueOldByName() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName ( const VectorPostprocessorName &  name, const std::string &  vector_name, bool  needs_broadcast  )

virtualinherited

Retrieve the old value of a VectorPostprocessor.

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns

The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 84 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.getVectorPostprocessorValueOld(
      name, vector_name, needs_broadcast || _broadcast_by_default);
}

getZeroMaterialProperty()

template<typename T >

const MaterialProperty< T > & MaterialPropertyInterface::getZeroMaterialProperty ( const std::string &  prop_name )

inherited

Return a material property that is initialized to zero by default and does not need to (but can) be declared by another material.

Definition at line 521 of file MaterialPropertyInterface.h.

{
  // static zero property storage
  static MaterialProperty<T> zero;

  // resize to accomodate maximum number of qpoints
  // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
  unsigned int nqp = _mi_feproblem.getMaxQps();
  if (nqp > zero.size())
    zero.resize(nqp);

  // set values for all qpoints to zero
  for (unsigned int qp = 0; qp < nqp; ++qp)
    mooseSetToZero<T>(zero[qp]);

  return zero;
}

hasMaterialProperty()

template<typename T >

bool MaterialPropertyInterface::hasMaterialProperty ( const std::string &  name )

inherited

Check if the material property exists.

Parameters

name	the name of the property to query

Returns

true if the property exists, otherwise false

Definition at line 505 of file MaterialPropertyInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string prop_name = deducePropertyName(name);
  return _material_data->haveProperty<T>(prop_name);
}

hasMaterialPropertyByName()

template<typename T >

bool MaterialPropertyInterface::hasMaterialPropertyByName ( const std::string &  name )

inherited

Definition at line 514 of file MaterialPropertyInterface.h.

{
  return _material_data->haveProperty<T>(name);
}

hasPostprocessor()

bool PostprocessorInterface::hasPostprocessor ( const std::string &  name ) const

inherited

Determine if the Postprocessor exists.

Parameters

name	The name of the Postprocessor parameter

Returns

True if the Postprocessor exists

See also

hasPostprocessorByName getPostprocessorValue

Definition at line 74 of file PostprocessorInterface.C.

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

{
  return _pi_feproblem.hasPostprocessor(_ppi_params.get<PostprocessorName>(name));
}

hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName &  name )

inherited

Determine if the Postprocessor exists.

Parameters

name	The name of the Postprocessor

Returns

True if the Postprocessor exists

See also

hasPostprocessor getPostprocessorValueByName

Definition at line 80 of file PostprocessorInterface.C.

Referenced by VectorOfPostprocessors::VectorOfPostprocessors().

{
  return _pi_feproblem.hasPostprocessor(name);
}

hasVectorPostprocessor()

bool VectorPostprocessorInterface::hasVectorPostprocessor ( const std::string &  name ) const

inherited

Determine if the VectorPostprocessor exists.

Parameters

name	The name of the VectorPostprocessor parameter

Returns

True if the VectorPostprocessor exists

See also

hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 122 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.hasVectorPostprocessor(_vpi_params.get<VectorPostprocessorName>(name));
}

hasVectorPostprocessorByName()

bool VectorPostprocessorInterface::hasVectorPostprocessorByName ( const VectorPostprocessorName &  name ) const

inherited

Determine if the VectorPostprocessor exists.

Parameters

name	The name of the VectorPostprocessor

Returns

True if the VectorPostprocessor exists

See also

hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 128 of file VectorPostprocessorInterface.C.

{
  return _vpi_feproblem.hasVectorPostprocessor(name);
}

initialize()

void LinearCombinationPostprocessor::initialize ( )

overridevirtual

Called before execute() is ever called so that data can be cleared.

Implements UserObject.

Definition at line 44 of file LinearCombinationPostprocessor.C.

{
}

initialSetup()

void SetupInterface::initialSetup ( )

virtualinherited

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

Reimplemented in SolutionUserObject, AdvancedOutput, Output, MultiApp, MooseParsedFunction, MooseParsedGradFunction, SolutionFunction, DerivativeFunctionMaterialBase, Exodus, CSV, Transfer, Receiver, OversampleOutput, Nemesis, Axisymmetric2D3DSolutionFunction, ImageFunction, Console, TimePeriod, MooseParsedVectorFunction, TransientMultiApp, MultiAppCopyTransfer, SolutionAux, MultiAppNearestNodeTransfer, MultiAppProjectionTransfer, PiecewiseBase, MatDiffusionBase< T >, MultiAppInterpolationTransfer, MultiAppMeshFunctionTransfer, MultiAppUserObjectTransfer, MatDiffusionBase< Real >, MultiAppVariableValueSampleTransfer, FullSolveMultiApp, and DerivativeSumMaterial.

Definition at line 42 of file SetupInterface.C.

Referenced by FunctionPeriodicBoundary::init().

{
}

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_name	The of the coupled variable
i	By default 0, in general the index to test in a vector of MooseVariable pointers.

Definition at line 83 of file ScalarCoupleable.C.

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

{
  std::map<std::string, std::vector<MooseVariableScalar *>>::iterator it =
      _coupled_scalar_vars.find(var_name);
  if (it != _coupled_scalar_vars.end())
    return (i < it->second.size());
  else
  {
    // Make sure the user originally requested this value in the InputParameter syntax
    if (!_coupleable_params.hasCoupledValue(var_name))
      mooseError(_sc_name,
                 "The coupled scalar variable \"",
                 var_name,
                 "\" was never added to this objects's "
                 "InputParameters, please double-check "
                 "your spelling");

    return false;
  }
}

isImplicit()

bool TransientInterface::isImplicit ( )

inlineinherited

Definition at line 42 of file TransientInterface.h.

{ return _is_implicit; }

isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 86 of file MooseObject.h.

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

{ return _pars.isParamValid(name); }

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 52 of file SetupInterface.C.

{
}

markMatPropRequested()

void MaterialPropertyInterface::markMatPropRequested ( const std::string &  name )

protectedinherited

A proxy method for _mi_feproblem.markMatPropRequested(name)

Definition at line 187 of file MaterialPropertyInterface.C.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyOldByName(), and MaterialPropertyInterface::getMaterialPropertyOlderByName().

{
  _mi_feproblem.markMatPropRequested(name);
}

meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

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

Definition at line 38 of file MeshChangedInterface.h.

{}

mooseDeprecated()

template<typename... Args>

void MooseObject::mooseDeprecated ( Args &&...  args ) const

inlineinherited

Definition at line 158 of file MooseObject.h.

Referenced by FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), Material::declarePropertyOld(), Material::declarePropertyOlder(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

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

mooseError()

template<typename... Args>

void MooseObject::mooseError ( Args &&...  args ) const

inlineinherited

Definition at line 144 of file MooseObject.h.

Referenced by PetscExternalPartitioner::_do_partition(), GridPartitioner::_do_partition(), FEProblemBase::addConstraint(), FEProblemBase::addInitialCondition(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), FEProblemBase::addOutput(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction::BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), TiledMesh::buildMesh(), FileMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::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(), Material::checkExecutionStage(), BreakMeshByBlockBase::checkInputParameter(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), ActuallyExplicitEuler::checkLinearConvergence(), FEProblemBase::checkProblemIntegrity(), Material::checkStatefulSanity(), FEProblemBase::checkUserObjects(), LibmeshPartitioner::clone(), MooseMesh::clone(), ComparisonPostprocessor::comparisonIsTrue(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), KernelBase::computeADOffDiagJacobian(), InterfaceKernel::computeElemNeighJacobian(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), HistogramVectorPostprocessor::computeHistogram(), EqualValueEmbeddedConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), KernelValue::computeQpResidual(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualType(), StatisticsVectorPostprocessor::computeStatValue(), Material::computeSubdomainProperties(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), ActuallyExplicitEuler::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), TimeStepper::constrainStep(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), CoupledForce::CoupledForce(), DebugResidualAux::DebugResidualAux(), BicubicSplineFunction::derivative(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementQualityAux::ElementQualityAux(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ElementQualityChecker::execute(), NodalValueSampler::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), TimeExtremeValue::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFit::execute(), LeastSquaresFitHistory::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus::Exodus(), FileOutput::FileOutput(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), VerifyElementUniqueID::finalize(), VerifyNodalUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), Transfer::find_sys(), BreakMeshByBlockBase::findFreeBoundaryId(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), ElementSubdomainIDGenerator::generate(), ExtraNodesetGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), GeneratedMeshGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsFromBoundingBoxGenerator::generate(), StackGenerator::generate(), SpiralAnnularMeshGenerator::generate(), PatternedMeshGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), RandomICBase::generateRandom(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), MooseMesh::getCoarseningMap(), Control::getControllableParameterByName(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), ElementGenerator::getElemType(), MultiApp::getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), AuxKernel::getMaterialProperty(), AuxKernel::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOlder(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), DistributedGeneratedMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), AnnularMesh::getMinInDimension(), DistributedGeneratedMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MooseMesh::getMortarInterface(), MooseMesh::getMortarInterfaceByName(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMeshGenerator::GetPixelInfo(), ImageMesh::GetPixelInfo(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), Residual::getValue(), PerformanceData::getValue(), PerfGraphData::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), Transient::init(), MooseMesh::init(), FEProblemBase::init(), NumPicardIterations::initialize(), FullSolveMultiApp::initialSetup(), PiecewiseBase::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), SolutionFunction::initialSetup(), Exodus::initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), Material::initStatefulProperties(), Function::integral(), InterfaceKernel::InterfaceKernel(), InterfaceTimeKernel::InterfaceTimeKernel(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredSideIntegral::LayeredSideIntegral(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshSideSetGenerator::MeshSideSetGenerator(), SideSetsFromNormals::modify(), SideSetsFromPoints::modify(), BreakMeshByBlockBase::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), SmoothMesh::modify(), AssignElementSubdomainID::modify(), AddAllSideSetsByNormals::modify(), ElementDeleterBase::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), AddSideSetsFromBoundingBox::modify(), SubdomainBoundingBox::modify(), MooseMesh::MooseMesh(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), 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(), ElementSideNeighborLayers::operator()(), ElementPointNeighbors::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(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), LStableDirk4::postResidual(), AStableDirk4::postResidual(), ExplicitRK2::postResidual(), Predictor::Predictor(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), EqualValueEmbeddedConstraint::reinitConstraint(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), ScalarComponentIC::ScalarComponentIC(), BicubicSplineFunction::secondDerivative(), FEProblemBase::setCoordSystem(), PiecewiseBase::setData(), EigenProblem::setEigenproblemType(), Sampler::setNumberOfRequiedRandomSeeds(), 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(), ActuallyExplicitEuler::solve(), FullSolveMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), Console::systemInfoFlags(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), TiledMeshGenerator::TiledMeshGenerator(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppCopyTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), FEProblemBase::uDotDotOldRequested(), FEProblemBase::uDotOldRequested(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), 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().

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

mooseInfo()

template<typename... Args>

void MooseObject::mooseInfo ( Args &&...  args ) const

inlineinherited

Definition at line 164 of file MooseObject.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), and MooseObject::paramInfo().

  {
    moose::internal::mooseInfoStream(_console, std::forward<Args>(args)...);
  }

mooseWarning()

template<typename... Args>

void MooseObject::mooseWarning ( Args &&...  args ) const

inlineinherited

Definition at line 152 of file MooseObject.h.

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), DerivativeFunctionMaterialBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), MultiAppTransfer::MultiAppTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MooseObject::paramWarning(), Executioner::problem(), Material::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

  {
    moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
  }

name()

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

inlineinherited

Get the name of the object.

Returns

The name of the object

Definition at line 56 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), Executioner::addAttributeReporter(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), 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(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), MooseMesh::addMortarInterface(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), Function::average(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), Material::checkStatefulSanity(), CompositeFunction::CompositeFunction(), Material::computeSubdomainProperties(), VectorPostprocessorVisualizationAux::computeValue(), AuxKernel::coupledCallback(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), MultiApp::createApp(), FEProblemBase::declareVectorPostprocessorVector(), DOFMapOutput::demangle(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), DumpObjectsProblem::dumpObjectHelper(), ElementValueSampler::ElementValueSampler(), MooseMesh::errorIfDistributedMesh(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), StatisticsVectorPostprocessor::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), PointValue::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), HistogramVectorPostprocessor::execute(), MultiAppCopyTransfer::execute(), Exodus::Exodus(), FileOutput::FileOutput(), MultiApp::fillPositions(), PointSamplerBase::finalize(), DerivativeParsedMaterialHelper::findMatPropDerivative(), FunctionDT::FunctionDT(), GeneralUserObject::GeneralUserObject(), LowerDBlockFromSidesetGenerator::generate(), StitchedMeshGenerator::generate(), Material::getADMaterialProperty(), MultiApp::getBoundingBox(), MooseObject::getCheckedPointerParam(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), MultiApp::getExecutioner(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), Marker::getMarkerValue(), FEProblemBase::getMaterial(), NodalPatchRecovery::getMaterialProperty(), AuxKernel::getMaterialProperty(), Material::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), NodalPatchRecovery::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOlder(), AuxKernel::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), MeshGenerator::getMesh(), MooseMesh::getMortarInterfaceByName(), OutputWarehouse::getOutput(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), AuxKernel::getPostprocessorValue(), FEProblemBase::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), AuxKernel::getPostprocessorValueByName(), FEProblemBase::getPostprocessorValueOld(), FEProblemBase::getPostprocessorValueOlder(), FEProblemBase::getSampler(), AuxKernel::getScatterVectorPostprocessorValue(), FEProblemBase::getScatterVectorPostprocessorValue(), AuxKernel::getScatterVectorPostprocessorValueByName(), FEProblemBase::getScatterVectorPostprocessorValueOld(), Transient::getTimeStepperName(), AuxKernel::getUserObject(), InitialConditionBase::getUserObject(), FEProblemBase::getUserObject(), InitialConditionBase::getUserObjectBase(), AuxKernel::getUserObjectBase(), FEProblemBase::getUserObjectBase(), AuxKernel::getUserObjectByName(), InitialConditionBase::getUserObjectByName(), GeneralUserObject::getVectorPostprocessorValue(), AuxKernel::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValue(), GeneralUserObject::getVectorPostprocessorValueByName(), AuxKernel::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(), MultiAppProjectionTransfer::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPostprocessorData(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), Material::initStatefulProperties(), FEProblemBase::initVectorPostprocessorData(), Function::integral(), InterfaceKernel::InterfaceKernel(), MooseObject::isParamValid(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshSideSetGenerator::MeshSideSetGenerator(), ElementDeleterBase::modify(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), Material::resetQpProperties(), Sampler::Sampler(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), SubProblem::storeSubdomainZeroMatProp(), TaggingInterface::TaggingInterface(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), Function::timeDerivative(), VectorPostprocessorVisualizationAux::timestepSetup(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), and AdvancedOutput::wantOutput().

{ return _name; }

paramError()

template<typename... Args>

void MooseObject::paramError ( const std::string &  param, Args...  args  )

inlineinherited

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 105 of file MooseObject.h.

Referenced by ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), DGKernel::DGKernel(), ElementValueSampler::ElementValueSampler(), StackGenerator::generate(), StitchedMeshGenerator::generate(), MultiApp::init(), IntegratedBC::IntegratedBC(), Kernel::Kernel(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), RandomIC::RandomIC(), MultiAppCopyTransfer::transfer(), and TransientMultiApp::TransientMultiApp().

                                                                      {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseError(prefix, args...);
  }

parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns

The parameters of the object

Definition at line 62 of file MooseObject.h.

Referenced by FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), 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(), 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(), FEProblemBase::addVectorPostprocessor(), AdvancedOutput::AdvancedOutput(), assemble_l2(), Moose::assemble_matrix(), AuxKernel::AuxKernel(), 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(), Executioner::Executioner(), Exodus::Exodus(), FEProblem::FEProblem(), GapValueAux::GapValueAux(), MooseObject::getCheckedPointerParam(), MooseMesh::init(), BlockRestrictable::initializeBlockRestrictable(), FEProblemBase::initNullSpaceVectors(), InterfaceKernel::InterfaceKernel(), isValid(), LayeredSideIntegral::LayeredSideIntegral(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodeFaceConstraint::NodeFaceConstraint(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), MultiAppProjectionTransfer::projectSolution(), RandomIC::RandomIC(), InputParameterWarehouse::removeInputParameters(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), DumpObjectsProblem::stringifyParameters(), and Transient::Transient().

{ return _pars; }

paramInfo()

template<typename... Args>

void MooseObject::paramInfo ( const std::string &  param, Args...  args  )

inlineinherited

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 135 of file MooseObject.h.

Referenced by TransientMultiApp::TransientMultiApp().

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseInfo(prefix, args...);
  }

paramWarning()

template<typename... Args>

void MooseObject::paramWarning ( const std::string &  param, Args...  args  )

inlineinherited

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 119 of file MooseObject.h.

  {
    auto prefix = param + ": ";
    if (!_pars.inputLocation(param).empty())
      prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
    mooseWarning(prefix, args...);
  }

PPName()

std::string Postprocessor::PPName ( )

inlineinherited

Returns the name of the Postprocessor.

Definition at line 43 of file Postprocessor.h.

{ return _pp_name; }

primaryThreadCopy()

UserObject* UserObject::primaryThreadCopy ( )

inlineinherited

Definition at line 135 of file UserObject.h.

{ return _primary_thread_copy; }

registerTimedSection()

PerfID PerfGraphInterface::registerTimedSection ( const std::string &  section_name, const unsigned int  level  )

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns

The ID of the section - use when starting timing

Definition at line 50 of file PerfGraphInterface.C.

{
  if (_prefix != "")
    return _perf_graph.registerSection(_prefix + "::" + section_name, level);
  else
    return _perf_graph.registerSection(section_name, level);
}

residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

Definition at line 57 of file SetupInterface.C.

{
}

setPrimaryThreadCopy()

void UserObject::setPrimaryThreadCopy ( UserObject *  primary )

inlineinherited

Definition at line 129 of file UserObject.h.

Referenced by FEProblemBase::addUserObject().

  {
    if (!_primary_thread_copy && primary != this)
      _primary_thread_copy = primary;
  }

shouldDuplicateInitialExecution()

bool UserObject::shouldDuplicateInitialExecution ( ) const

inlineinherited

Returns whether or not this user object should be executed twice during the initial condition when depended upon by an IC.

Definition at line 77 of file UserObject.h.

{ return _duplicate_initial_execution; }

sort()

template<typename T >

void DependencyResolverInterface::sort ( typename std::vector< T > &  vector )

staticinherited

Given a vector, sort using the getRequested/SuppliedItems sets.

Definition at line 58 of file DependencyResolverInterface.h.

Referenced by TheWarehouse::prepare().

{
  DependencyResolver<T> resolver;

  typename std::vector<T>::iterator start = vector.begin();
  typename std::vector<T>::iterator end = vector.end();

  for (typename std::vector<T>::iterator iter = start; iter != end; ++iter)
  {
    const std::set<std::string> & requested_items = (*iter)->getRequestedItems();

    for (typename std::vector<T>::iterator iter2 = start; iter2 != end; ++iter2)
    {
      if (iter == iter2)
        continue;

      const std::set<std::string> & supplied_items = (*iter2)->getSuppliedItems();

      std::set<std::string> intersect;
      std::set_intersection(requested_items.begin(),
                            requested_items.end(),
                            supplied_items.begin(),
                            supplied_items.end(),
                            std::inserter(intersect, intersect.end()));

      // If the intersection isn't empty then there is a dependency here
      if (!intersect.empty())
        resolver.insertDependency(*iter, *iter2);
    }
  }

  // Sort based on dependencies
  std::stable_sort(start, end, resolver);
}

spatialValue()

virtual Real UserObject::spatialValue ( const Point &  ) const

inlinevirtualinherited

Optional interface function for "evaluating" a UserObject at a spatial position.

If a UserObject overrides this function that UserObject can then be used in a Transfer to transfer information from one domain to another.

Reimplemented in NearestPointBase< UserObjectType >, NearestPointBase< LayeredAverage >, LineValueSampler, LayeredSideIntegral, and LayeredIntegral.

Definition at line 84 of file UserObject.h.

Referenced by SpatialUserObjectAux::computeValue(), MultiAppDTKUserObjectEvaluator::evaluate(), and MultiAppUserObjectTransfer::execute().

  {
    mooseError(name(), " does not satisfy the Spatial UserObject interface!");
  }

statefulPropertiesAllowed()

void MaterialPropertyInterface::statefulPropertiesAllowed ( bool  stateful_allowed )

inherited

Derived classes can declare whether or not they work with stateful material properties.

See, for example, DiracKernel. By default, they are allowed.

Definition at line 193 of file MaterialPropertyInterface.C.

Referenced by DiracKernel::DiracKernel().

{
  _stateful_allowed = stateful_allowed;
}

subdomainSetup()

void GeneralUserObject::subdomainSetup ( )

overridevirtualinherited

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 from SetupInterface.

Reimplemented in ThreadedGeneralUserObject.

Definition at line 106 of file GeneralUserObject.C.

{
  mooseError("GeneralUserObjects do not execute subdomainSetup method, this function does nothing "
             "and should not be used.");
}

threadJoin()

void GeneralUserObject::threadJoin ( const UserObject &  )

overridevirtualinherited

This method is not used and should not be used in a custom GeneralUserObject.

Implements UserObject.

Reimplemented in ThreadedGeneralUserObject.

Definition at line 99 of file GeneralUserObject.C.

{
  mooseError("GeneralUserObjects do not execute using threads, this function does nothing and "
             "should not be used.");
}

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 47 of file SetupInterface.C.

{
}

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 50 of file MooseObject.h.

Referenced by DumpObjectsProblem::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), DumpObjectsProblem::addAuxVariable(), DisplacedProblem::addAuxVariable(), 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(), DumpObjectsProblem::addVariable(), DisplacedProblem::addVariable(), FEProblemBase::addVariable(), FEProblemBase::advanceMultiApps(), FEProblemBase::backupMultiApps(), MooseMesh::buildRefinementAndCoarseningMaps(), FEProblemBase::computeAuxiliaryKernels(), ElemElemConstraint::computeElemNeighJacobian(), InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighResidual(), InterfaceKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), FEProblemBase::computeMultiAppsDT(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), DGConvection::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), DGConvection::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeUserObjects(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finishMultiAppStep(), ElementSubdomainIDGenerator::generate(), ElementGenerator::getElemType(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getTransfers(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), SolutionUserObject::initialSetup(), AdvancedOutput::initShowHideLists(), 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().

{ return _type; }

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

name	the name of the variable
fn_name	The name of the function that called this method - used in the error message

Definition at line 290 of file ScalarCoupleable.C.

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

{
  if (!_sc_fe_problem.isTransient())
    mooseError(_sc_name,
               ": Calling '",
               fn_name,
               "' on variable \"",
               name,
               "\" when using a \"Steady\" executioner is not allowed. This value is available "
               "only in transient simulations.");
}

Member Data Documentation

_app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 174 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), AlgebraicRelationshipManager::attachAlgebraicFunctorHelper(), RelationshipManager::attachRelationshipManagers(), ElementSideNeighborLayers::attachRelationshipManagersInternal(), ElementPointNeighbors::attachRelationshipManagersInternal(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), 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(), InversePowerMethod::init(), NonlinearEigen::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), InversePowerMethod::InversePowerMethod(), MooseObject::mooseError(), NonlinearEigen::NonlinearEigen(), EigenExecutionerBase::normalizeSolution(), 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(), 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().

_assembly

Assembly& UserObject::_assembly

protectedinherited

Definition at line 146 of file UserObject.h.

Referenced by InternalSideUserObject::getNeighborElemVolume().

_b_value

const Real LinearCombinationPostprocessor::_b_value

protected

Additional value to add to sum.

Definition at line 47 of file LinearCombinationPostprocessor.h.

Referenced by getValue().

_console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 32 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), SetupRecoverFileBaseAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), FEProblemBase::FEProblemBase(), 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(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), PicardSolve::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(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

_coord_sys

const Moose::CoordinateSystemType& UserObject::_coord_sys

protectedinherited

Coordinate system.

Definition at line 149 of file UserObject.h.

_coupleable_params

const InputParameters& ScalarCoupleable::_coupleable_params

protectedinherited

Local InputParameters.

Definition at line 211 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::isCoupledScalar().

_coupled_moose_scalar_vars

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

protectedinherited

Vector of coupled variables.

Definition at line 205 of file ScalarCoupleable.h.

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

_coupled_scalar_vars

std::map<std::string, std::vector<MooseVariableScalar *> > ScalarCoupleable::_coupled_scalar_vars

protectedinherited

Coupled vars whose values we provide.

Definition at line 199 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarComponents(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), and ScalarCoupleable::ScalarCoupleable().

_current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 98 of file SetupInterface.h.

_default_ad_real_properties

std::vector<std::unique_ptr<ADMaterialPropertyObject<Real> > > MaterialPropertyInterface::_default_ad_real_properties

protectedinherited

Storage vector for ADMaterialPropertyObject<Real> default objects.

Definition at line 266 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultADMaterialProperty().

_default_ad_real_vector_properties

std::vector<std::unique_ptr<ADMaterialPropertyObject<RealVectorValue> > > MaterialPropertyInterface::_default_ad_real_vector_properties

protectedinherited

Storage vector for ADMaterialPropertyObject<RealVectorValue> default objects.

Definition at line 269 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultADMaterialProperty().

_default_real_properties

std::vector<std::unique_ptr<MaterialProperty<Real> > > MaterialPropertyInterface::_default_real_properties

protectedinherited

Storage vector for MaterialProperty<Real> default objects.

Definition at line 264 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::defaultMaterialProperty().

_default_value

std::map<std::string, VariableValue *> ScalarCoupleable::_default_value

protectedinherited

Will hold the default value for optional coupled scalar variables.

Definition at line 202 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::~ScalarCoupleable().

_depend_vars

std::set<std::string> GeneralUserObject::_depend_vars

protectedinherited

Definition at line 76 of file GeneralUserObject.h.

Referenced by GeneralUserObject::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), GeneralUserObject::getRequestedItems(), GeneralUserObject::getVectorPostprocessorValue(), and GeneralUserObject::getVectorPostprocessorValueByName().

_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().

_duplicate_initial_execution

const bool UserObject::_duplicate_initial_execution

protectedinherited

Definition at line 151 of file UserObject.h.

Referenced by UserObject::shouldDuplicateInitialExecution().

_enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 183 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 95 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 92 of file SetupInterface.h.

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

_fe_problem

FEProblemBase& UserObject::_fe_problem

protectedinherited

Reference to the FEProblemBase for this user object.

Definition at line 142 of file UserObject.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), ElementsAlongLine::ElementsAlongLine(), ElementsAlongPlane::ElementsAlongPlane(), VariableResidual::execute(), StatisticsVectorPostprocessor::execute(), NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), IntersectionPointsAlongLine::execute(), ElementsAlongLine::execute(), ElementsAlongPlane::execute(), HistogramVectorPostprocessor::execute(), NodalNormalsPreprocessor::execute(), WorkBalance::execute(), Terminator::execute(), NumResidualEvaluations::getValue(), ElementalVariableValue::getValue(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), Receiver::initialSetup(), IntersectionPointsAlongLine::IntersectionPointsAlongLine(), SolutionUserObject::pointValueGradientWrapper(), and SolutionUserObject::pointValueWrapper().

_get_material_property_called

bool MaterialPropertyInterface::_get_material_property_called

protectedinherited

Initialized to false.

Gets set to true when getMaterialProperty() is called. Clients of this class can inquire whether getMaterialProperty() has been called by calling getMaterialPropertyCalled().

Definition at line 261 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyByName(), and MaterialPropertyInterface::getMaterialPropertyCalled().

_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().

_material_data

std::shared_ptr<MaterialData> MaterialPropertyInterface::_material_data

protectedinherited

Pointer to the material data class that stores properties.

Definition at line 211 of file MaterialPropertyInterface.h.

Referenced by Material::computeProperties(), Material::copyDualNumbersToValues(), Material::declareProperty(), Material::declarePropertyOld(), Material::declarePropertyOlder(), MaterialPropertyInterface::getADMaterialPropertyByName(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyOldByName(), MaterialPropertyInterface::getMaterialPropertyOlderByName(), Material::getZeroMaterialProperty(), MaterialPropertyInterface::hasMaterialProperty(), MaterialPropertyInterface::hasMaterialPropertyByName(), Material::initStatefulProperties(), MaterialPropertyInterface::MaterialPropertyInterface(), Material::registerPropName(), and Material::subdomainSetup().

_material_data_type

Moose::MaterialDataType MaterialPropertyInterface::_material_data_type

protectedinherited

The type of data.

Definition at line 208 of file MaterialPropertyInterface.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), MaterialPropertyInterface::getMaterialByName(), and MaterialPropertyInterface::MaterialPropertyInterface().

_material_property_dependencies

std::set<unsigned int> MaterialPropertyInterface::_material_property_dependencies

protectedinherited

The set of material properties (as given by their IDs) that this object depends on.

Definition at line 272 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getADMaterialPropertyByName(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getMaterialPropertyByName(), MaterialPropertyInterface::getMaterialPropertyOldByName(), MaterialPropertyInterface::getMaterialPropertyOlderByName(), and MaterialPropertyInterface::getMatPropDependencies().

_mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 42 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

_mi_feproblem

FEProblemBase& MaterialPropertyInterface::_mi_feproblem

protectedinherited

Reference to the FEProblemBase class.

Definition at line 214 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkExecutionStage(), MaterialPropertyInterface::checkMaterialProperty(), MaterialPropertyInterface::defaultADMaterialProperty(), MaterialPropertyInterface::defaultMaterialProperty(), MaterialPropertyInterface::getADMaterialPropertyByName(), MaterialPropertyInterface::getBlockMaterialProperty(), MaterialPropertyInterface::getMaterialByName(), MaterialPropertyInterface::getMaterialPropertyBlockNames(), MaterialPropertyInterface::getMaterialPropertyBlocks(), MaterialPropertyInterface::getMaterialPropertyBoundaryIDs(), MaterialPropertyInterface::getMaterialPropertyBoundaryNames(), MaterialPropertyInterface::getZeroMaterialProperty(), Material::getZeroMaterialProperty(), MaterialPropertyInterface::markMatPropRequested(), and MaterialPropertyInterface::MaterialPropertyInterface().

_mi_name

const std::string MaterialPropertyInterface::_mi_name

protectedinherited

The name of the object that this interface belongs to.

Definition at line 205 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::checkBlockAndBoundaryCompatibility(), and MaterialPropertyInterface::checkMaterialProperty().

_mi_params

const InputParameters& MaterialPropertyInterface::_mi_params

protectedinherited

Parameters of the object with this interface.

Definition at line 202 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::deducePropertyName(), MaterialPropertyInterface::getMaterial(), and MaterialPropertyInterface::MaterialPropertyInterface().

_mi_tid

const THREAD_ID MaterialPropertyInterface::_mi_tid

protectedinherited

Current threaded it.

Definition at line 217 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getMaterialByName().

_n_pp

const unsigned int LinearCombinationPostprocessor::_n_pp

protected

Number of post-processors in linear combination.

Definition at line 43 of file LinearCombinationPostprocessor.h.

Referenced by getValue(), and LinearCombinationPostprocessor().

_name

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 180 of file MooseObject.h.

Referenced by DerivativeParsedMaterialHelper::assembleDerivatives(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), PiecewiseBase::initialSetup(), MooseObject::name(), PiecewiseBilinear::parse(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

_pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 171 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), BreakMeshByBlockBase::checkInputParameter(), PetscExternalPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::Eigenvalue(), Eigenvalue::execute(), Executioner::Executioner(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), AuxKernel::getPostprocessorValue(), AuxKernel::getScatterVectorPostprocessorValue(), AuxKernel::getUserObject(), InitialConditionBase::getUserObject(), InitialConditionBase::getUserObjectBase(), AuxKernel::getUserObjectBase(), GeneralUserObject::getVectorPostprocessorValue(), AuxKernel::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramError(), MooseObject::parameters(), MooseObject::paramInfo(), MooseObject::paramWarning(), and Transient::setupTimeIntegrator().

_perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 66 of file PerfGraphInterface.h.

Referenced by PerfGraphData::getValue(), and PerfGraphInterface::registerTimedSection().

_pg_params

const InputParameters* PerfGraphInterface::_pg_params

protectedinherited

Params.

Definition at line 63 of file PerfGraphInterface.h.

_point_zero

const Point& ScalarCoupleable::_point_zero

protectedinherited

Zero point.

Definition at line 223 of file ScalarCoupleable.h.

Referenced by FunctionDT::computeDT(), FunctionScalarAux::computeValue(), and FunctionScalarIC::value().

_pp_coefs

const std::vector<Real>& LinearCombinationPostprocessor::_pp_coefs

protected

List of linear combination coefficients for each post-processor value.

Definition at line 45 of file LinearCombinationPostprocessor.h.

Referenced by getValue(), and LinearCombinationPostprocessor().

_pp_name

std::string Postprocessor::_pp_name

protectedinherited

Definition at line 46 of file Postprocessor.h.

Referenced by Receiver::initialSetup(), and Postprocessor::PPName().

_pp_names

const std::vector<PostprocessorName>& LinearCombinationPostprocessor::_pp_names

protected

List of names of post-processors to include in linear combination.

Definition at line 41 of file LinearCombinationPostprocessor.h.

Referenced by LinearCombinationPostprocessor().

_pp_values

std::vector<const PostprocessorValue *> LinearCombinationPostprocessor::_pp_values

protected

List of post-processor values.

Definition at line 50 of file LinearCombinationPostprocessor.h.

Referenced by getValue(), and LinearCombinationPostprocessor().

_prefix

std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 69 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::registerTimedSection().

_real_zero

const Real& ScalarCoupleable::_real_zero

protectedinherited

Scalar zero.

Definition at line 217 of file ScalarCoupleable.h.

_sc_fe_problem

FEProblemBase& ScalarCoupleable::_sc_fe_problem

protectedinherited

Definition at line 196 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::coupledScalarOrder(), ScalarCoupleable::getDefaultValue(), and ScalarCoupleable::validateExecutionerType().

_sc_is_implicit

bool ScalarCoupleable::_sc_is_implicit

protectedinherited

True if implicit value is required.

Definition at line 208 of file ScalarCoupleable.h.

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

_sc_name

const std::string& ScalarCoupleable::_sc_name

protectedinherited

The name of the object this interface is part of.

Definition at line 66 of file ScalarCoupleable.h.

Referenced by ScalarCoupleable::checkVar(), ScalarCoupleable::getScalarVar(), ScalarCoupleable::isCoupledScalar(), ScalarCoupleable::ScalarCoupleable(), and ScalarCoupleable::validateExecutionerType().

_sc_parameters

const InputParameters& ScalarCoupleable::_sc_parameters

protectedinherited

Definition at line 63 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 214 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 220 of file ScalarCoupleable.h.

_stateful_allowed

bool MaterialPropertyInterface::_stateful_allowed

protectedinherited

True by default.

If false, this class throws an error if any of the stateful material properties interfaces are used.

Definition at line 254 of file MaterialPropertyInterface.h.

Referenced by MaterialPropertyInterface::getMaterialPropertyOld(), MaterialPropertyInterface::getMaterialPropertyOldByName(), MaterialPropertyInterface::getMaterialPropertyOlder(), MaterialPropertyInterface::getMaterialPropertyOlderByName(), and MaterialPropertyInterface::statefulPropertiesAllowed().

_subproblem

SubProblem& UserObject::_subproblem

protectedinherited

Reference to the Subproblem for this user object.

Definition at line 139 of file UserObject.h.

Referenced by PointValue::execute(), PointSamplerBase::execute(), VerifyNodalUniqueID::finalize(), VerifyElementUniqueID::finalize(), UserObject::getSubProblem(), NumLinearIterations::getValue(), Residual::getValue(), ElementalVariableValue::getValue(), NodalVariableValue::getValue(), NumNonlinearIterations::getValue(), FindValueOnLine::getValueAtPoint(), VerifyNodalUniqueID::initialize(), VerifyElementUniqueID::initialize(), NumDOFs::NumDOFs(), and NumVars::NumVars().

_supplied_vars

std::set<std::string> GeneralUserObject::_supplied_vars

protectedinherited

Definition at line 77 of file GeneralUserObject.h.

Referenced by GeneralUserObject::GeneralUserObject(), and GeneralUserObject::getSuppliedItems().

_t

Real& TransientInterface::_t

protectedinherited

Time.

Definition at line 58 of file TransientInterface.h.

Referenced by GenericFunctionMaterial::computeQpFunctions(), AnalyticalIndicator::computeQpIntegral(), ElementL2Error::computeQpIntegral(), ElementVectorL2Error::computeQpIntegral(), FunctionSideIntegral::computeQpIntegral(), ElementH1SemiError::computeQpIntegral(), ElementW1pError::computeQpIntegral(), FunctionNeumannBC::computeQpResidual(), FunctionDiracSource::computeQpResidual(), ConvectiveFluxBC::computeQpResidual(), LagrangeVecFunctionDirichletBC::computeQpResidual(), VectorBodyForce::computeQpResidual(), UserForcingFunctionNodalKernel::computeQpResidual(), BodyForce::computeQpResidual(), FunctionPenaltyDirichletBC::computeQpResidual(), SinDirichletBC::computeQpResidual(), SinNeumannBC::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), FunctionPresetBC::computeQpValue(), FunctionScalarAux::computeValue(), FunctionAux::computeValue(), ElementL2ErrorFunctionAux::computeValue(), SolutionAux::computeValue(), ElementH1ErrorFunctionAux::computeValue(), LineFunctionSampler::execute(), NodalL2Error::execute(), RealFunctionControl::execute(), TimePeriod::execute(), LeastSquaresFitHistory::execute(), UserForcingFunction::f(), FunctionDirichletBC::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_params

const InputParameters& TransientInterface::_ti_params

protectedinherited

Definition at line 45 of file TransientInterface.h.

_tid

THREAD_ID UserObject::_tid

protectedinherited

Thread ID of this postprocessor.

Definition at line 145 of file UserObject.h.

Referenced by NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), NodalNormalsPreprocessor::execute(), ElementalVariableValue::getValue(), NodalVariableValue::getValue(), NodalNormalsPreprocessor::initialize(), and SolutionUserObject::pointValueWrapper().

_type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 177 of file MooseObject.h.

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

---

The documentation for this class was generated from the following files:

• include/postprocessors/LinearCombinationPostprocessor.h
• src/postprocessors/LinearCombinationPostprocessor.C