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

#include <MooseVariableFEBase.h>

Inheritance diagram for MooseVariableFEBase:
[legend]

Public Member Functions

 MooseVariableFEBase (const InputParameters &parameters)
 
virtual void clearDofIndices ()=0
 Clear out the dof indices. More...
 
virtual void prepare ()=0
 Prepare the elemental degrees of freedom. More...
 
virtual void prepareNeighbor ()=0
 Prepare the neighbor element degrees of freedom. More...
 
virtual void prepareLowerD ()=0
 Prepare a lower dimensional element's degrees of freedom. More...
 
virtual void prepareAux ()=0
 
virtual void reinitNode ()=0
 
virtual void reinitAux ()=0
 
virtual void reinitAuxNeighbor ()=0
 
virtual void reinitNodes (const std::vector< dof_id_type > &nodes)=0
 
virtual void reinitNodesNeighbor (const std::vector< dof_id_type > &nodes)=0
 
virtual Moose::VarFieldType fieldType () const =0
 Filed type of this variable. More...
 
virtual bool isVector () const =0
 
virtual bool isNodalDefined () const =0
 Is this variable defined at nodes. More...
 
virtual const dof_id_type & nodalDofIndex () const =0
 
virtual const dof_id_type & nodalDofIndexNeighbor () const =0
 
virtual const Elem *const & currentElem () const =0
 Current element this variable is evaluated at. More...
 
virtual const std::set< SubdomainID > & activeSubdomains () const =0
 The subdomains the variable is active on. More...
 
virtual bool activeOnSubdomain (SubdomainID subdomain) const =0
 Is the variable active on the subdomain? More...
 
virtual void prepareIC ()=0
 Prepare the initial condition. More...
 
virtual void computeElemValues ()=0
 Compute values at interior quadrature points. More...
 
virtual void computeElemValuesFace ()=0
 Compute values at facial quadrature points. More...
 
virtual void computeNeighborValuesFace ()=0
 Compute values at facial quadrature points for the neighbor. More...
 
virtual void computeNeighborValues ()=0
 Compute values at quadrature points for the neighbor. More...
 
virtual void computeLowerDValues ()=0
 compute values at quadrature points on the lower dimensional element More...
 
virtual void computeNodalNeighborValues ()=0
 Compute nodal values of this variable in the neighbor. More...
 
virtual void computeNodalValues ()=0
 Compute nodal values of this variable. More...
 
virtual void getDofIndices (const Elem *elem, std::vector< dof_id_type > &dof_indices) const =0
 
virtual const std::vector< dof_id_type > & dofIndicesNeighbor () const =0
 Get neighbor DOF indices for currently selected element. More...
 
virtual const std::vector< dof_id_type > & dofIndicesLower () const =0
 Get dof indices for the current lower dimensional element (this is meaningful when performing mortar FEM) More...
 
virtual unsigned int numberOfDofsNeighbor ()=0
 
virtual void insert (NumericVector< Number > &residual)=0
 
virtual void add (NumericVector< Number > &residual)=0
 
virtual size_t phiSize () const =0
 Return phi size. More...
 
virtual size_t phiFaceSize () const =0
 Return phiFace size. More...
 
virtual size_t phiNeighborSize () const =0
 Return phiNeighbor size. More...
 
virtual size_t phiFaceNeighborSize () const =0
 Return phiFaceNeighbor size. More...
 
virtual size_t phiLowerSize () const =0
 Return the number of shape functions on the lower dimensional element for this variable. More...
 
unsigned int number () const
 Get variable number coming from libMesh. More...
 
const FEType & feType () const
 Get the type of finite element object. More...
 
SystemBasesys ()
 Get the system this variable is part of. More...
 
const std::string & name () const override
 Get the variable name. More...
 
const std::vector< dof_id_type > & allDofIndices () const
 Get all global dofindices for the variable. More...
 
unsigned int totalVarDofs ()
 
Moose::VarKindType kind () const
 Kind of the variable (Nonlinear, Auxiliary, ...) More...
 
void scalingFactor (Real factor)
 Set the scaling factor for this variable. More...
 
void scalingFactor (const std::vector< Real > &factor)
 
Real scalingFactor () const
 Get the scaling factor for this variable. More...
 
const std::vector< Real > & arrayScalingFactor () const
 
Order order () const
 Get the order of this variable Note: Order enum can be implicitly converted to unsigned int. More...
 
unsigned int count () const
 Get the number of components Note: For standard and vector variables, the number is one. More...
 
virtual bool isNodal () const
 Is this variable nodal. More...
 
const DofMap & dofMap () const
 The DofMap associated with the system this variable is in. More...
 
virtual const std::vector< dof_id_type > & dofIndices () const
 Get local DoF indices. More...
 
std::vector< dof_id_type > componentDofIndices (const std::vector< dof_id_type > &dof_indices, unsigned int component) const
 Obtain DoF indices of a component with the indices of the 0th component. More...
 
virtual unsigned int numberOfDofs () const
 Get the number of local DoFs. More...
 
const std::string & type () const
 Get the type of this object. More...
 
const InputParametersparameters () const
 Get the parameters of the object. More...
 
template<typename T >
const T & getParamTempl (const std::string &name) const
 Retrieve a parameter for the object. More...
 
template<typename T >
getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 Verifies that the requested parameter exists and is not NULL and returns it to the caller. More...
 
bool isParamValid (const std::string &name) const
 Test if the supplied parameter is valid. More...
 
MooseAppgetMooseApp () const
 Get the MooseApp this object is associated with. More...
 
virtual bool enabled () const
 Return the enabled status of the object. More...
 
template<typename... Args>
void paramError (const std::string &param, Args... args) const
 Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void paramWarning (const std::string &param, Args... args) const
 Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void paramInfo (const std::string &param, Args... args) const
 Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message. More...
 
template<typename... Args>
void mooseError (Args &&... args) const
 
template<typename... Args>
void mooseWarning (Args &&... args) const
 
template<typename... Args>
void mooseDeprecated (Args &&... args) const
 
template<typename... Args>
void mooseInfo (Args &&... args) const
 
const std::vector< SubdomainName > & blocks () const
 Return the block names for this object. More...
 
unsigned int numBlocks () const
 Return the number of blocks for this object. More...
 
const virtual std::set< SubdomainID > & blockIDs () const
 Return the block subdomain ids for this object. More...
 
bool hasBlocks (const SubdomainName &name) const
 Test if the supplied block name is valid for this object. More...
 
bool hasBlocks (const std::vector< SubdomainName > &names) const
 Test if the supplied vector of block names are valid for this object. More...
 
bool hasBlocks (const SubdomainID &id) const
 Test if the supplied block ids are valid for this object. More...
 
bool hasBlocks (const std::vector< SubdomainID > &ids) const
 Test if the supplied vector block ids are valid for this object. More...
 
bool hasBlocks (const std::set< SubdomainID > &ids) const
 Test if the supplied set of block ids are valid for this object. More...
 
bool isBlockSubset (const std::set< SubdomainID > &ids) const
 Test if the class block ids are a subset of the supplied objects. More...
 
bool isBlockSubset (const std::vector< SubdomainID > &ids) const
 Test if the class block ids are a subset of the supplied objects. More...
 
template<typename T >
bool hasBlockMaterialProperty (const std::string &prop_name)
 Check if a material property is valid for all blocks of this object. More...
 
const std::set< SubdomainID > & meshBlockIDs () const
 Return all of the SubdomainIDs for the mesh. More...
 
virtual bool blockRestricted () const
 Returns true if this object has been restricted to a boundary. More...
 
void checkVariable (const MooseVariableFEBase &variable) const
 Helper for checking that the ids for this object are in agreement with the variables on the supplied variable. 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...
 

Static Public Member Functions

static InputParameters validParams ()
 

Public Attributes

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

Protected Member Functions

virtual bool hasBlockMaterialPropertyHelper (const std::string &prop_name)
 A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty. More...
 
void initializeBlockRestrictable (const MooseObject *moose_object)
 An initialization routine needed for dual constructors. More...
 
Moose::CoordinateSystemType getBlockCoordSystem ()
 Check if the blocks this object operates on all have the same coordinate system, and if so return it. More...
 

Protected Attributes

SystemBase_sys
 System this variable is part of. More...
 
FEType _fe_type
 The FEType associated with this variable. More...
 
unsigned int _var_num
 variable number (from libMesh) More...
 
unsigned int _index
 variable number within MOOSE More...
 
Moose::VarKindType _var_kind
 Variable type (see MooseTypes.h) More...
 
SubProblem_subproblem
 Problem this variable is part of. More...
 
const Variable & _variable
 libMesh variable object for this variable More...
 
Assembly_assembly
 Assembly data. More...
 
const DofMap & _dof_map
 DOF map. More...
 
std::vector< dof_id_type > _dof_indices
 DOF indices. More...
 
MooseMesh_mesh
 mesh the variable is active in More...
 
THREAD_ID _tid
 Thread ID. More...
 
const unsigned int _count
 Number of variables in the array. More...
 
std::vector< Real > _scaling_factor
 scaling factor for this variable More...
 
std::string _var_name
 Variable name. More...
 
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...
 
std::shared_ptr< MaterialData_blk_material_data
 Pointer to the MaterialData class for this object. More...
 

Private Member Functions

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

Private Attributes

std::set< SubdomainID_blk_ids
 Set of block ids supplied by the user via the input file (for error reporting) More...
 
std::vector< SubdomainName > _blocks
 Vector the block names supplied by the user via the input file. More...
 
const bool _blk_dual_restrictable
 Flag for allowing dual restriction. More...
 
FEProblemBase_blk_feproblem
 Pointer to FEProblemBase. More...
 
MooseMesh_blk_mesh
 Pointer to Mesh. More...
 
const std::set< BoundaryID_empty_boundary_ids
 An empty set for referencing when boundary_ids is not included. More...
 
const std::set< BoundaryID > & _boundary_ids
 Reference to the boundary_ids, defaults to an empty set if not provided. More...
 
THREAD_ID _blk_tid
 Thread id for this object. More...
 
const std::string & _blk_name
 Name of the object. More...
 
MooseApp_oi_moose_app
 Reference the the MooseApp; neede for access to the OutputWarehouse. More...
 
OutputWarehouse_oi_output_warehouse
 Reference to the OutputWarehouse for populating the Output object hide lists. More...
 
std::set< OutputName > _oi_outputs
 The set of Output object names listed in the 'outputs' parameter. More...
 

Detailed Description

Definition at line 27 of file MooseVariableFEBase.h.

Constructor & Destructor Documentation

◆ MooseVariableFEBase()

MooseVariableFEBase::MooseVariableFEBase ( const InputParameters parameters)

Definition at line 20 of file MooseVariableFEBase.C.

22 {
23 }

Member Function Documentation

◆ activeOnSubdomain()

virtual bool MooseVariableFEBase::activeOnSubdomain ( SubdomainID  subdomain) const
pure virtual

◆ activeSubdomains()

virtual const std::set<SubdomainID>& MooseVariableFEBase::activeSubdomains ( ) const
pure virtual

◆ add()

virtual void MooseVariableFEBase::add ( NumericVector< Number > &  residual)
pure virtual

◆ allDofIndices()

const std::vector< dof_id_type > & MooseVariableBase::allDofIndices ( ) const
inherited

Get all global dofindices for the variable.

Definition at line 111 of file MooseVariableBase.C.

112 {
113  const auto it = _sys.subproblem()._var_dof_map.find(name());
114  if (it != _sys.subproblem()._var_dof_map.end())
115  return it->second;
116  else
117  mooseError("VariableAllDoFMap not prepared for ",
118  name(),
119  " . Check nonlocal coupling requirement for the variable.");
120 }

Referenced by FEProblemBase::addJacobianBlock(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), FEProblemBase::prepare(), Assembly::prepareNonlocal(), Assembly::prepareVariableNonlocal(), and MooseVariableBase::totalVarDofs().

◆ arrayScalingFactor()

const std::vector<Real>& MooseVariableBase::arrayScalingFactor ( ) const
inlineinherited

◆ blockIDs()

const std::set< SubdomainID > & BlockRestrictable::blockIDs ( ) const
virtualinherited

Return the block subdomain ids for this object.

Returns
a set of SudomainIDs that are valid for this object

Definition at line 174 of file BlockRestrictable.C.

175 {
176  return _blk_ids;
177 }

Referenced by BlockRestrictable::getBlockCoordSystem(), MaterialBase::getZeroMaterialProperty(), BlockRestrictable::hasBlockMaterialPropertyHelper(), and MaterialBase::registerPropName().

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const
virtualinherited

Returns true if this object has been restricted to a boundary.

See also
MooseObject

Definition at line 162 of file BlockRestrictable.C.

163 {
164  return _blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end();
165 }

Referenced by BlockRestrictable::checkVariable(), BlockRestrictable::getBlockCoordSystem(), and BlockRestrictable::hasBlockMaterialPropertyHelper().

◆ blocks()

const std::vector< SubdomainName > & BlockRestrictable::blocks ( ) const
inherited

Return the block names for this object.

Note, if the 'blocks' input parameter was not utilized this will return an empty vector.

Returns
vector of SubdomainNames that are valid for this object

Definition at line 168 of file BlockRestrictable.C.

169 {
170  return _blocks;
171 }

Referenced by MaterialOutputAction::getParams().

◆ 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_namesA 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 64 of file OutputInterface.C.

65 {
66  // Set of available names
67  const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();
68 
69  // Check for 'none'; hide variables on all outputs
70  if (_oi_outputs.find("none") != _oi_outputs.end())
71  for (const auto & name : avail)
72  _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
73 
74  // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
75  // these cases
76  else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
77  return;
78 
79  // Limit the variable output to Output objects listed
80  else
81  {
82  // Create a list of outputs where the variable should be hidden
83  std::set<OutputName> hide;
84  std::set_difference(avail.begin(),
85  avail.end(),
86  _oi_outputs.begin(),
87  _oi_outputs.end(),
88  std::inserter(hide, hide.begin()));
89 
90  // If 'outputs' is specified add the object name to the list of items to hide
91  for (const auto & name : hide)
92  _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
93  }
94 }

Referenced by OutputInterface::OutputInterface().

◆ checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableFEBase variable) const
inherited

Helper for checking that the ids for this object are in agreement with the variables on the supplied variable.

Parameters
variableThe variable to check against.

Definition at line 314 of file BlockRestrictable.C.

315 {
316  if (!isBlockSubset(variable.activeSubdomains()))
317  {
318  std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
319  std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
320  mooseError("The 'block' parameter of the object '",
321  _blk_name,
322  "' must be a subset of the 'block' parameter of the variable '",
323  variable.name(),
324  "':\n Object '",
325  _blk_name,
326  "': ",
327  obj_ids,
328  "\n Variable '",
329  variable.name(),
330  "': ",
331  var_ids);
332  }
333 }

◆ clearDofIndices()

virtual void MooseVariableFEBase::clearDofIndices ( )
pure virtual

Clear out the dof indices.

We do this in case this variable is not going to be prepared at all...

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ componentDofIndices()

std::vector< dof_id_type > MooseVariableBase::componentDofIndices ( const std::vector< dof_id_type > &  dof_indices,
unsigned int  component 
) const
inherited

Obtain DoF indices of a component with the indices of the 0th component.

Definition at line 129 of file MooseVariableBase.C.

131 {
132  std::vector<dof_id_type> new_dof_indices(dof_indices);
133  if (component != 0)
134  {
135  if (isNodal())
136  for (auto & id : new_dof_indices)
137  id += component;
138  else
139  {
140  unsigned int n = dof_indices.size();
141  for (auto & id : new_dof_indices)
142  id += component * n;
143  }
144  }
145  return new_dof_indices;
146 }

Referenced by Assembly::addJacobianBlock(), Assembly::cacheJacobianBlock(), and Assembly::cacheJacobianBlockNonzero().

◆ computeElemValues()

virtual void MooseVariableFEBase::computeElemValues ( )
pure virtual

◆ computeElemValuesFace()

virtual void MooseVariableFEBase::computeElemValuesFace ( )
pure virtual

◆ computeLowerDValues()

virtual void MooseVariableFEBase::computeLowerDValues ( )
pure virtual

◆ computeNeighborValues()

virtual void MooseVariableFEBase::computeNeighborValues ( )
pure virtual

◆ computeNeighborValuesFace()

virtual void MooseVariableFEBase::computeNeighborValuesFace ( )
pure virtual

◆ computeNodalNeighborValues()

virtual void MooseVariableFEBase::computeNodalNeighborValues ( )
pure virtual

◆ computeNodalValues()

virtual void MooseVariableFEBase::computeNodalValues ( )
pure virtual

◆ count()

unsigned int MooseVariableBase::count ( ) const
inlineinherited

Get the number of components Note: For standard and vector variables, the number is one.

Definition at line 98 of file MooseVariableBase.h.

98 { return _count; }

Referenced by Assembly::addJacobianBlock(), SystemBase::addVariableToZeroOnJacobian(), SystemBase::addVariableToZeroOnResidual(), ArrayConstantIC::ArrayConstantIC(), ArrayFunctionIC::ArrayFunctionIC(), Assembly::cacheJacobianBlock(), Assembly::cacheJacobianBlockNonzero(), ArrayNodalBC::computeJacobian(), Kernel::computeOffDiagJacobian(), ArrayNodalBC::computeOffDiagJacobian(), ArrayDiffusion::computeQpJacobian(), ArrayReaction::computeQpJacobian(), ArrayTimeDerivative::computeQpJacobian(), ArrayKernel::computeQpJacobian(), ArrayIntegratedBC::computeQpJacobian(), ArrayNodalBC::computeQpJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobian(), ArrayKernel::computeQpOffDiagJacobian(), ArrayNodalBC::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), Kernel::computeQpOffDiagJacobianArray(), ArrayKernel::computeQpOffDiagJacobianScalar(), ArrayIntegratedBC::computeQpOffDiagJacobianScalar(), ArrayDiffusion::computeQpResidual(), ArrayReaction::computeQpResidual(), ArrayTimeDerivative::computeQpResidual(), ArrayFunctionIC::gradient(), AdvancedOutput::initAvailableLists(), AdvancedOutput::initShowHideLists(), Assembly::prepareBlock(), Assembly::prepareBlockNonlocal(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), EigenProblem::scaleEigenvector(), MultiAppFieldTransfer::transfer(), MultiAppFieldTransfer::transferDofObject(), and ArrayFunctionIC::value().

◆ currentElem()

virtual const Elem* const & MooseVariableFEBase::currentElem ( ) const
pure virtual

◆ dofIndices()

virtual const std::vector<dof_id_type>& MooseVariableBase::dofIndices ( ) const
inlinevirtualinherited

◆ dofIndicesLower()

virtual const std::vector<dof_id_type>& MooseVariableFEBase::dofIndicesLower ( ) const
pure virtual

Get dof indices for the current lower dimensional element (this is meaningful when performing mortar FEM)

Returns
the lower dimensional element's dofs

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

Referenced by ADMortarConstraint< compute_stage >::computeJacobian(), MortarConstraint::computeJacobian(), and Assembly::prepareLowerD().

◆ dofIndicesNeighbor()

virtual const std::vector<dof_id_type>& MooseVariableFEBase::dofIndicesNeighbor ( ) const
pure virtual

◆ dofMap()

const DofMap& MooseVariableBase::dofMap ( ) const
inlineinherited

The DofMap associated with the system this variable is in.

Definition at line 109 of file MooseVariableBase.h.

109 { return _dof_map; }

Referenced by AuxScalarKernel::compute(), and ScalarVariable::getValue().

◆ enabled()

virtual bool MooseObject::enabled ( ) const
inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ feType()

const FEType& MooseVariableBase::feType ( ) const
inlineinherited

◆ fieldType()

virtual Moose::VarFieldType MooseVariableFEBase::fieldType ( ) const
pure virtual

◆ getBlockCoordSystem()

Moose::CoordinateSystemType BlockRestrictable::getBlockCoordSystem ( )
protectedinherited

Check if the blocks this object operates on all have the same coordinate system, and if so return it.

Definition at line 292 of file BlockRestrictable.C.

293 {
294  if (!_blk_mesh)
295  mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
296  if (!_blk_feproblem)
297  mooseError("No problem available in BlockRestrictable::checkCoordSystem()");
298 
299  const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();
300 
301  if (subdomains.empty())
302  mooseError("No subdomains found in the problem.");
303 
304  // make sure all subdomains are using the same coordinate system
305  auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
306  for (auto subdomain : subdomains)
307  if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
308  mooseError("This object requires all subdomains to have the same coordinate system.");
309 
310  return coord_system;
311 }

◆ getCheckedPointerParam()

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

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

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

Definition at line 91 of file MooseObject.h.

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

◆ getDofIndices()

virtual void MooseVariableFEBase::getDofIndices ( const Elem *  elem,
std::vector< dof_id_type > &  dof_indices 
) const
pure virtual

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const
inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

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

◆ 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 97 of file OutputInterface.C.

98 {
99  return _oi_outputs;
100 }

◆ getParamTempl()

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

◆ hasBlockMaterialProperty()

template<typename T >
bool BlockRestrictable::hasBlockMaterialProperty ( const std::string &  prop_name)
inherited

Check if a material property is valid for all blocks of this object.

This method returns true if the supplied property name has been declared in a Material object on the block ids for this object.

Template Parameters
TThe type of material property
Parameters
prop_namethe name of the property to query
Returns
true if the property exists for all block ids of the object, otherwise false
See also
Material::hasBlockMaterialProperty

Definition at line 256 of file BlockRestrictable.h.

257 {
258  mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
259  return hasBlockMaterialPropertyHelper(prop_name) &&
260  _blk_material_data->haveProperty<T>(prop_name);
261 }

◆ hasBlockMaterialPropertyHelper()

bool BlockRestrictable::hasBlockMaterialPropertyHelper ( const std::string &  prop_name)
protectedvirtualinherited

A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.

It also avoid circular #include problems.

See also
hasBlockMaterialProperty

Definition at line 256 of file BlockRestrictable.C.

257 {
258 
259  // Reference to MaterialWarehouse for testing and retrieving block ids
261 
262  // Complete set of ids that this object is active
263  const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();
264 
265  // Loop over each id for this object
266  for (const auto & id : ids)
267  {
268  // Storage of material properties that have been DECLARED on this id
269  std::set<std::string> declared_props;
270 
271  // If block materials exist, populated the set of properties that were declared
272  if (warehouse.hasActiveBlockObjects(id))
273  {
274  const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
275  for (const auto & mat : mats)
276  {
277  const std::set<std::string> & mat_props = mat->getSuppliedItems();
278  declared_props.insert(mat_props.begin(), mat_props.end());
279  }
280  }
281 
282  // If the supplied property is not in the list of properties on the current id, return false
283  if (declared_props.find(prop_name) == declared_props.end())
284  return false;
285  }
286 
287  // If you get here the supplied property is defined on all blocks
288  return true;
289 }

Referenced by BlockRestrictable::hasBlockMaterialProperty().

◆ hasBlocks() [1/5]

bool BlockRestrictable::hasBlocks ( const std::set< SubdomainID > &  ids) const
inherited

Test if the supplied set of block ids are valid for this object.

Parameters
idsA std::set of SubdomainIDs to check
Returns
True if the all of the given ids are found within the ids for this object
See also
isSubset

Definition at line 218 of file BlockRestrictable.C.

219 {
220  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
221  return true;
222  else
223  return std::includes(_blk_ids.begin(), _blk_ids.end(), ids.begin(), ids.end());
224 }

◆ hasBlocks() [2/5]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainID > &  ids) const
inherited

Test if the supplied vector block ids are valid for this object.

Parameters
idsA vector of SubdomainIDs ids to check
Returns
True if the all of the given ids are found within the ids for this object

Definition at line 211 of file BlockRestrictable.C.

212 {
213  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
214  return hasBlocks(ids_set);
215 }

◆ hasBlocks() [3/5]

bool BlockRestrictable::hasBlocks ( const std::vector< SubdomainName > &  names) const
inherited

Test if the supplied vector of block names are valid for this object.

Parameters
namesA vector of SubdomainNames to check
Returns
True if the given ids are valid for this object

Definition at line 196 of file BlockRestrictable.C.

197 {
198  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
199 }

◆ hasBlocks() [4/5]

bool BlockRestrictable::hasBlocks ( const SubdomainID id) const
inherited

Test if the supplied block ids are valid for this object.

Parameters
idA SubdomainID to check
Returns
True if the given id is valid for this object

Definition at line 202 of file BlockRestrictable.C.

203 {
204  if (_blk_ids.empty() || _blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
205  return true;
206  else
207  return _blk_ids.find(id) != _blk_ids.end();
208 }

◆ hasBlocks() [5/5]

bool BlockRestrictable::hasBlocks ( const SubdomainName &  name) const
inherited

Test if the supplied block name is valid for this object.

Parameters
nameA SubdomainName to check
Returns
True if the given id is valid for this object

Definition at line 186 of file BlockRestrictable.C.

187 {
188  // Create a vector and utilize the getSubdomainIDs function, which
189  // handles the ANY_BLOCK_ID (getSubdomainID does not)
190  std::vector<SubdomainName> names(1);
191  names[0] = name;
192  return hasBlocks(_blk_mesh->getSubdomainIDs(names));
193 }

Referenced by CentroidMultiApp::fillPositions(), and BlockRestrictable::hasBlocks().

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject moose_object)
protectedinherited

An initialization routine needed for dual constructors.

Definition at line 79 of file BlockRestrictable.C.

80 {
81  // If the mesh pointer is not defined, but FEProblemBase is, get it from there
82  if (_blk_feproblem != NULL && _blk_mesh == NULL)
84 
85  // Check that the mesh pointer was defined, it is required for this class to operate
86  if (_blk_mesh == NULL)
87  mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
88  "pointer to the MooseMesh via '_mesh'");
89 
90  // Populate the MaterialData pointer
91  if (_blk_feproblem != NULL)
93 
94  // The 'block' input is defined
95  if (moose_object->isParamValid("block"))
96  {
97  // Extract the blocks from the input
98  _blocks = moose_object->getParamTempl<std::vector<SubdomainName>>("block");
99 
100  // Get the IDs from the supplied names
101  std::vector<SubdomainID> vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
102 
103  // Store the IDs, handling ANY_BLOCK_ID if supplied
104  if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
106  else
107  _blk_ids.insert(vec_ids.begin(), vec_ids.end());
108  }
109 
110  // When 'blocks' is not set and there is a "variable", use the blocks from the variable
111  else if (moose_object->isParamValid("variable"))
112  {
113  std::string variable_name = moose_object->parameters().getMooseType("variable");
114  if (!variable_name.empty())
116  ->getVariable(_blk_tid,
117  variable_name,
120  .activeSubdomains();
121  }
122 
123  // Produce error if the object is not allowed to be both block and boundary restricted
124  if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
125  if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
126  moose_object->paramError("block",
127  "Attempted to restrict the object '",
128  _blk_name,
129  "' to a block, but the object is already restricted by boundary");
130 
131  // If no blocks were defined above, specify that it is valid on all blocks
132  if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
133  {
135  _blocks = {"ANY_BLOCK_ID"};
136  }
137 
138  // If this object is block restricted, check that defined blocks exist on the mesh
139  if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
140  {
141  const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
142  std::vector<SubdomainID> diff;
143 
144  std::set_difference(_blk_ids.begin(),
145  _blk_ids.end(),
146  valid_ids.begin(),
147  valid_ids.end(),
148  std::back_inserter(diff));
149 
150  if (!diff.empty())
151  {
152  std::ostringstream msg;
153  msg << "the following block ids do not exist on the mesh:";
154  for (const auto & id : diff)
155  msg << " " << id;
156  moose_object->paramError("block", msg.str());
157  }
158  }
159 }

Referenced by BlockRestrictable::BlockRestrictable().

◆ insert()

virtual void MooseVariableFEBase::insert ( NumericVector< Number > &  residual)
pure virtual

◆ isBlockSubset() [1/2]

bool BlockRestrictable::isBlockSubset ( const std::set< SubdomainID > &  ids) const
inherited

Test if the class block ids are a subset of the supplied objects.

Parameters
idsA std::set of Subdomains to check
Returns
True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)
See also
hasBlocks

Definition at line 227 of file BlockRestrictable.C.

228 {
229  // An empty input is assumed to be ANY_BLOCK_ID
230  if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
231  return true;
232 
233  if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
234  return std::includes(ids.begin(),
235  ids.end(),
236  _blk_mesh->meshSubdomains().begin(),
237  _blk_mesh->meshSubdomains().end());
238  else
239  return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
240 }

Referenced by BlockRestrictable::checkVariable(), and BlockRestrictable::isBlockSubset().

◆ isBlockSubset() [2/2]

bool BlockRestrictable::isBlockSubset ( const std::vector< SubdomainID > &  ids) const
inherited

Test if the class block ids are a subset of the supplied objects.

Parameters
idsA std::vector of Subdomains to check
Returns
True if all of the block ids for this class are found within the given ids (opposite of hasBlocks)
See also
hasBlocks

Definition at line 243 of file BlockRestrictable.C.

244 {
245  std::set<SubdomainID> ids_set(ids.begin(), ids.end());
246  return isBlockSubset(ids_set);
247 }

◆ isNodal()

virtual bool MooseVariableBase::isNodal ( ) const
inlinevirtualinherited

◆ isNodalDefined()

virtual bool MooseVariableFEBase::isNodalDefined ( ) const
pure virtual

Is this variable defined at nodes.

Returns
true if it the variable is defined at nodes, otherwise false

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ isParamValid()

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

Test if the supplied parameter is valid.

Parameters
nameThe name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

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

◆ isVector()

virtual bool MooseVariableFEBase::isVector ( ) const
pure virtual

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const
inlineinherited

◆ meshBlockIDs()

const std::set< SubdomainID > & BlockRestrictable::meshBlockIDs ( ) const
inherited

Return all of the SubdomainIDs for the mesh.

Returns
A set of all subdomians for the entire mesh

Definition at line 250 of file BlockRestrictable.C.

251 {
252  return _blk_mesh->meshSubdomains();
253 }

Referenced by BlockRestrictable::checkVariable(), BlockRestrictable::getBlockCoordSystem(), and BlockRestrictable::hasBlockMaterialPropertyHelper().

◆ mooseDeprecated()

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

Definition at line 156 of file MooseObject.h.

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

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

◆ mooseError()

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

Definition at line 141 of file MooseObject.h.

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

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

◆ mooseInfo()

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

◆ mooseWarning()

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

◆ name()

const std::string& MooseVariableBase::name ( ) const
inlineoverridevirtualinherited

◆ nodalDofIndex()

virtual const dof_id_type& MooseVariableFEBase::nodalDofIndex ( ) const
pure virtual

◆ nodalDofIndexNeighbor()

virtual const dof_id_type& MooseVariableFEBase::nodalDofIndexNeighbor ( ) const
pure virtual

◆ number()

unsigned int MooseVariableBase::number ( ) const
inlineinherited

Get variable number coming from libMesh.

Returns
the libmesh variable number

Definition at line 48 of file MooseVariableBase.h.

48 { return _var_num; }

Referenced by Assembly::addJacobianBlock(), Assembly::addJacobianCoupledVarPair(), Assembly::cacheJacobianBlock(), Assembly::cacheJacobianBlockNonzero(), Assembly::cacheJacobianCoupledVarPair(), ADKernelGradTempl< T, compute_stage >::computeADOffDiagJacobian(), ADKernelStabilizedTempl< T, compute_stage >::computeADOffDiagJacobian(), ADKernelValueTempl< T, compute_stage >::computeADOffDiagJacobian(), ADKernelTempl< T, compute_stage >::computeADOffDiagJacobian(), DGKernel::computeElemNeighJacobian(), ArrayDGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighJacobian(), DGKernel::computeElemNeighResidual(), ElemElemConstraint::computeElemNeighResidual(), ArrayDGKernel::computeElemNeighResidual(), ComputeFullJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), MassLumpedTimeDerivative::computeJacobian(), TimeDerivative::computeJacobian(), VectorTimeDerivative::computeJacobian(), Kernel::computeJacobian(), VectorKernel::computeJacobian(), ArrayKernel::computeJacobian(), ODEKernel::computeJacobian(), ComputeFullJacobianThread::computeJacobian(), VectorIntegratedBC::computeJacobian(), EigenKernel::computeJacobian(), IntegratedBC::computeJacobian(), ArrayIntegratedBC::computeJacobian(), NodalEqualValueConstraint::computeJacobian(), EqualValueEmbeddedConstraint::computeJacobian(), NonlocalKernel::computeJacobian(), NonlocalIntegratedBC::computeJacobian(), KernelGrad::computeJacobian(), KernelValue::computeJacobian(), ADMortarConstraint< compute_stage >::computeJacobian(), MortarConstraint::computeJacobian(), NodeElemConstraint::computeJacobian(), NodeFaceConstraint::computeJacobian(), DiracKernel::computeJacobian(), ADIntegratedBCTempl< T, compute_stage >::computeJacobianBlock(), VectorIntegratedBC::computeJacobianBlock(), IntegratedBC::computeJacobianBlock(), ArrayIntegratedBC::computeJacobianBlock(), NonlocalIntegratedBC::computeJacobianBlock(), JvarMapIntegratedBCInterface< T >::computeJacobianBlock(), VectorIntegratedBC::computeJacobianBlockScalar(), ArrayIntegratedBC::computeJacobianBlockScalar(), IntegratedBC::computeJacobianBlockScalar(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), ArrayDGKernel::computeOffDiagElemNeighJacobian(), ODEKernel::computeOffDiagJacobian(), JvarMapKernelInterface< Kernel >::computeOffDiagJacobian(), Kernel::computeOffDiagJacobian(), NodalScalarKernel::computeOffDiagJacobian(), VectorKernel::computeOffDiagJacobian(), ArrayKernel::computeOffDiagJacobian(), EigenKernel::computeOffDiagJacobian(), EqualValueEmbeddedConstraint::computeOffDiagJacobian(), VectorNodalBC::computeOffDiagJacobian(), NodalBC::computeOffDiagJacobian(), NonlocalKernel::computeOffDiagJacobian(), KernelGrad::computeOffDiagJacobian(), KernelValue::computeOffDiagJacobian(), NodeElemConstraint::computeOffDiagJacobian(), NodeFaceConstraint::computeOffDiagJacobian(), DiracKernel::computeOffDiagJacobian(), NodalKernel::computeOffDiagJacobian(), VectorKernel::computeOffDiagJacobianScalar(), ArrayKernel::computeOffDiagJacobianScalar(), Kernel::computeOffDiagJacobianScalar(), OldEqualValueConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), ArrayDiffusion::computeQpOffDiagJacobian(), ArrayReaction::computeQpOffDiagJacobian(), ArrayTimeDerivative::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobian(), ArrayKernel::computeQpOffDiagJacobian(), ArrayNodalBC::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), Kernel::computeResidual(), VectorKernel::computeResidual(), ArrayKernel::computeResidual(), ODETimeKernel::computeResidual(), VectorTimeKernel::computeResidual(), TimeKernel::computeResidual(), ODEKernel::computeResidual(), VectorIntegratedBC::computeResidual(), EigenKernel::computeResidual(), IntegratedBC::computeResidual(), ArrayIntegratedBC::computeResidual(), NodalEqualValueConstraint::computeResidual(), KernelValue::computeResidual(), KernelGrad::computeResidual(), MortarConstraint::computeResidual(), NodeElemConstraint::computeResidual(), NodeFaceConstraint::computeResidual(), DiracKernel::computeResidual(), DebugResidualAux::computeValue(), Coupleable::coupled(), CoupledForce::CoupledForce(), CoupledForceNodalKernel::CoupledForceNodalKernel(), ScalarCoupleable::coupledScalar(), VariableResidual::execute(), NodalNormalsCorner::execute(), NodalNormalsEvaluator::execute(), NodalNormalsPreprocessor::execute(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ConservativeAdvection::fullUpwind(), LazyCoupleable::init(), NodalNormalsPreprocessor::initialize(), LowerBoundNodalKernel::LowerBoundNodalKernel(), PNGOutput::makeMeshFunc(), ComputeDiracThread::onElement(), ComputeNodalKernelBCJacobiansThread::onNode(), ComputeNodalKernelJacobiansThread::onNode(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), MultiAppProjectionTransfer::projectSolution(), EqualValueEmbeddedConstraint::reinitConstraint(), EigenProblem::scaleEigenvector(), AddPeriodicBCAction::setPeriodicVars(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), MultiAppFieldTransfer::transferDofObject(), UpdateErrorVectorsThread::UpdateErrorVectorsThread(), and UpperBoundNodalKernel::UpperBoundNodalKernel().

◆ numberOfDofs()

virtual unsigned int MooseVariableBase::numberOfDofs ( ) const
inlinevirtualinherited

◆ numberOfDofsNeighbor()

virtual unsigned int MooseVariableFEBase::numberOfDofsNeighbor ( )
pure virtual

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const
inherited

Return the number of blocks for this object.

Returns
The number of subdomains

Definition at line 180 of file BlockRestrictable.C.

181 {
182  return (unsigned int)_blk_ids.size();
183 }

◆ order()

Order MooseVariableBase::order ( ) const
inherited

◆ paramError()

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

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

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

Definition at line 215 of file MooseObject.h.

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

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

◆ paramErrorMsg()

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

Definition at line 185 of file MooseObject.h.

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

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

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const
inlineinherited

Get the parameters of the object.

Returns
The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

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

◆ paramInfo()

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

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

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

Definition at line 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

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

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

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

Definition at line 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ phiFaceNeighborSize()

virtual size_t MooseVariableFEBase::phiFaceNeighborSize ( ) const
pure virtual

◆ phiFaceSize()

virtual size_t MooseVariableFEBase::phiFaceSize ( ) const
pure virtual

◆ phiLowerSize()

virtual size_t MooseVariableFEBase::phiLowerSize ( ) const
pure virtual

Return the number of shape functions on the lower dimensional element for this variable.

Implemented in MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< RealVectorValue >, and MooseVariableFE< Real >.

◆ phiNeighborSize()

virtual size_t MooseVariableFEBase::phiNeighborSize ( ) const
pure virtual

◆ phiSize()

virtual size_t MooseVariableFEBase::phiSize ( ) const
pure virtual

◆ prepare()

virtual void MooseVariableFEBase::prepare ( )
pure virtual

◆ prepareAux()

virtual void MooseVariableFEBase::prepareAux ( )
pure virtual

◆ prepareIC()

virtual void MooseVariableFEBase::prepareIC ( )
pure virtual

◆ prepareLowerD()

virtual void MooseVariableFEBase::prepareLowerD ( )
pure virtual

◆ prepareNeighbor()

virtual void MooseVariableFEBase::prepareNeighbor ( )
pure virtual

◆ reinitAux()

virtual void MooseVariableFEBase::reinitAux ( )
pure virtual

◆ reinitAuxNeighbor()

virtual void MooseVariableFEBase::reinitAuxNeighbor ( )
pure virtual

◆ reinitNode()

virtual void MooseVariableFEBase::reinitNode ( )
pure virtual

◆ reinitNodes()

virtual void MooseVariableFEBase::reinitNodes ( const std::vector< dof_id_type > &  nodes)
pure virtual

◆ reinitNodesNeighbor()

virtual void MooseVariableFEBase::reinitNodesNeighbor ( const std::vector< dof_id_type > &  nodes)
pure virtual

◆ scalingFactor() [1/3]

Real MooseVariableBase::scalingFactor ( ) const
inlineinherited

Get the scaling factor for this variable.

Definition at line 85 of file MooseVariableBase.h.

85 { return _scaling_factor[0]; }

◆ scalingFactor() [2/3]

void MooseVariableBase::scalingFactor ( const std::vector< Real > &  factor)
inlineinherited

Definition at line 80 of file MooseVariableBase.h.

80 { _scaling_factor = factor; }

◆ scalingFactor() [3/3]

void MooseVariableBase::scalingFactor ( Real  factor)
inlineinherited

◆ sys()

SystemBase& MooseVariableBase::sys ( )
inlineinherited

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )
inlineinherited

Definition at line 69 of file MooseVariableBase.h.

69 { return allDofIndices().size(); }

◆ type()

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

Get the type of this object.

Returns
the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

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

◆ validParams()

InputParameters MooseVariableFEBase::validParams ( )
static

Definition at line 15 of file MooseVariableFEBase.C.

16 {
18 }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app
protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

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

◆ _assembly

Assembly& MooseVariableBase::_assembly
protectedinherited

Assembly data.

Definition at line 150 of file MooseVariableBase.h.

Referenced by MooseVariableFE< Real >::MooseVariableFE().

◆ _blk_dual_restrictable

const bool BlockRestrictable::_blk_dual_restrictable
privateinherited

Flag for allowing dual restriction.

Definition at line 233 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blk_feproblem

FEProblemBase* BlockRestrictable::_blk_feproblem
privateinherited

◆ _blk_ids

std::set<SubdomainID> BlockRestrictable::_blk_ids
privateinherited

◆ _blk_material_data

std::shared_ptr<MaterialData> BlockRestrictable::_blk_material_data
protectedinherited

Pointer to the MaterialData class for this object.

Definition at line 205 of file BlockRestrictable.h.

Referenced by BlockRestrictable::hasBlockMaterialProperty(), and BlockRestrictable::initializeBlockRestrictable().

◆ _blk_mesh

MooseMesh* BlockRestrictable::_blk_mesh
privateinherited

◆ _blk_name

const std::string& BlockRestrictable::_blk_name
privateinherited

Name of the object.

Definition at line 251 of file BlockRestrictable.h.

Referenced by BlockRestrictable::checkVariable(), and BlockRestrictable::initializeBlockRestrictable().

◆ _blk_tid

THREAD_ID BlockRestrictable::_blk_tid
privateinherited

Thread id for this object.

Definition at line 248 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _blocks

std::vector<SubdomainName> BlockRestrictable::_blocks
privateinherited

Vector the block names supplied by the user via the input file.

Definition at line 230 of file BlockRestrictable.h.

Referenced by BlockRestrictable::blocks(), and BlockRestrictable::initializeBlockRestrictable().

◆ _boundary_ids

const std::set<BoundaryID>& BlockRestrictable::_boundary_ids
privateinherited

Reference to the boundary_ids, defaults to an empty set if not provided.

Definition at line 245 of file BlockRestrictable.h.

Referenced by BlockRestrictable::initializeBlockRestrictable().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console
inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

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

◆ _count

const unsigned int MooseVariableBase::_count
protectedinherited

Number of variables in the array.

Definition at line 165 of file MooseVariableBase.h.

Referenced by MooseVariableBase::count(), MooseVariableBase::MooseVariableBase(), and MooseVariableBase::scalingFactor().

◆ _dof_indices

std::vector<dof_id_type> MooseVariableBase::_dof_indices
protectedinherited

◆ _dof_map

const DofMap& MooseVariableBase::_dof_map
protectedinherited

◆ _empty_boundary_ids

const std::set<BoundaryID> BlockRestrictable::_empty_boundary_ids
privateinherited

An empty set for referencing when boundary_ids is not included.

Definition at line 242 of file BlockRestrictable.h.

◆ _enabled

const bool& MooseObject::_enabled
protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _fe_type

FEType MooseVariableBase::_fe_type
protectedinherited

The FEType associated with this variable.

Definition at line 132 of file MooseVariableBase.h.

Referenced by MooseVariableBase::feType(), and MooseVariableBase::order().

◆ _index

unsigned int MooseVariableBase::_index
protectedinherited

variable number within MOOSE

Definition at line 138 of file MooseVariableBase.h.

◆ _mesh

MooseMesh& MooseVariableBase::_mesh
protectedinherited

mesh the variable is active in

Definition at line 159 of file MooseVariableBase.h.

◆ _name

const std::string& MooseObject::_name
protectedinherited

◆ _oi_moose_app

MooseApp& OutputInterface::_oi_moose_app
privateinherited

Reference the the MooseApp; neede for access to the OutputWarehouse.

Definition at line 70 of file OutputInterface.h.

◆ _oi_output_warehouse

OutputWarehouse& OutputInterface::_oi_output_warehouse
privateinherited

Reference to the OutputWarehouse for populating the Output object hide lists.

Definition at line 73 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList().

◆ _oi_outputs

std::set<OutputName> OutputInterface::_oi_outputs
privateinherited

The set of Output object names listed in the 'outputs' parameter.

Definition at line 76 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList(), and OutputInterface::getOutputs().

◆ _pars

const InputParameters& MooseObject::_pars
protectedinherited

◆ _scaling_factor

std::vector<Real> MooseVariableBase::_scaling_factor
protectedinherited

scaling factor for this variable

Definition at line 168 of file MooseVariableBase.h.

Referenced by MooseVariableBase::arrayScalingFactor(), and MooseVariableBase::scalingFactor().

◆ _subproblem

SubProblem& MooseVariableBase::_subproblem
protectedinherited

◆ _sys

SystemBase& MooseVariableBase::_sys
protectedinherited

◆ _tid

THREAD_ID MooseVariableBase::_tid
protectedinherited

Thread ID.

Definition at line 162 of file MooseVariableBase.h.

Referenced by MooseVariableFE< Real >::MooseVariableFE(), and MooseVariableScalar::reinit().

◆ _type

const std::string& MooseObject::_type
protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

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

◆ _var_kind

Moose::VarKindType MooseVariableBase::_var_kind
protectedinherited

Variable type (see MooseTypes.h)

Definition at line 141 of file MooseVariableBase.h.

Referenced by MooseVariableBase::kind().

◆ _var_name

std::string MooseVariableBase::_var_name
protectedinherited

Variable name.

Definition at line 171 of file MooseVariableBase.h.

Referenced by MooseVariableBase::MooseVariableBase(), and MooseVariableBase::name().

◆ _var_num

unsigned int MooseVariableBase::_var_num
protectedinherited

◆ _variable

const Variable& MooseVariableBase::_variable
protectedinherited

libMesh variable object for this variable

Definition at line 147 of file MooseVariableBase.h.


The documentation for this class was generated from the following files:
InputParameters::getParamHelper
static const T & getParamHelper(const std::string &name, const InputParameters &pars, const T *the_type)
Definition: InputParameters.h:1517
BlockRestrictable::_blk_mesh
MooseMesh * _blk_mesh
Pointer to Mesh.
Definition: BlockRestrictable.h:239
FEProblemBase::getMaterialWarehouse
const MaterialWarehouse & getMaterialWarehouse() const
Definition: FEProblemBase.h:1454
SubProblem::_var_dof_map
std::map< std::string, std::vector< dof_id_type > > _var_dof_map
Definition: SubProblem.h:586
OutputWarehouse::addInterfaceHideVariables
void addInterfaceHideVariables(const std::string &output_name, const std::set< std::string > &variable_names)
Insert variable names for hiding via the OutoutInterface.
Definition: OutputWarehouse.C:274
MooseObject::mooseInfo
void mooseInfo(Args &&... args) const
Definition: MooseObject.h:162
moose::internal::mooseStreamAll
void mooseStreamAll(std::ostringstream &ss)
All of the following are not meant to be called directly - they are called by the normal macros (moos...
Definition: MooseError.C:88
MooseObject::mooseError
void mooseError(Args &&... args) const
Definition: MooseObject.h:141
MooseObject::isParamValid
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition: MooseObject.h:100
MooseObject::_type
const std::string & _type
The type of this object (the Class name)
Definition: MooseObject.h:175
OutputWarehouse::getOutputNames
const std::set< OutputName > & getOutputNames()
Get a complete set of all output object names.
Definition: OutputWarehouse.C:123
MooseVariableFEBase::activeSubdomains
virtual const std::set< SubdomainID > & activeSubdomains() const =0
The subdomains the variable is active on.
MooseMesh::getSubdomainIDs
std::vector< SubdomainID > getSubdomainIDs(const std::vector< SubdomainName > &subdomain_name) const
Get the associated subdomainIDs for the subdomain names that are passed in.
Definition: MooseMesh.C:1133
BlockRestrictable::_blk_dual_restrictable
const bool _blk_dual_restrictable
Flag for allowing dual restriction.
Definition: BlockRestrictable.h:233
MooseVariableBase::MooseVariableBase
MooseVariableBase(const InputParameters &parameters)
Definition: MooseVariableBase.C:79
InputParameters::getMooseType
std::string getMooseType(const std::string &name) const
Utility functions for retrieving one of the MooseTypes variables into the common "string" base class.
Definition: InputParameters.C:529
BlockRestrictable::blockIDs
const virtual std::set< SubdomainID > & blockIDs() const
Return the block subdomain ids for this object.
Definition: BlockRestrictable.C:174
MooseVariableBase::_fe_type
FEType _fe_type
The FEType associated with this variable.
Definition: MooseVariableBase.h:132
MooseVariableBase::_dof_indices
std::vector< dof_id_type > _dof_indices
DOF indices.
Definition: MooseVariableBase.h:156
MaterialWarehouse
MaterialBase objects are special in that they have additional objects created automatically (see FEPr...
Definition: MaterialWarehouse.h:26
BlockRestrictable::blockRestricted
virtual bool blockRestricted() const
Returns true if this object has been restricted to a boundary.
Definition: BlockRestrictable.C:162
BlockRestrictable::_blk_material_data
std::shared_ptr< MaterialData > _blk_material_data
Pointer to the MaterialData class for this object.
Definition: BlockRestrictable.h:205
Moose::ANY_BLOCK_ID
const SubdomainID ANY_BLOCK_ID
Definition: MooseTypes.C:17
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
OutputInterface::_oi_output_warehouse
OutputWarehouse & _oi_output_warehouse
Reference to the OutputWarehouse for populating the Output object hide lists.
Definition: OutputInterface.h:73
MooseObject::_enabled
const bool & _enabled
Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.
Definition: MooseObject.h:181
BlockRestrictable::_blk_feproblem
FEProblemBase * _blk_feproblem
Pointer to FEProblemBase.
Definition: BlockRestrictable.h:236
moose::internal::mooseInfoStream
void mooseInfoStream(S &oss, Args &&... args)
Definition: MooseError.h:165
MooseVariableBase::_var_kind
Moose::VarKindType _var_kind
Variable type (see MooseTypes.h)
Definition: MooseVariableBase.h:141
Moose::stringify
std::string stringify(const T &t)
conversion to string
Definition: Conversion.h:61
MooseObject::paramError
void paramError(const std::string &param, Args... args) const
Emits an error prefixed with the file and line number of the given param (from the input file) along ...
Definition: MooseObject.h:215
ConsoleStreamInterface::_console
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
Definition: ConsoleStreamInterface.h:31
mooseError
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application.
Definition: MooseError.h:210
BlockRestrictable::_blk_tid
THREAD_ID _blk_tid
Thread id for this object.
Definition: BlockRestrictable.h:248
MooseVariableBase::_count
const unsigned int _count
Number of variables in the array.
Definition: MooseVariableBase.h:165
Moose::ANY_BOUNDARY_ID
const BoundaryID ANY_BOUNDARY_ID
Definition: MooseTypes.C:19
Moose::VAR_ANY
Definition: MooseTypes.h:610
moose::internal::mooseDeprecatedStream
void mooseDeprecatedStream(S &oss, bool expired, Args &&... args)
Definition: MooseError.h:177
SystemBase::subproblem
virtual SubProblem & subproblem()
Definition: SystemBase.h:108
FEProblemBase::getMaterialData
std::shared_ptr< MaterialData > getMaterialData(Moose::MaterialDataType type, THREAD_ID tid=0)
Definition: FEProblemBase.C:2729
paramErrorPrefix
std::string paramErrorPrefix(const InputParameters &params, const std::string &param)
Generates a canonical paramError prefix for param-related error/warning/info messages.
Definition: MooseObject.C:24
FEProblemBase::getCoordSystem
virtual Moose::CoordinateSystemType getCoordSystem(SubdomainID sid) override
Definition: FEProblemBase.C:491
MooseVariableBase::allDofIndices
const std::vector< dof_id_type > & allDofIndices() const
Get all global dofindices for the variable.
Definition: MooseVariableBase.C:111
MooseVariableBase::_var_num
unsigned int _var_num
variable number (from libMesh)
Definition: MooseVariableBase.h:135
BlockRestrictable::isBlockSubset
bool isBlockSubset(const std::set< SubdomainID > &ids) const
Test if the class block ids are a subset of the supplied objects.
Definition: BlockRestrictable.C:227
MooseVariableBase::_var_name
std::string _var_name
Variable name.
Definition: MooseVariableBase.h:171
InputParameters::isParamValid
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another,...
Definition: InputParameters.C:257
MooseObject::getParamTempl
const T & getParamTempl(const std::string &name) const
Retrieve a parameter for the object.
Definition: MooseObject.h:208
callMooseErrorRaw
void callMooseErrorRaw(std::string &msg, MooseApp *app)
Definition: MooseObject.C:70
MooseObjectWarehouseBase::getActiveBlockObjects
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
Definition: MooseObjectWarehouseBase.h:387
BlockRestrictable::_blocks
std::vector< SubdomainName > _blocks
Vector the block names supplied by the user via the input file.
Definition: BlockRestrictable.h:230
MooseVariableBase::_sys
SystemBase & _sys
System this variable is part of.
Definition: MooseVariableBase.h:129
MooseMesh::meshSubdomains
const std::set< SubdomainID > & meshSubdomains() const
Returns a read-only reference to the set of subdomains currently present in the Mesh.
Definition: MooseMesh.C:2338
MooseObjectWarehouseBase::hasActiveBlockObjects
bool hasActiveBlockObjects(THREAD_ID tid=0) const
Definition: MooseObjectWarehouseBase.h:422
MooseUtils::replaceAll
std::string replaceAll(std::string str, const std::string &from, const std::string &to)
Replaces all occurences of from in str with to and returns the result.
Definition: MooseUtils.C:45
MooseVariableBase::validParams
static InputParameters validParams()
Definition: MooseVariableBase.C:29
InputParameters::getCheckedPointerParam
T getCheckedPointerParam(const std::string &name, const std::string &error_string="") const
Verifies that the requested parameter exists and is not NULL and returns it to the caller.
Definition: InputParameters.h:1162
BlockRestrictable::hasBlocks
bool hasBlocks(const SubdomainName &name) const
Test if the supplied block name is valid for this object.
Definition: BlockRestrictable.C:186
BlockRestrictable::_blk_ids
std::set< SubdomainID > _blk_ids
Set of block ids supplied by the user via the input file (for error reporting)
Definition: BlockRestrictable.h:227
OutputInterface::_oi_outputs
std::set< OutputName > _oi_outputs
The set of Output object names listed in the 'outputs' parameter.
Definition: OutputInterface.h:76
MooseVariableBase::_scaling_factor
std::vector< Real > _scaling_factor
scaling factor for this variable
Definition: MooseVariableBase.h:168
Moose::show_trace
bool show_trace
Set to true (the default) to print the stack trace with error and warning messages - false to omit it...
Definition: Moose.C:572
BlockRestrictable::_blk_name
const std::string & _blk_name
Name of the object.
Definition: BlockRestrictable.h:251
Moose::VAR_FIELD_ANY
Definition: MooseTypes.h:619
BlockRestrictable::meshBlockIDs
const std::set< SubdomainID > & meshBlockIDs() const
Return all of the SubdomainIDs for the mesh.
Definition: BlockRestrictable.C:250
MooseObject::_pars
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:169
MooseVariableBase::isNodal
virtual bool isNodal() const
Is this variable nodal.
Definition: MooseVariableBase.h:104
moose::internal::mooseWarningStream
void mooseWarningStream(S &oss, Args &&... args)
Definition: MooseError.h:136
MooseVariableBase::_dof_map
const DofMap & _dof_map
DOF map.
Definition: MooseVariableBase.h:153
BlockRestrictable::_boundary_ids
const std::set< BoundaryID > & _boundary_ids
Reference to the boundary_ids, defaults to an empty set if not provided.
Definition: BlockRestrictable.h:245
BlockRestrictable::hasBlockMaterialPropertyHelper
virtual bool hasBlockMaterialPropertyHelper(const std::string &prop_name)
A helper method to allow the Material object to specialize the behavior of hasBlockMaterialProperty.
Definition: BlockRestrictable.C:256
MooseObject::_app
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:172
FEProblemBase::mesh
virtual MooseMesh & mesh() override
Definition: FEProblemBase.h:148
MooseObject::mooseWarning
void mooseWarning(Args &&... args) const
Definition: MooseObject.h:150
MooseObject::paramErrorMsg
std::string paramErrorMsg(const std::string &param, Args... args) const
Definition: MooseObject.h:185
MooseObject::name
virtual const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:70
Moose::BLOCK_MATERIAL_DATA
Definition: MooseTypes.h:585
MooseVariableBase::name
const std::string & name() const override
Get the variable name.
Definition: MooseVariableBase.h:63
n
PetscInt n
Definition: PetscDMMoose.C:1504