https://mooseframework.inl.gov: MooseVariableConstMonomial Class Reference

Referenced by FEProblemBase::addJacobianBlockTags(), Assembly::addJacobianNonlocal(), Assembly::cacheJacobianNonlocal(), NonlocalKernel::computeNonlocalJacobian(), NonlocalIntegratedBC::computeNonlocalJacobian(), NonlocalKernel::computeNonlocalOffDiagJacobian(), NonlocalIntegratedBC::computeNonlocalOffDiagJacobian(), Assembly::prepareNonlocal(), Assembly::prepareVariableNonlocal(), and MooseVariableBase::totalVarDofs().

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

◆ adSlnNeighbor()

const ADTemplateVariableValue<Real >& MooseVariableFE< Real >::adSlnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor AD

Implements MooseVariableField< Real >.

Definition at line 368 of file MooseVariableFE.h.

   {
     return _neighbor_data->adSln();
   }

◆ adUDot()

const ADTemplateVariableValue<Real >& MooseVariableFE< Real >::adUDot ( ) const

inlineoverridevirtualinherited

AD time derivative getter.

Implements MooseVariableField< Real >.

Definition at line 350 of file MooseVariableFE.h.

   {
     return _element_data->adUDot();
   }

◆ adUDotDot()

const ADTemplateVariableValue<Real >& MooseVariableFE< Real >::adUDotDot ( ) const

inlineoverridevirtualinherited

AD second time derivative getter.

Implements MooseVariableField< Real >.

Definition at line 354 of file MooseVariableFE.h.

   {
     return _element_data->adUDotDot();
   }

◆ adUDotDotNeighbor()

const ADTemplateVariableValue<Real >& MooseVariableFE< Real >::adUDotDotNeighbor ( ) const

inlineoverridevirtualinherited

AD neighbor second time derivative getter.

Implements MooseVariableField< Real >.

Definition at line 384 of file MooseVariableFE.h.

   {
     return _neighbor_data->adUDotDot();
   }

◆ adUDotNeighbor()

const ADTemplateVariableValue<Real >& MooseVariableFE< Real >::adUDotNeighbor ( ) const

inlineoverridevirtualinherited

AD neighbor time derivative getter.

Implements MooseVariableField< Real >.

Definition at line 380 of file MooseVariableFE.h.

   {
     return _neighbor_data->adUDot();
   }

◆ allDofIndices()

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

inherited

Get all global dofindices for the variable.

Definition at line 201 of file MooseVariableBase.C.

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

◆ arrayGradPhi()

const MappedArrayVariablePhiGradient& MooseVariableFE< Real >::arrayGradPhi ( ) const

inlineinherited

Definition at line 195 of file MooseVariableFE.h.

   {
     return _element_data->arrayGradPhi();
   }

◆ arrayGradPhiFace()

const MappedArrayVariablePhiGradient& MooseVariableFE< Real >::arrayGradPhiFace ( ) const

inlineinherited

Definition at line 208 of file MooseVariableFE.h.

   {
     return _element_data->arrayGradPhiFace();
   }

◆ arrayGradPhiFaceNeighbor()

const MappedArrayVariablePhiGradient& MooseVariableFE< Real >::arrayGradPhiFaceNeighbor ( ) const

inlineinherited

Definition at line 237 of file MooseVariableFE.h.

   {
     return _neighbor_data->arrayGradPhiFace();
   }

◆ arrayGradPhiNeighbor()

const MappedArrayVariablePhiGradient& MooseVariableFE< Real >::arrayGradPhiNeighbor ( ) const

inlineinherited

Definition at line 221 of file MooseVariableFE.h.

   {
     return _neighbor_data->arrayGradPhi();
   }

◆ arrayScalingFactor()

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

inlineinherited

Definition at line 99 of file MooseVariableBase.h.

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

99 { return _scaling_factor; }

MooseVariableBase::_scaling_factor

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition: MooseVariableBase.h:240

◆ arrayVariableComponent()

const std::string & MooseVariableBase::arrayVariableComponent ( const unsigned int i ) const

inherited

Returns the variable name of a component of an array variable.

Definition at line 192 of file MooseVariableBase.C.

Referenced by MooseVariableFieldBase::componentName(), AdvancedOutput::initAvailableLists(), and AdvancedOutput::initShowHideLists().

 {
   mooseAssert(
       i < _array_var_component_names.size(),
       "Requested array variable component number is greater than the number of component names.");
   return _array_var_component_names[i];
 }

◆ blockIDs()

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

virtualinherited

Return the block subdomain ids for this object Note, if this is not block restricted, this function returns all mesh subdomain ids.

Returns: a set of SubdomainIDs that are valid for this object

Definition at line 194 of file BlockRestrictable.C.

Referenced by FunctorMaterial::addFunctorProperty(), DiracKernelBase::addPoint(), DiracKernelBase::addPointWithValidId(), NodalPatchRecoveryAuxBase::blockRestrictElements(), ComboMarker::ComboMarker(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), ExtraIDIntegralVectorPostprocessor::ExtraIDIntegralVectorPostprocessor(), BlockRestrictable::getBlockCoordSystem(), MaterialBase::getGenericZeroMaterialPropertyByName(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), IndicatorMarker::IndicatorMarker(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), FunctorExtremaPositions::initialize(), MooseVariableBase::MooseVariableBase(), NodalPatchRecoveryAux::NodalPatchRecoveryAux(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), ProjectedMaterialPropertyNodalPatchRecoveryAux::ProjectedMaterialPropertyNodalPatchRecoveryAux(), ProjectionAux::ProjectionAux(), MaterialBase::registerPropName(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

 {
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
     return _blk_mesh->meshSubdomains();
   else
     return _blk_ids;
 }

◆ blockRestricted()

bool BlockRestrictable::blockRestricted ( ) const

virtualinherited

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

See also: MooseObject

Definition at line 182 of file BlockRestrictable.C.

Referenced by NodalPatchRecoveryAuxBase::blockRestrictElements(), BlockRestrictable::checkVariable(), SubdomainsDivision::divisionIndex(), ElementGroupCentroidPositions::ElementGroupCentroidPositions(), BlockRestrictable::getBlockCoordSystem(), FunctorIC::gradient(), BlockRestrictable::hasBlockMaterialPropertyHelper(), SubdomainsDivision::initialize(), ElementCentroidPositions::initialize(), QuadraturePointsPositions::initialize(), BlockRestrictable::initializeBlockRestrictable(), SolutionIC::initialSetup(), MooseVariableBase::MooseVariableBase(), FVPointValueConstraint::setMyElem(), and FunctorIC::value().

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

◆ 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 188 of file BlockRestrictable.C.

Referenced by MaterialOutputAction::getParams(), SubdomainsDivision::initialize(), and SolutionIC::initialSetup().

 {
   return _blocks;
 }

◆ blocksMaxDimension()

unsigned int BlockRestrictable::blocksMaxDimension ( ) const

inherited

Return the largest mesh dimension of the elements in the blocks for this object.

Definition at line 371 of file BlockRestrictable.C.

 {
   mooseAssert(_blk_dim != libMesh::invalid_uint, "Block restriction not initialized");
   return _blk_dim;
 }

◆ buildOutputHideVariableList()

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

inherited

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

Parameters

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

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

Definition at line 61 of file OutputInterface.C.

Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface::OutputInterface().

 {
   // Set of available names
   const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();
 
   // Check for 'none'; hide variables on all outputs
   if (_oi_outputs.find("none") != _oi_outputs.end())
     for (const auto & name : avail)
       _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
 
   // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
   // these cases
   else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
     return;
 
   // Limit the variable output to Output objects listed
   else
   {
     // Create a list of outputs where the variable should be hidden
     std::set<OutputName> hide;
     std::set_difference(avail.begin(),
                         avail.end(),
                         _oi_outputs.begin(),
                         _oi_outputs.end(),
                         std::inserter(hide, hide.begin()));
 
     // If 'outputs' is specified add the object name to the list of items to hide
     for (const auto & name : hide)
       _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
   }
 }

◆ callMooseError()

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix
	)		const

inherited

Calls moose error with the message msg.

Will prefix the message with the subapp name if one exists.

If with_prefix, then add the prefix from errorPrefix() to the error.

Definition at line 33 of file MooseBase.C.

Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().

 {
   _app.getOutputWarehouse().mooseConsole();
   const std::string prefix = _app.isUltimateMaster() ? "" : _app.name();
   if (with_prefix)
     msg = errorPrefix("error") + msg;
   moose::internal::mooseErrorRaw(msg, prefix);
 }

◆ checkFace()

template<typename T>

void Moose::FunctorBase< T >::checkFace ( const Moose::FaceArg & face ) const

inherited

Examines the incoming face argument.

If the face argument producer (residual object, postprocessor, etc.) did not indicate a sidedness to the face, e.g. if the face_side member of the FaceArg is nullptr, then we may "modify" the sidedness of the argument if we are only defined on one side of the face. If the face argument producer has indicated a sidedness and we are not defined on that side, then we will error

Parameters

face	The face argument created by the face argument producer, likely a residual object

Returns: A face with possibly changed sidedness depending on whether we aren't defined on both sides of the face

Definition at line 732 of file MooseFunctor.h.

 {
 #if DEBUG
   const Elem * const elem = face.face_side;
   const FaceInfo * const fi = face.fi;
   mooseAssert(fi, "face info should be non-null");
   bool check_elem_def = false;
   bool check_neighbor_def = false;
   // We check if the functor is defined on both sides of the face
   if (!elem)
   {
     if (!hasFaceSide(*fi, true))
       check_neighbor_def = true;
     else if (!hasFaceSide(*fi, false))
       check_elem_def = true;
   }
   else if (elem == fi->elemPtr())
     check_elem_def = true;
   else
   {
     mooseAssert(elem == fi->neighborPtr(), "This has to match something");
     check_neighbor_def = true;
   }
 
   if (check_elem_def && !hasFaceSide(*fi, true))
   {
     std::string additional_message = "It is not defined on the neighbor side either.";
     if (hasFaceSide(*fi, false))
       additional_message = "It is however defined on the neighbor side.";
     additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
     mooseError(_functor_name,
                " is not defined on the element side of the face information, but a face argument "
                "producer "
                "(e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
                additional_message);
   }
   if (check_neighbor_def && !hasFaceSide(*fi, false))
   {
     std::string additional_message = "It is not defined on the element side either.";
     if (hasFaceSide(*fi, true))
       additional_message = "It is however defined on the element side.";
     additional_message += " Face centroid: " + Moose::stringify(fi->faceCentroid());
     mooseError(
         _functor_name,
         " is not defined on the neighbor side of the face information, but a face argument "
         "producer (e.g. residual object, postprocessor, etc.) has requested evaluation there.\n",
         additional_message);
   }
 #endif
 }

◆ checkVariable()

void BlockRestrictable::checkVariable ( const MooseVariableFieldBase & variable ) const

virtualinherited

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

Parameters

variable The variable to check against.

Reimplemented in DomainUserObject.

Definition at line 343 of file BlockRestrictable.C.

Referenced by DomainUserObject::checkVariable().

 {
   // a variable defined on all internal sides does not need this check because
   // it can be coupled with other variables in DG kernels
   if (!_blk_mesh->interiorLowerDBlocks().empty() &&
       variable.activeOnSubdomains(_blk_mesh->interiorLowerDBlocks()))
     return;
 
   if (!isBlockSubset(variable.activeSubdomains()))
   {
     std::string var_ids = Moose::stringify(variable.activeSubdomains(), ", ");
     std::string obj_ids = Moose::stringify(blockRestricted() ? _blk_ids : meshBlockIDs(), ", ");
     mooseError("The 'block' parameter of the object '",
                _blk_name,
                "' must be a subset of the 'block' parameter of the variable '",
                variable.name(),
                "':\n    Object '",
                _blk_name,
                "': ",
                obj_ids,
                "\n    Variable '",
                variable.name(),
                "': ",
                var_ids);
   }
 }

◆ clearAllDofIndices()

void MooseVariableFE< Real >::clearAllDofIndices ( )

finalvirtualinherited

Reimplemented from MooseVariableBase.

Definition at line 854 of file MooseVariableFE.C.

 {
   _element_data->clearDofIndices();
   _neighbor_data->clearDofIndices();
   _lower_data->clearDofIndices();
 }

◆ clearDofIndices()

void MooseVariableFE< Real >::clearDofIndices ( )

overridevirtualinherited

Clear out the dof indices.

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

Implements MooseVariableFieldBase.

Definition at line 87 of file MooseVariableFE.C.

 {
   _element_data->clearDofIndices();
 }

◆ 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 219 of file MooseVariableBase.C.

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

 {
   std::vector<dof_id_type> new_dof_indices(dof_indices);
   if (component != 0)
   {
     if (isNodal())
       for (auto & id : new_dof_indices)
         id += component;
     else
     {
       unsigned int n = dof_indices.size();
       for (auto & id : new_dof_indices)
         id += component * n;
     }
   }
   return new_dof_indices;
 }

◆ componentName()

const std::string & MooseVariableFieldBase::componentName ( const unsigned int comp ) const

inherited

Get the variable name of a component in libMesh.

Definition at line 27 of file MooseVariableFieldBase.C.

 {
   if (comp >= _count)
     mooseError("Component index must be less than the number of components of variable ",
                _var_name);
   if (isArray())
     return this->arrayVariableComponent(comp);
   else
     return _var_name;
 }

◆ computeElemValues()

void MooseVariableConstMonomial::computeElemValues ( )

overridevirtual

Actually compute variable values from the solution vectors.

Reimplemented from MooseVariableFE< Real >.

Definition at line 42 of file MooseVariableConstMonomial.C.

 {
   _element_data->setGeometry(Moose::Volume);
   _element_data->computeMonomialValues();
 }

◆ computeElemValuesFace()

void MooseVariableConstMonomial::computeElemValuesFace ( )

overridevirtual

Compute values at facial quadrature points.

Reimplemented from MooseVariableFE< Real >.

Definition at line 49 of file MooseVariableConstMonomial.C.

 {
   _element_data->setGeometry(Moose::Face);
   _element_data->computeMonomialValues();
 }

◆ computeFaceValues()

virtual void MooseVariableFieldBase::computeFaceValues ( const FaceInfo & )

inlinevirtualinherited

Compute values at face quadrature points for the element+neighbor (both sides of the face).

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 131 of file MooseVariableFieldBase.h.

131 { mooseError("not implemented"); }

MooseBaseErrorInterface::mooseError

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

Emits an error prefixed with object name and type.

Definition: MooseBaseErrorInterface.h:29

◆ computeIncrementAtNode()

void MooseVariableFE< Real >::computeIncrementAtNode ( const libMesh::NumericVector< libMesh::Number > & increment_vec )

inherited

Compute and store incremental change at the current node based on increment_vec.

Definition at line 446 of file MooseVariableFE.C.

 {
   _element_data->computeIncrementAtNode(increment_vec);
 }

◆ computeIncrementAtQps()

void MooseVariableFE< Real >::computeIncrementAtQps ( const libMesh::NumericVector< libMesh::Number > & increment_vec )

inherited

Compute and store incremental change in solution at QPs based on increment_vec.

Definition at line 439 of file MooseVariableFE.C.

 {
   _element_data->computeIncrementAtQps(increment_vec);
 }

◆ computeLowerDValues()

void MooseVariableFE< Real >::computeLowerDValues ( )

overridevirtualinherited

compute values at quadrature points on the lower dimensional element

Implements MooseVariableFieldBase.

Definition at line 431 of file MooseVariableFE.C.

 {
   _lower_data->setGeometry(Moose::Volume);
   _lower_data->computeValues();
 }

◆ computeNeighborValues()

void MooseVariableConstMonomial::computeNeighborValues ( )

overridevirtual

Compute values at quadrature points for the neighbor.

Reimplemented from MooseVariableFE< Real >.

Definition at line 56 of file MooseVariableConstMonomial.C.

 {
   _neighbor_data->setGeometry(Moose::Volume);
   _neighbor_data->computeMonomialValues();
 }

◆ computeNeighborValuesFace()

void MooseVariableConstMonomial::computeNeighborValuesFace ( )

overridevirtual

Compute values at facial quadrature points for the neighbor.

Reimplemented from MooseVariableFE< Real >.

Definition at line 63 of file MooseVariableConstMonomial.C.

 {
   _neighbor_data->setGeometry(Moose::Face);
   _neighbor_data->computeMonomialValues();
 }

◆ computeNodalNeighborValues()

void MooseVariableFE< Real >::computeNodalNeighborValues ( )

overridevirtualinherited

Compute nodal values of this variable in the neighbor.

Implements MooseVariableFieldBase.

Definition at line 674 of file MooseVariableFE.C.

 {
   _neighbor_data->computeNodalValues();
 }

◆ computeNodalValues()

void MooseVariableFE< Real >::computeNodalValues ( )

overridevirtualinherited

Compute nodal values of this variable.

Implements MooseVariableFieldBase.

Definition at line 667 of file MooseVariableFE.C.

 {
   _element_data->computeNodalValues();
 }

◆ computeSolution()

void MooseVariableFE< Real >::computeSolution	(	const Elem *const	elem,
		const unsigned int	n_qp,
		const StateArg &	state,
		const Shapes &	phi,
		Solution &	local_soln,
		const GradShapes &	grad_phi,
		GradSolution &	grad_local_soln,
		Solution &	dot_local_soln,
		GradSolution &	grad_dot_local_soln
	)		const

inherited

Definition at line 914 of file MooseVariableFE.C.

 {
   std::vector<dof_id_type> dof_indices;
   this->_dof_map.dof_indices(elem, dof_indices, _var_num);
   std::vector<ADReal> dof_values;
   std::vector<ADReal> dof_values_dot;
   dof_values.reserve(dof_indices.size());
 
   const bool computing_dot = _time_integrator && _time_integrator->dt();
   if (computing_dot)
     dof_values_dot.reserve(dof_indices.size());
 
   const bool do_derivatives = Moose::doDerivatives(_subproblem, _sys);
   const auto & global_soln = getSolution(state);
   for (const auto dof_index : dof_indices)
   {
     dof_values.push_back(ADReal(global_soln(dof_index)));
     if (do_derivatives && state.state == 0)
       Moose::derivInsert(dof_values.back().derivatives(), dof_index, 1.);
     if (computing_dot)
     {
       if (_var_kind == Moose::VAR_SOLVER)
       {
         dof_values_dot.push_back(dof_values.back());
         _time_integrator->computeADTimeDerivatives(
             dof_values_dot.back(), dof_index, _ad_real_dummy);
       }
       else
         dof_values_dot.push_back((*this->_sys.solutionUDot())(dof_index));
     }
   }
 
   local_soln.resize(n_qp);
   grad_local_soln.resize(n_qp);
   if (computing_dot)
   {
     dot_local_soln.resize(n_qp);
     grad_dot_local_soln.resize(n_qp);
   }
 
   for (const auto qp : make_range(n_qp))
   {
     local_soln[qp] = 0;
     grad_local_soln[qp] = 0;
     if (computing_dot)
     {
       dot_local_soln[qp] = 0;
       grad_dot_local_soln[qp] = GradientType{};
     }
     for (const auto i : index_range(dof_indices))
     {
       local_soln[qp] += dof_values[i] * phi[i][qp];
       grad_local_soln[qp] += dof_values[i] * grad_phi[i][qp];
       if (computing_dot)
       {
         dot_local_soln[qp] += dof_values_dot[i] * phi[i][qp];
         grad_dot_local_soln[qp] += dof_values_dot[i] * grad_phi[i][qp];
       }
     }
   }
 }

◆ computingCurl()

bool MooseVariableFE< Real >::computingCurl ( ) const

finaloverridevirtualinherited

Whether or not this variable is computing the curl.

Implements MooseVariableField< Real >.

Definition at line 815 of file MooseVariableFE.C.

 {
   return _element_data->computingCurl();
 }

◆ computingDiv()

bool MooseVariableFE< Real >::computingDiv ( ) const

finaloverridevirtualinherited

Whether or not this variable is computing the divergence.

Implements MooseVariableField< Real >.

Definition at line 822 of file MooseVariableFE.C.

 {
   return _element_data->computingDiv();
 }

◆ computingSecond()

bool MooseVariableFE< Real >::computingSecond ( ) const

inlinefinaloverridevirtualinherited

Whether or not this variable is computing any second derivatives.

Implements MooseVariableField< Real >.

Definition at line 135 of file MooseVariableFE.h.

135 { return usesSecondPhi(); }

MooseVariableFE< Real >::usesSecondPhi

bool usesSecondPhi() const

Whether or not this variable is computing any second derivatives.

Definition: MooseVariableFE.C:801

◆ connectControllableParams()

void MooseBaseParameterInterface::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 33 of file MooseBaseParameterInterface.C.

 {
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = _factory.getValidParams(object_type).get<std::string>("_moose_base");
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
       primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ 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 111 of file MooseVariableBase.h.

Referenced by Assembly::addJacobianBlock(), EigenProblem::adjustEigenVector(), ArrayBodyForce::ArrayBodyForce(), ArrayConstantIC::ArrayConstantIC(), ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayFunctionIC::ArrayFunctionIC(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), ArrayParsedAux::ArrayParsedAux(), ArrayVarReductionAux::ArrayVarReductionAux(), BuildArrayVariableAux::BuildArrayVariableAux(), Assembly::cacheJacobianBlockNonzero(), TagAuxBase< AuxKernel >::checkCoupledVariable(), BuildArrayVariableAux::compute(), ArrayNodalBC::computeJacobian(), ArrayHFEMDirichletBC::computeLowerDQpOffDiagJacobian(), ArrayLowerDIntegratedBC::computeLowerDQpOffDiagJacobian(), ArrayDGLowerDKernel::computeLowerDQpOffDiagJacobian(), ArrayNodalBC::computeOffDiagJacobian(), ArrayTimeDerivative::computeQpJacobian(), ArrayReaction::computeQpJacobian(), ArrayDiffusion::computeQpJacobian(), ArrayCoupledTimeDerivative::computeQpJacobian(), EigenArrayDirichletBC::computeQpJacobian(), ArrayIntegratedBC::computeQpJacobian(), ArrayKernel::computeQpJacobian(), ArrayNodalBC::computeQpJacobian(), ArrayCoupledTimeDerivative::computeQpOffDiagJacobian(), EigenArrayDirichletBC::computeQpOffDiagJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobian(), ArrayKernel::computeQpOffDiagJacobian(), ArrayNodalBC::computeQpOffDiagJacobian(), ArrayDGKernel::computeQpOffDiagJacobian(), Kernel::computeQpOffDiagJacobianArray(), ArrayIntegratedBC::computeQpOffDiagJacobianScalar(), ArrayKernel::computeQpOffDiagJacobianScalar(), ArrayTimeDerivative::computeQpResidual(), ArrayReaction::computeQpResidual(), ArrayCoupledTimeDerivative::computeQpResidual(), FunctionArrayAux::computeValue(), ArrayParsedAux::computeValue(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), FunctionArrayAux::FunctionArrayAux(), ArrayFunctionIC::gradient(), AdvancedOutput::initAvailableLists(), MultiAppVariableValueSamplePostprocessorTransfer::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), ArrayDiffusion::initQpResidual(), AdvancedOutput::initShowHideLists(), Assembly::prepareJacobianBlock(), Assembly::prepareLowerD(), Assembly::prepareNeighbor(), Assembly::prepareNonlocal(), Assembly::prepareVariable(), Assembly::prepareVariableNonlocal(), MultiAppDofCopyTransfer::transfer(), MultiAppDofCopyTransfer::transferDofObject(), and ArrayFunctionIC::value().

111 { return _count; }

MooseVariableBase::_count

const unsigned int _count

Number of variables in the array.

Definition: MooseVariableBase.h:237

◆ curlPhi()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhi ( ) const

finaloverridevirtualinherited

Curl of the shape functions.

Implements MooseVariableField< Real >.

Definition at line 724 of file MooseVariableFE.C.

 {
   return _element_data->curlPhi();
 }

◆ curlPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiFace ( ) const

inherited

Definition at line 745 of file MooseVariableFE.C.

 {
   return _element_data->curlPhiFace();
 }

◆ curlPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiFaceNeighbor ( ) const

inherited

Definition at line 787 of file MooseVariableFE.C.

 {
   return _neighbor_data->curlPhiFace();
 }

◆ curlPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiCurl & MooseVariableFE< Real >::curlPhiNeighbor ( ) const

inherited

Definition at line 766 of file MooseVariableFE.C.

 {
   return _neighbor_data->curlPhi();
 }

◆ curlSln()

const FieldVariableCurl& MooseVariableFE< Real >::curlSln ( ) const

inlineinherited

element curls

Definition at line 324 of file MooseVariableFE.h.

324 { return _element_data->curlSln(Moose::Current); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Definition: MooseTypes.h:235

◆ curlSlnNeighbor()

const FieldVariableCurl& MooseVariableFE< Real >::curlSlnNeighbor ( ) const

inlineinherited

neighbor solution curls

Definition at line 464 of file MooseVariableFE.h.

   {
     return _neighbor_data->curlSln(Moose::Current);
   }

◆ curlSlnOld()

const FieldVariableCurl& MooseVariableFE< Real >::curlSlnOld ( ) const

inlineinherited

Definition at line 325 of file MooseVariableFE.h.

325 { return _element_data->curlSln(Moose::Old); }

Definition: MooseTypes.h:236

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ curlSlnOlder()

const FieldVariableCurl& MooseVariableFE< Real >::curlSlnOlder ( ) const

inlineinherited

Definition at line 326 of file MooseVariableFE.h.

326 { return _element_data->curlSln(Moose::Older); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Moose::Older

Definition: MooseTypes.h:237

◆ curlSlnOlderNeighbor()

const FieldVariableCurl& MooseVariableFE< Real >::curlSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 472 of file MooseVariableFE.h.

   {
     return _neighbor_data->curlSln(Moose::Older);
   }

◆ curlSlnOldNeighbor()

const FieldVariableCurl& MooseVariableFE< Real >::curlSlnOldNeighbor ( ) const

inlineinherited

Definition at line 468 of file MooseVariableFE.h.

   {
     return _neighbor_data->curlSln(Moose::Old);
   }

◆ currentElem()

const Elem* const& MooseVariableFE< Real >::currentElem ( ) const

inlineoverridevirtualinherited

Current element this variable is evaluated at.

Implements MooseVariableFieldBase.

Definition at line 161 of file MooseVariableFE.h.

161 { return _element_data->currentElem(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ currentSide()

const unsigned int& MooseVariableFE< Real >::currentSide ( ) const

inlineinherited

Current side this variable is being evaluated on.

Definition at line 166 of file MooseVariableFE.h.

166 { return _element_data->currentSide(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ customSetup() [1/2]

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ customSetup() [2/2]

template<typename T >

void Moose::FunctorBase< T >::customSetup ( const ExecFlagType & exec_type )

overridevirtualinherited

Implements Moose::FunctorAbstract.

Reimplemented in Function.

Definition at line 839 of file MooseFunctor.h.

 {
   if (_clearance_schedule.count(exec_type))
     clearCacheData();
 }

◆ divPhi()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhi ( ) const

finaloverridevirtualinherited

Divergence of the shape functions.

Implements MooseVariableField< Real >.

Definition at line 731 of file MooseVariableFE.C.

 {
   return _element_data->divPhi();
 }

◆ divPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiFace ( ) const

inherited

Definition at line 752 of file MooseVariableFE.C.

 {
   return _element_data->divPhiFace();
 }

◆ divPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiFaceNeighbor ( ) const

inherited

Definition at line 794 of file MooseVariableFE.C.

 {
   return _neighbor_data->divPhiFace();
 }

◆ divPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiDivergence & MooseVariableFE< Real >::divPhiNeighbor ( ) const

inherited

Definition at line 773 of file MooseVariableFE.C.

 {
   return _neighbor_data->divPhi();
 }

◆ divSln()

const FieldVariableDivergence& MooseVariableFE< Real >::divSln ( ) const

inlineinherited

element divergence

Definition at line 329 of file MooseVariableFE.h.

329 { return _element_data->divSln(Moose::Current); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Definition: MooseTypes.h:235

◆ divSlnNeighbor()

const FieldVariableDivergence& MooseVariableFE< Real >::divSlnNeighbor ( ) const

inlineinherited

neighbor solution divergence

Definition at line 478 of file MooseVariableFE.h.

   {
     return _neighbor_data->divSln(Moose::Current);
   }

◆ divSlnOld()

const FieldVariableDivergence& MooseVariableFE< Real >::divSlnOld ( ) const

inlineinherited

Definition at line 330 of file MooseVariableFE.h.

330 { return _element_data->divSln(Moose::Old); }

Definition: MooseTypes.h:236

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ divSlnOlder()

const FieldVariableDivergence& MooseVariableFE< Real >::divSlnOlder ( ) const

inlineinherited

Definition at line 331 of file MooseVariableFE.h.

   {
     return _element_data->divSln(Moose::Older);
   }

◆ divSlnOlderNeighbor()

const FieldVariableDivergence& MooseVariableFE< Real >::divSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 486 of file MooseVariableFE.h.

   {
     return _neighbor_data->divSln(Moose::Older);
   }

◆ divSlnOldNeighbor()

const FieldVariableDivergence& MooseVariableFE< Real >::divSlnOldNeighbor ( ) const

inlineinherited

Definition at line 482 of file MooseVariableFE.h.

   {
     return _neighbor_data->divSln(Moose::Old);
   }

◆ doDerivatives()

bool MooseVariableBase::doDerivatives ( ) const

protectedinherited

Returns: whether we should insert derivatives

◆ dofIndices()

const std::vector<dof_id_type>& MooseVariableFE< Real >::dofIndices ( ) const

inlinefinalvirtualinherited

Get local DoF indices.

Reimplemented from MooseVariableBase.

Definition at line 175 of file MooseVariableFE.h.

175 { return _element_data->dofIndices(); }

MooseVariableBase::_dof_map

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ dofIndicesLower()

const std::vector<dof_id_type>& MooseVariableFE< Real >::dofIndicesLower ( ) const

inlinefinalvirtualinherited

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

Returns: the lower dimensional element's dofs

Implements MooseVariableFieldBase.

Definition at line 181 of file MooseVariableFE.h.

   {
     return _lower_data->dofIndices();
   }

◆ dofIndicesNeighbor()

const std::vector<dof_id_type>& MooseVariableFE< Real >::dofIndicesNeighbor ( ) const

inlinefinalvirtualinherited

Get neighbor DOF indices for currently selected element.

Returns: the neighbor degree of freedom indices

Implements MooseVariableFieldBase.

Definition at line 177 of file MooseVariableFE.h.

   {
     return _neighbor_data->dofIndices();
   }

◆ dofMap()

const libMesh::DofMap& MooseVariableBase::dofMap ( ) const

inlineinherited

The DofMap associated with the system this variable is in.

Definition at line 136 of file MooseVariableBase.h.

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

136 { return _dof_map; }

const libMesh::DofMap & _dof_map

DOF map.

Definition: MooseVariableBase.h:225

◆ dofValue()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValue ( ) const

inherited

Definition at line 244 of file MooseVariableFE.C.

 {
   mooseDeprecated("Use dofValues instead of dofValue");
   return dofValues();
 }

◆ dofValues()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValues ( ) const

overridevirtualinherited

dof values getters

Implements MooseVariableField< Real >.

Definition at line 252 of file MooseVariableFE.C.

 {
   return _element_data->dofValues();
 }

◆ dofValuesDot()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDot ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 308 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDot();
 }

◆ dofValuesDotDot()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotDot ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 315 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDotDot();
 }

◆ dofValuesDotDotNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotDotNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 343 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDotDot();
 }

◆ dofValuesDotDotNeighborResidual()

const DoFValue& MooseVariableFE< Real >::dofValuesDotDotNeighborResidual ( ) const

inherited

◆ dofValuesDotDotOld()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotDotOld ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 329 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDotDotOld();
 }

◆ dofValuesDotDotOldNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotDotOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 357 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDotDotOld();
 }

◆ dofValuesDotNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 336 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDot();
 }

◆ dofValuesDotNeighborResidual()

const DoFValue& MooseVariableFE< Real >::dofValuesDotNeighborResidual ( ) const

inherited

◆ dofValuesDotOld()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotOld ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 322 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDotOld();
 }

◆ dofValuesDotOldNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesDotOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 350 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDotOld();
 }

◆ dofValuesDuDotDotDu()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDotDu ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 371 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDuDotDotDu();
 }

◆ dofValuesDuDotDotDuNeighbor()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDotDuNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 385 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDuDotDotDu();
 }

◆ dofValuesDuDotDu()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDu ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 364 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesDuDotDu();
 }

◆ dofValuesDuDotDuNeighbor()

const MooseArray< Number > & MooseVariableFE< Real >::dofValuesDuDotDuNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 378 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesDuDotDu();
 }

◆ dofValuesNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 280 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValues();
 }

◆ dofValuesOld()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesOld ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 259 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesOld();
 }

◆ dofValuesOlder()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesOlder ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 266 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesOlder();
 }

◆ dofValuesOlderNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesOlderNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 294 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesOlder();
 }

◆ dofValuesOldNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesOldNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 287 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesOld();
 }

◆ dofValuesPreviousNL()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesPreviousNL ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 273 of file MooseVariableFE.C.

 {
   return _element_data->dofValuesPreviousNL();
 }

◆ dofValuesPreviousNLNeighbor()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::dofValuesPreviousNLNeighbor ( ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 301 of file MooseVariableFE.C.

 {
   return _neighbor_data->dofValuesPreviousNL();
 }

◆ dot() [1/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 890 of file MooseFunctor.h.

Referenced by FVFunctorTimeKernel::computeQpResidual(), and Moose::ADWrapperFunctor< T >::evaluateDot().

 {
   return evaluateDot(elem, state);
 }

◆ dot() [2/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 897 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateDot(face, state);
 }

◆ dot() [3/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 905 of file MooseFunctor.h.

 {
   return evaluateDot(elem_qp, state);
 }

◆ dot() [4/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 912 of file MooseFunctor.h.

 {
   return evaluateDot(elem_side_qp, state);
 }

◆ dot() [5/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 919 of file MooseFunctor.h.

 {
   return evaluateDot(elem_point, state);
 }

◆ dot() [6/6]

template<typename T >

FunctorBase< T >::DotType Moose::FunctorBase< T >::dot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 926 of file MooseFunctor.h.

 {
   return evaluateDot(node, state);
 }

◆ duDotDotDu()

const VariableValue& MooseVariableFE< Real >::duDotDotDu ( ) const

inlineinherited

Definition at line 403 of file MooseVariableFE.h.

403 { return _element_data->duDotDotDu(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ duDotDotDuNeighbor()

const VariableValue& MooseVariableFE< Real >::duDotDotDuNeighbor ( ) const

inlineinherited

Definition at line 497 of file MooseVariableFE.h.

497 { return _neighbor_data->duDotDotDu(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ duDotDu()

const VariableValue& MooseVariableFE< Real >::duDotDu ( ) const

inlineinherited

Definition at line 402 of file MooseVariableFE.h.

402 { return _element_data->duDotDu(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ duDotDuNeighbor()

const VariableValue& MooseVariableFE< Real >::duDotDuNeighbor ( ) const

inlineinherited

Definition at line 496 of file MooseVariableFE.h.

496 { return _neighbor_data->duDotDu(); }

MooseVariableBase::_is_eigen

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ eigen() [1/2]

bool MooseVariableBase::eigen ( ) const

inlineinherited

Whether or not this variable operates on an eigen kernel.

Definition at line 163 of file MooseVariableBase.h.

Referenced by EigenProblem::adjustEigenVector().

163 { return _is_eigen; }

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:210

◆ eigen() [2/2]

void MooseVariableBase::eigen ( bool eigen )

inlineinherited

Mark this variable as an eigen var or non-eigen var.

Definition at line 168 of file MooseVariableBase.h.

Referenced by MooseVariableBase::eigen().

168 { _is_eigen = eigen; }

MooseVariableBase::eigen

bool eigen() const

Whether or not this variable operates on an eigen kernel.

Definition: MooseVariableBase.h:163

MooseVariableBase::_is_eigen

bool _is_eigen

Whether or not this variable operates on eigen kernels.

Definition: MooseVariableBase.h:210

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 40 of file MooseObject.h.

Referenced by EigenKernel::enabled().

40 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:51

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & error_type ) const

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ evaluate() [1/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1036 of file MooseVariableFE.C.

 {
   evaluateOnElement(elem_qp, state, /*query_cache=*/true);
   const auto qp = elem_qp.qp;
   mooseAssert(qp < _current_elem_qp_functor_sln.size(),
               "The requested " << qp << " is outside our solution size");
   return _current_elem_qp_functor_sln[qp];
 }

◆ evaluate() [2/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1256 of file MooseVariableFE.C.

 {
   evaluateOnElementSide(elem_side_qp, state, true);
   const auto qp = elem_side_qp.qp;
   mooseAssert(qp < _current_elem_side_qp_functor_sln.size(),
               "The requested " << qp << " is outside our solution size");
   return _current_elem_side_qp_functor_sln[qp];
 }

◆ evaluate() [3/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Implements Moose::FunctorBase< T >.

Definition at line 1047 of file MooseVariableFE.C.

 {
   const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
   // We can use whatever we want for the point argument since it won't be used
   const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
   evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
   return _current_elem_qp_functor_sln[0];
 }

◆ evaluate() [4/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const ElemPointArg &	elem_point_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor with a given element and point.

Some example implementations of this method could perform a two-term Taylor expansion using cell-centered value and gradient

Implements Moose::FunctorBase< T >.

Definition at line 1110 of file MooseVariableFE.C.

 {
   mooseAssert(elem_point_arg.elem, "We need an Elem");
   const Elem & elem = *elem_point_arg.elem;
   const auto dim = elem.dim();
   ArbitraryQuadrature qrule(dim);
   const std::vector<Point> ref_point = {FEMap::inverse_map(dim, &elem, elem_point_arg.point)};
   qrule.setPoints(ref_point);
   // We can use whatever we want for the point argument since it won't be used
   const ElemQpArg elem_qp_arg{elem_point_arg.elem, /*qp=*/0, &qrule, elem_point_arg.point};
   evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
   return _current_elem_qp_functor_sln[0];
 }

◆ evaluate() [5/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const NodeArg &	node_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Implements Moose::FunctorBase< T >.

Definition at line 863 of file MooseVariableFE.C.

 {
   mooseAssert(node_arg.node, "Must have a node");
   const Node & node = *node_arg.node;
   mooseAssert(node.n_dofs(this->_sys.number(), this->number()),
               "Our variable must have dofs on the requested node");
   const auto & soln = this->getSolution(state);
   if constexpr (std::is_same<OutputType, Real>::value)
   {
     const auto dof_number = node.dof_number(this->_sys.number(), this->number(), 0);
     ValueType ret = soln(dof_number);
     if (Moose::doDerivatives(_subproblem, _sys))
       Moose::derivInsert(ret.derivatives(), dof_number, 1);
     return ret;
   }
   else if constexpr (std::is_same<OutputType, RealVectorValue>::value)
   {
     ValueType ret;
     const auto do_derivatives = Moose::doDerivatives(_subproblem, _sys);
     for (const auto d : make_range(this->_mesh.dimension()))
     {
       const auto dof_number = node.dof_number(this->_sys.number(), this->number(), d);
       auto & component = ret(d);
       component = soln(dof_number);
       if (do_derivatives)
         Moose::derivInsert(component.derivatives(), dof_number, 1);
     }
     return ret;
   }
   else
     mooseError("RealEigenVector not yet supported for functors");
 }

◆ evaluate() [6/6]

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::evaluate	(	const FaceArg &	face_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor evaluated at the requested state and space

Implements Moose::FunctorBase< T >.

Definition at line 1103 of file MooseVariableFE.C.

 {
   return faceEvaluate(face_arg, state, _current_elem_side_qp_functor_sln);
 }

◆ evaluateDot() [1/6]

template<typename T>

virtual DotType Moose::FunctorBase< T >::evaluateDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor time derivative with a given element and point.

Definition at line 425 of file MooseFunctor.h.

   {
     mooseError("Element-point time derivative not implemented for functor " + functorName());
   }

◆ evaluateDot() [2/6]

template<typename T>

virtual DotType Moose::FunctorBase< T >::evaluateDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 430 of file MooseFunctor.h.

   {
     mooseError("Time derivative at node not implemented for functor " + functorName());
   }

◆ evaluateDot() [3/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1151 of file MooseVariableFE.C.

 {
   mooseAssert(_time_integrator,
               "A time derivative is being requested but we do not have a time integrator so we'll "
               "have no idea how to compute it");
   mooseAssert(_time_integrator->dt(),
               "A time derivative is being requested but the time integrator wants to perform a 0s "
               "time step");
   evaluateOnElement(elem_qp, state, /*query_cache=*/true);
   const auto qp = elem_qp.qp;
   mooseAssert(qp < _current_elem_qp_functor_dot.size(),
               "The requested " << qp << " is outside our dot size");
   return _current_elem_qp_functor_dot[qp];
 }

◆ evaluateDot() [4/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1280 of file MooseVariableFE.C.

 {
   mooseAssert(_time_integrator && _time_integrator->dt(),
               "A time derivative is being requested but we do not have a time integrator so we'll "
               "have no idea how to compute it");
   evaluateOnElementSide(elem_side_qp, state, true);
   const auto qp = elem_side_qp.qp;
   mooseAssert(qp < _current_elem_side_qp_functor_dot.size(),
               "The requested " << qp << " is outside our dot size");
   return _current_elem_side_qp_functor_dot[qp];
 }

◆ evaluateDot() [5/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor time derivative with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1168 of file MooseVariableFE.C.

 {
   mooseAssert(_time_integrator,
               "A time derivative is being requested but we do not have a time integrator so we'll "
               "have no idea how to compute it");
   mooseAssert(_time_integrator->dt(),
               "A time derivative is being requested but the time integrator wants to perform a 0s "
               "time step");
   const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
   // We can use whatever we want for the point argument since it won't be used
   const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
   evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
   return _current_elem_qp_functor_dot[0];
 }

◆ evaluateDot() [6/6]

MooseVariableFE< Real >::DotType MooseVariableFE< Real >::evaluateDot	(	const FaceArg &	face_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor time derivative evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1295 of file MooseVariableFE.C.

 {
   mooseAssert(_time_integrator && _time_integrator->dt(),
               "A time derivative is being requested but we do not have a time integrator so we'll "
               "have no idea how to compute it");
   return faceEvaluate(face_arg, state, _current_elem_side_qp_functor_dot);
 }

◆ evaluateGradDot() [1/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 449 of file MooseFunctor.h.

   {
     mooseError("Face gradient-dot not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [2/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const ElemQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 459 of file MooseFunctor.h.

   {
     mooseError("Element quadrature point gradient-dot not implemented for functor " +
                functorName());
   }

◆ evaluateGradDot() [3/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const ElemSideQpArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient-dot evaluated at the requested state and space

Definition at line 470 of file MooseFunctor.h.

   {
     mooseError("Element side quadrature point gradient-dot not implemented for functor " +
                functorName());
   }

◆ evaluateGradDot() [4/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element and point.

Definition at line 479 of file MooseFunctor.h.

   {
     mooseError("Element-point gradient-dot not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [5/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradDot	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 484 of file MooseFunctor.h.

   {
     mooseError("Gradient-dot at node not implemented for functor " + functorName());
   }

◆ evaluateGradDot() [6/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradDot	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor gradient-dot with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1185 of file MooseVariableFE.C.

 {
   mooseAssert(_time_integrator,
               "A time derivative is being requested but we do not have a time integrator so we'll "
               "have no idea how to compute it");
   mooseAssert(_time_integrator->dt(),
               "A time derivative is being requested but the time integrator wants to perform a 0s "
               "time step");
   const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
   // We can use whatever we want for the point argument since it won't be used
   const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
   evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
   return _current_elem_qp_functor_grad_dot[0];
 }

◆ evaluateGradient() [1/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradient	(	const FaceArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Parameters

face	See the `FaceArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Definition at line 342 of file MooseFunctor.h.

   {
     mooseError("Face gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [2/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradient	(	const ElemPointArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Evaluate the functor gradient with a given element and point.

Definition at line 371 of file MooseFunctor.h.

   {
     mooseError("Element-point gradient not implemented for functor " + functorName());
   }

◆ evaluateGradient() [3/6]

template<typename T>

virtual GradientType Moose::FunctorBase< T >::evaluateGradient	(	const NodeArg &	,
		const StateArg &
	)		const

inlineprotectedvirtualinherited

Definition at line 376 of file MooseFunctor.h.

   {
     mooseError("Gradient at node not implemented for functor " + functorName());
   }

◆ evaluateGradient() [4/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemQpArg &	elem_qp,
		const StateArg &	state
	)		const

overrideprotectedvirtualinherited

Parameters

qp	See the `ElemQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1127 of file MooseVariableFE.C.

 {
   evaluateOnElement(elem_qp, state, /*query_cache=*/true);
   const auto qp = elem_qp.qp;
   mooseAssert(qp < _current_elem_qp_functor_gradient.size(),
               "The requested " << qp << " is outside our gradient size");
   return _current_elem_qp_functor_gradient[qp];
 }

◆ evaluateGradient() [5/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemSideQpArg &	elem_side_qp,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Parameters

side_qp	See the `ElemSideQpArg` doxygen
state	See the `StateArg` doxygen

Returns: The functor gradient evaluated at the requested state and space

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1268 of file MooseVariableFE.C.

 {
   evaluateOnElementSide(elem_side_qp, state, true);
   const auto qp = elem_side_qp.qp;
   mooseAssert(qp < _current_elem_side_qp_functor_gradient.size(),
               "The requested " << qp << " is outside our gradient size");
   return _current_elem_side_qp_functor_gradient[qp];
 }

◆ evaluateGradient() [6/6]

MooseVariableFE< Real >::GradientType MooseVariableFE< Real >::evaluateGradient	(	const ElemArg &	elem_arg,
		const StateArg &	state
	)		const

finaloverrideprotectedvirtualinherited

Evaluate the functor gradient with a given element.

Some example implementations of this method could compute an element-average or evaluate at the element centroid

Reimplemented from Moose::FunctorBase< T >.

Definition at line 1139 of file MooseVariableFE.C.

 {
   const QMonomial qrule(elem_arg.elem->dim(), CONSTANT);
   // We can use whatever we want for the point argument since it won't be used
   const ElemQpArg elem_qp_arg{elem_arg.elem, /*qp=*/0, &qrule, Point(0, 0, 0)};
   evaluateOnElement(elem_qp_arg, state, /*cache_eligible=*/false);
   return _current_elem_qp_functor_gradient[0];
 }

◆ faceEvaluate()

MooseVariableFE< Real >::ValueType MooseVariableFE< Real >::faceEvaluate	(	const FaceArg &	face_arg,
		const StateArg &	state,
		const std::vector< ValueType > &	cache_data
	)		const

protectedinherited

A common method that both evaluate(FaceArg) and evaluateDot(FaceArg) can call.

A value evaluation vs dot evaluation is delineated via the passed-in cache_data, e.g. if the passed-in cache data is the sln data member then this will return a value evaluation and if the cache data is the dot data member then this will return a dot evaluation

Definition at line 1058 of file MooseVariableFE.C.

 {
   const QMonomial qrule(face_arg.fi->elem().dim() - 1, CONSTANT);
   auto side_evaluate =
       [this, &qrule, &state, &cache_data](const Elem * const elem, const unsigned int side)
   {
     // We can use whatever we want for the point argument since it won't be used
     const ElemSideQpArg elem_side_qp_arg{elem, side, /*qp=*/0, &qrule, Point(0, 0, 0)};
     evaluateOnElementSide(elem_side_qp_arg, state, /*cache_eligible=*/false);
     return cache_data[0];
   };
 
   const auto continuity = this->getContinuity();
   bool on_elem;
   bool on_neighbor;
   if (!face_arg.face_side)
   {
     on_elem = this->hasBlocks(face_arg.fi->elemPtr()->subdomain_id());
     on_neighbor =
         face_arg.fi->neighborPtr() && this->hasBlocks(face_arg.fi->neighborPtr()->subdomain_id());
   }
   else
   {
     on_elem = face_arg.face_side == face_arg.fi->elemPtr();
     on_neighbor = face_arg.face_side == face_arg.fi->neighborPtr();
   }
 
   // Only do multiple evaluations if we are not continuous and we are on an internal face
   if ((continuity != C_ZERO && continuity != C_ONE) && on_elem && on_neighbor)
     return (side_evaluate(face_arg.fi->elemPtr(), face_arg.fi->elemSideID()) +
             side_evaluate(face_arg.fi->neighborPtr(), face_arg.fi->neighborSideID())) /
            2;
   else if (on_elem)
     return side_evaluate(face_arg.fi->elemPtr(), face_arg.fi->elemSideID());
   else if (on_neighbor)
     return side_evaluate(face_arg.fi->neighborPtr(), face_arg.fi->neighborSideID());
   else
     mooseError(
         "Attempted to evaluate a moose finite element variable on a face where it is not defined");
 }

◆ feType()

const libMesh::FEType& MooseVariableBase::feType ( ) const

inlineinherited

Get the type of finite element object.

Definition at line 57 of file MooseVariableBase.h.

Referenced by SetupResidualDebugAction::act(), ADDGKernel::ADDGKernel(), Assembly::adGradPhi(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), ArrayIntegratedBC::ArrayIntegratedBC(), ArrayKernel::ArrayKernel(), AuxKernelTempl< Real >::AuxKernelTempl(), BoundsBase::BoundsBase(), BuildArrayVariableAux::BuildArrayVariableAux(), TagAuxBase< AuxKernel >::checkCoupledVariable(), SamplerBase::checkForStandardFieldVariableType(), GapValueAux::computeValue(), CopyValueAux::CopyValueAux(), DGKernel::DGKernel(), MultiAppNearestNodeTransfer::execute(), moose::internal::incompatVarMsg(), AdvancedOutput::initAvailableLists(), MultiAppProjectionTransfer::initialSetup(), AdvancedOutput::initShowHideLists(), IntegratedBC::IntegratedBC(), InterfaceKernelTempl< T >::InterfaceKernelTempl(), InternalSideIndicatorBase::InternalSideIndicatorBase(), Kernel::Kernel(), MeshDivisionAux::MeshDivisionAux(), MultiAppVariableValueSamplePostprocessorTransfer::MultiAppVariableValueSamplePostprocessorTransfer(), NodalBC::NodalBC(), NodalKernel::NodalKernel(), SolutionUserObjectBase::pointValueWrapper(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), MultiAppDofCopyTransfer::transfer(), and VectorNodalBC::VectorNodalBC().

57 { return _fe_type; }

MooseVariableBase::_fe_type

libMesh::FEType _fe_type

The FEType associated with this variable.

Definition: MooseVariableBase.h:201

◆ fieldType()

Moose::VarFieldType MooseVariableField< Real >::fieldType ( ) const

overridevirtualinherited

Field type of this variable.

Implements MooseVariableFieldBase.

Definition at line 72 of file MooseVariableField.C.

 {
   if (std::is_same<OutputType, Real>::value)
     return Moose::VarFieldType::VAR_FIELD_STANDARD;
   else if (std::is_same<OutputType, RealVectorValue>::value)
     return Moose::VarFieldType::VAR_FIELD_VECTOR;
   else if (std::is_same<OutputType, RealEigenVector>::value)
     return Moose::VarFieldType::VAR_FIELD_ARRAY;
   else
     mooseError("Unknown variable field type");
 }

◆ functorName()

template<typename T>

const MooseFunctorName& Moose::FunctorBase< T >::functorName ( ) const

inlineinherited

Return the functor name.

Definition at line 170 of file MooseFunctor.h.

Referenced by Moose::FunctorBase< libMesh::VectorValue >::evaluateDot(), Moose::FunctorBase< libMesh::VectorValue >::evaluateGradDot(), Moose::FunctorBase< libMesh::VectorValue >::evaluateGradient(), and Moose::FunctorBase< libMesh::VectorValue >::hasBlocks().

170 { return _functor_name; }

Moose::FunctorBase::_functor_name

MooseFunctorName _functor_name

name of the functor

Definition: MooseFunctor.h:564

◆ genericDofValues()

const MooseArray< GenericReal< is_ad > > & MooseVariableField< Real >::genericDofValues ( ) const

inherited

Definition at line 428 of file MooseVariableField.h.

 {
   return adDofValues();
 }

◆ genericEvaluate()

template<typename T >

template<FunctorEvaluationKind FET, typename Space , typename State >

FunctorReturnType< T, FET >::type Moose::FunctorBase< T >::genericEvaluate	(	const Space &	r,
		const State &	state
	)		const

inherited

Perform a generic evaluation based on the supplied template argument FET and supplied spatial and temporal arguments.

Definition at line 987 of file MooseFunctor.h.

 {
   if constexpr (FET == FunctorEvaluationKind::Value)
     return (*this)(r, state);
   else if constexpr (FET == FunctorEvaluationKind::Gradient)
     return gradient(r, state);
   else if constexpr (FET == FunctorEvaluationKind::Dot)
     return dot(r, state);
   else
     return gradDot(r, state);
 }

◆ 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 321 of file BlockRestrictable.C.

 {
   if (!_blk_mesh)
     mooseError("No mesh available in BlockRestrictable::checkCoordSystem()");
   if (!_blk_feproblem)
     mooseError("No problem available in BlockRestrictable::checkCoordSystem()");
 
   const auto & subdomains = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   if (subdomains.empty())
     mooseError("No subdomains found in the problem.");
 
   // make sure all subdomains are using the same coordinate system
   auto coord_system = _blk_feproblem->getCoordSystem(*subdomains.begin());
   for (auto subdomain : subdomains)
     if (_blk_feproblem->getCoordSystem(subdomain) != coord_system)
       mooseError("This object requires all subdomains to have the same coordinate system.");
 
   return coord_system;
 }

◆ getCheckedPointerParam()

template<typename T >

T MooseBaseParameterInterface::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

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 286 of file MooseBaseParameterInterface.h.

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

◆ getContinuity()

libMesh::FEContinuity MooseVariableFE< Real >::getContinuity ( ) const

inlineoverridevirtualinherited

Return the continuity of this variable.

Reimplemented from MooseVariableBase.

Definition at line 149 of file MooseVariableFE.h.

149 { return _element_data->getContinuity(); };

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getDofIndices()

void MooseVariableFE< Real >::getDofIndices	(	const Elem *	elem,
		std::vector< dof_id_type > &	dof_indices
	)		const

overridevirtualinherited

Reimplemented from MooseVariableBase.

Definition at line 159 of file MooseVariableFE.C.

 {
   _element_data->getDofIndices(elem, dof_indices);
 }

◆ getElementalValue()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getElementalValue	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the current value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 188 of file MooseVariableFE.C.

 {
   return _element_data->getElementalValue(elem, Moose::Current, idx);
 }

◆ getElementalValueOld()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getElementalValueOld	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the old value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 195 of file MooseVariableFE.C.

 {
   return _element_data->getElementalValue(elem, Moose::Old, idx);
 }

◆ getElementalValueOlder()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getElementalValueOlder	(	const Elem *	elem,
		unsigned int	idx = `0`
	)		const

inherited

Get the older value of this variable on an element.

Parameters

[in]	elem	Element at which to get value
[in]	idx	Local index of this variable's element DoFs

Returns: Variable value

Definition at line 202 of file MooseVariableFE.C.

 {
   return _element_data->getElementalValue(elem, Moose::Older, idx);
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), EigenExecutionerBase::init(), IntegralPreservingFunctionIC::initialSetup(), MultiAppConservativeTransfer::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), ElementReporter::shouldStore(), NodalReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getGradient()

OutputTools< Real >::OutputGradient MooseVariableFE< Real >::getGradient	(	const Elem *	elem,
		const std::vector< std::vector< typename OutputTools< Real >::OutputShapeGradient >> &	grad_phi
	)		const

inherited

Compute the variable gradient value at a point on an element.

Parameters

elem	The element we are computing on
phi	Evaluated shape functions at a point

Returns: The variable gradient value

Definition at line 514 of file MooseVariableFE.C.

 {
   std::vector<dof_id_type> dof_indices;
   this->_dof_map.dof_indices(elem, dof_indices, _var_num);
 
   typename OutputTools<OutputType>::OutputGradient value;
   if (isNodal())
   {
     for (unsigned int i = 0; i < dof_indices.size(); ++i)
     {
       // The zero index is because we only have one point that the phis are evaluated at
       value += grad_phi[i][0] * (*this->_sys.currentSolution())(dof_indices[i]);
     }
   }
   else
   {
     mooseAssert(dof_indices.size() == 1, "Wrong size for dof indices");
     value = 0.0;
   }
 
   return value;
 }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ getNodalValue()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getNodalValue ( const Node & node ) const

inherited

Get the value of this variable at given node.

Definition at line 167 of file MooseVariableFE.C.

 {
   return _element_data->getNodalValue(node, Moose::Current);
 }

◆ getNodalValueOld()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getNodalValueOld ( const Node & node ) const

inherited

Get the old value of this variable at given node.

Definition at line 174 of file MooseVariableFE.C.

 {
   return _element_data->getNodalValue(node, Moose::Old);
 }

◆ getNodalValueOlder()

MooseVariableFE< Real >::OutputData MooseVariableFE< Real >::getNodalValueOlder ( const Node & node ) const

inherited

Get the t-2 value of this variable at given node.

Definition at line 181 of file MooseVariableFE.C.

 {
   return _element_data->getNodalValue(node, Moose::Older);
 }

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

 {
   return _oi_outputs;
 }

◆ getParam() [1/2]

template<typename T >

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

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 215 of file MooseBaseParameterInterface.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 279 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 229 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 68 of file MooseObject.C.

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 81 of file MooseObject.C.

 {
   try
   {
     return shared_from_this();
   }
   catch (std::bad_weak_ptr &)
   {
     mooseError(not_shared_error);
   }
 }

◆ getSolution()

const NumericVector< Number > & MooseVariableField< Real >::getSolution ( const Moose::StateArg & state ) const

protectedinherited

Get the solution corresponding to the provided state.

Definition at line 60 of file MooseVariableField.C.

 {
   // It's not safe to use solutionState(0) because it returns the libMesh System solution member
   // which is wrong during things like finite difference Jacobian evaluation, e.g. when PETSc
   // perturbs the solution vector we feed these perturbations into the current_local_solution
   // while the libMesh solution is frozen in the non-perturbed state
   return (state.state == 0) ? *this->_sys.currentSolution()
                             : this->_sys.solutionState(state.state, state.iteration_type);
 }

◆ getValue()

Real MooseVariableFE< Real >::getValue	(	const Elem *	elem,
		const std::vector< std::vector< OutputShape >> &	phi
	)		const

inherited

Compute the variable value at a point on an element.

Parameters

elem	The element we are computing on
phi	Evaluated shape functions at a point

Returns: The variable value

Definition at line 453 of file MooseVariableFE.C.

 {
   std::vector<dof_id_type> dof_indices;
   this->_dof_map.dof_indices(elem, dof_indices, _var_num);
 
   OutputType value = 0;
   if (isNodal())
   {
     mooseAssert(dof_indices.size() == phi.size(),
                 "The number of shapes does not match the number of dof indices on the elem");
 
     for (unsigned int i = 0; i < dof_indices.size(); ++i)
     {
       // The zero index is because we only have one point that the phis are evaluated at
       value += phi[i][0] * (*this->_sys.currentSolution())(dof_indices[i]);
     }
   }
   else
   {
     mooseAssert(dof_indices.size() == 1, "Wrong size for dof indices");
     value = (*this->_sys.currentSolution())(dof_indices[0]);
   }
 
   return value;
 }

◆ gradDot() [1/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradDot overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 933 of file MooseFunctor.h.

Referenced by Moose::VectorComponentFunctor< T >::evaluateGradDot(), and Moose::ADWrapperFunctor< T >::evaluateGradDot().

 {
   return evaluateGradDot(elem, state);
 }

◆ gradDot() [2/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 940 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradDot(face, state);
 }

◆ gradDot() [3/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 948 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_qp, state);
 }

◆ gradDot() [4/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 955 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_side_qp, state);
 }

◆ gradDot() [5/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 962 of file MooseFunctor.h.

 {
   return evaluateGradDot(elem_point, state);
 }

◆ gradDot() [6/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradDot	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 969 of file MooseFunctor.h.

 {
   return evaluateGradDot(node, state);
 }

◆ gradient() [1/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluateGradient overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 847 of file MooseFunctor.h.

Referenced by GradientJumpIndicator::computeQpIntegral(), Moose::FV::containerInterpolate(), Moose::VectorComponentFunctor< T >::evaluateGradient(), Moose::ADWrapperFunctor< T >::evaluateGradient(), and Moose::FV::greenGaussGradient().

 {
   return evaluateGradient(elem, state);
 }

◆ gradient() [2/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 854 of file MooseFunctor.h.

 {
   checkFace(face);
   return evaluateGradient(face, state);
 }

◆ gradient() [3/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 862 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_qp, state);
 }

◆ gradient() [4/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 869 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_side_qp, state);
 }

◆ gradient() [5/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 876 of file MooseFunctor.h.

 {
   return evaluateGradient(elem_point, state);
 }

◆ gradient() [6/6]

template<typename T >

FunctorBase< T >::GradientType Moose::FunctorBase< T >::gradient	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 883 of file MooseFunctor.h.

 {
   return evaluateGradient(node, state);
 }

◆ gradPhi()

const FieldVariablePhiGradient& MooseVariableFE< Real >::gradPhi ( ) const

inlinefinaloverridevirtualinherited

Return the gradients of the variable's elemental shape functions.

Implements MooseVariableField< Real >.

Definition at line 191 of file MooseVariableFE.h.

   {
     return _element_data->gradPhi();
   }

◆ gradPhiFace()

const FieldVariablePhiGradient& MooseVariableFE< Real >::gradPhiFace ( ) const

inlinefinaloverridevirtualinherited

Return the gradients of the variable's shape functions on an element face.

Implements MooseVariableField< Real >.

Definition at line 204 of file MooseVariableFE.h.

   {
     return _element_data->gradPhiFace();
   }

◆ gradPhiFaceNeighbor()

const FieldVariablePhiGradient& MooseVariableFE< Real >::gradPhiFaceNeighbor ( ) const

inlinefinaloverridevirtualinherited

Return the gradients of the variable's shape functions on a neighboring element face.

Implements MooseVariableField< Real >.

Definition at line 233 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradPhiFace();
   }

◆ gradPhiLower()

const FieldVariablePhiGradient& MooseVariableFE< Real >::gradPhiLower ( ) const

inlineinherited

Definition at line 246 of file MooseVariableFE.h.

246 { return _lower_data->gradPhi(); }

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

◆ gradPhiNeighbor()

const FieldVariablePhiGradient& MooseVariableFE< Real >::gradPhiNeighbor ( ) const

inlinefinaloverridevirtualinherited

Return the gradients of the variable's shape functions on a neighboring element.

Implements MooseVariableField< Real >.

Definition at line 217 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradPhi();
   }

◆ gradSln()

const FieldVariableGradient& MooseVariableFE< Real >::gradSln ( ) const

inlineoverridevirtualinherited

element gradients

Implements MooseVariableField< Real >.

Definition at line 290 of file MooseVariableFE.h.

   {
     return _element_data->gradSln(Moose::Current);
   }

◆ gradSlnDot()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnDot ( ) const

inlineinherited

element gradient dots

Definition at line 308 of file MooseVariableFE.h.

308 { return _element_data->gradSlnDot(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ gradSlnDotDot()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnDotDot ( ) const

inlineinherited

Definition at line 309 of file MooseVariableFE.h.

309 { return _element_data->gradSlnDotDot(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ gradSlnNeighbor()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor solution gradients

Implements MooseVariableField< Real >.

Definition at line 421 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradSln(Moose::Current);
   }

◆ gradSlnNeighborDot()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnNeighborDot ( ) const

inlineinherited

neighbor grad dots

Definition at line 439 of file MooseVariableFE.h.

439 { return _neighbor_data->gradSlnDot(); }

Referenced by LinearFVFluxKernel::addMatrixContribution(), DiracKernelBase::addPoint(), LinearFVFluxKernel::addRightHandSideContribution(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), DomainUserObject::checkVariable(), ComputeJacobianThread::compute(), ComboMarker::computeElementMarker(), GradientJumpIndicator::computeQpIntegral(), ProjectionAux::computeValue(), DomainUserObject::DomainUserObject(), ProjectionAux::elemOnNodeVariableIsDefinedOn(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), QuadraturePointMultiApp::fillPositions(), CentroidMultiApp::fillPositions(), MeshDivisionFunctorReductionVectorPostprocessor::hasBlocks(), BlockRestrictable::hasBlocks(), MooseVariableField< Real >::hasBlocks(), FVFluxKernel::hasFaceSide(), IndicatorMarker::IndicatorMarker(), NodePositions::initialize(), ParsedDownSelectionPositions::initialize(), UpdateErrorVectorsThread::onElement(), PointwiseRenormalizeVector::PointwiseRenormalizeVector(), and BlockRestrictionDebugOutput::printBlockRestrictionMap().

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ gradSlnNeighborDotDot()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnNeighborDotDot ( ) const

inlineinherited

Definition at line 440 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradSlnDotDot();
   }

◆ gradSlnOld()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnOld ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 294 of file MooseVariableFE.h.

   {
     return _element_data->gradSln(Moose::Old);
   }

◆ gradSlnOlder()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnOlder ( ) const

inlineinherited

Definition at line 298 of file MooseVariableFE.h.

   {
     return _element_data->gradSln(Moose::Older);
   }

◆ gradSlnOlderNeighbor()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 429 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradSln(Moose::Older);
   }

◆ gradSlnOldNeighbor()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnOldNeighbor ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 425 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradSln(Moose::Old);
   }

◆ gradSlnPreviousNL()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnPreviousNL ( ) const

inlineinherited

Definition at line 302 of file MooseVariableFE.h.

   {
     return _element_data->gradSln(Moose::PreviousNL);
   }

◆ gradSlnPreviousNLNeighbor()

const FieldVariableGradient& MooseVariableFE< Real >::gradSlnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 433 of file MooseVariableFE.h.

   {
     return _neighbor_data->gradSln(Moose::PreviousNL);
   }

◆ hasBlockMaterialProperty()

template<typename T , bool is_ad>

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

T	The type of material property

Parameters

prop_name the 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 271 of file BlockRestrictable.h.

 {
   mooseAssert(_blk_material_data != NULL, "MaterialData pointer is not defined");
   return hasBlockMaterialPropertyHelper(prop_name) &&
          _blk_material_data->haveGenericProperty<T, is_ad>(prop_name);
 }

◆ 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 285 of file BlockRestrictable.C.

Referenced by BlockRestrictable::hasBlockMaterialProperty().

 {
 
   // Reference to MaterialWarehouse for testing and retrieving block ids
   const MaterialWarehouse & warehouse = _blk_feproblem->getMaterialWarehouse();
 
   // Complete set of ids that this object is active
   const std::set<SubdomainID> & ids = blockRestricted() ? blockIDs() : meshBlockIDs();
 
   // Loop over each id for this object
   for (const auto & id : ids)
   {
     // Storage of material properties that have been DECLARED on this id
     std::set<std::string> declared_props;
 
     // If block materials exist, populated the set of properties that were declared
     if (warehouse.hasActiveBlockObjects(id))
     {
       const std::vector<std::shared_ptr<MaterialBase>> & mats = warehouse.getActiveBlockObjects(id);
       for (const auto & mat : mats)
       {
         const std::set<std::string> & mat_props = mat->getSuppliedItems();
         declared_props.insert(mat_props.begin(), mat_props.end());
       }
     }
 
     // If the supplied property is not in the list of properties on the current id, return false
     if (declared_props.find(prop_name) == declared_props.end())
       return false;
   }
 
   // If you get here the supplied property is defined on all blocks
   return true;
 }

◆ hasBlocks() [1/6]

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

inherited

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

Parameters

name	A SubdomainName to check

Returns: True if the given id is valid for this object

Definition at line 209 of file BlockRestrictable.C.

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

◆ hasBlocks() [2/6]

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

inherited

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

Parameters

names A vector of SubdomainNames to check

Returns: True if the given ids are valid for this object

Definition at line 219 of file BlockRestrictable.C.

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

◆ hasBlocks() [3/6]

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

inherited

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

Parameters

names A set of SubdomainNames to check

Returns: True if the given ids are valid for this object

Definition at line 225 of file BlockRestrictable.C.

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

◆ hasBlocks() [4/6]

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

inherited

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

Parameters

ids	A vector of SubdomainIDs ids to check

Returns: True if all of the given ids are found within the ids for this object

Definition at line 240 of file BlockRestrictable.C.

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

◆ hasBlocks() [5/6]

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

inherited

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

Parameters

ids	A std::set of SubdomainIDs to check

Returns: True if all of the given ids are found within the ids for this object

See also: isSubset

Definition at line 247 of file BlockRestrictable.C.

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

◆ hasBlocks() [6/6]

bool MooseVariableField< Real >::hasBlocks ( const SubdomainID id ) const

inlineoverridevirtualinherited

Returns whether the functor is defined on this block.

Reimplemented from Moose::FunctorBase< T >.

Definition at line 400 of file MooseVariableField.h.

400 { return BlockRestrictable::hasBlocks(id); }

BlockRestrictable::hasBlocks

bool hasBlocks(const SubdomainName &name) const

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

Definition: BlockRestrictable.C:209

◆ hasDoFsOnNodes()

bool MooseVariableFE< Real >::hasDoFsOnNodes ( ) const

inlineoverridevirtualinherited

Does this variable have DoFs on nodes.

Returns: true if it does, false if not.

Reimplemented from MooseVariableBase.

Definition at line 148 of file MooseVariableFE.h.

148 { return _element_data->hasDoFsOnNodes(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ hasFaceSide()

template<typename T >

bool Moose::FunctorBase< T >::hasFaceSide	(	const FaceInfo &	fi,
		const bool	fi_elem_side
	)		const

overridevirtualinherited

Implements FaceArgInterface.

Definition at line 976 of file MooseFunctor.h.

Referenced by SideIntegralVariablePostprocessor::hasFaceSide(), InternalSideIntegralVariablePostprocessor::hasFaceSide(), and Moose::ADWrapperFunctor< T >::hasFaceSide().

 {
   if (fi_elem_side)
     return hasBlocks(fi.elem().subdomain_id());
   else
     return fi.neighborPtr() && hasBlocks(fi.neighbor().subdomain_id());
 }

◆ increment()

const FieldVariableValue& MooseVariableFE< Real >::increment ( ) const

inlineinherited

Definition at line 264 of file MooseVariableFE.h.

264 { return _element_data->increment(); }

Reimplemented in Moose::FunctorEnvelope< T >, Moose::FunctorEnvelope< ADReal >, Moose::FunctorEnvelope< GenericReal< is_ad > >, Moose::FunctorEnvelope< GenericRealVectorValue< is_ad > >, Moose::FunctorEnvelope< VectorValue< Real > >, Moose::FunctorEnvelope< Moose::GenericType< T, is_ad > >, Moose::FunctorEnvelope< VectorValue< GenericReal< is_ad > > >, Moose::FunctorEnvelope< Moose::GenericType< Real, is_ad > >, Moose::FunctorEnvelope< Real >, Moose::FunctorEnvelope< libMesh::VectorValue >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, PiecewiseByBlockLambdaFunctor< T >, Moose::VectorComponentFunctor< T >, Moose::ArrayComponentFunctor< T, ArrayTypeFunctor >, Moose::ADWrapperFunctor< T >, and Moose::RawValueFunctor< T >.

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ initializeBlockRestrictable()

void BlockRestrictable::initializeBlockRestrictable ( const MooseObject * moose_object )

protectedinherited

An initialization routine needed for dual constructors.

Definition at line 74 of file BlockRestrictable.C.

Referenced by BlockRestrictable::BlockRestrictable().

 {
   // If the mesh pointer is not defined, but FEProblemBase is, get it from there
   if (_blk_feproblem != NULL && _blk_mesh == NULL)
     _blk_mesh = &_blk_feproblem->mesh();
 
   // Check that the mesh pointer was defined, it is required for this class to operate
   if (_blk_mesh == NULL)
     mooseError("The input parameters must contain a pointer to FEProblem via '_fe_problem' or a "
                "pointer to the MooseMesh via '_mesh'");
 
   // Populate the MaterialData pointer
   if (_blk_feproblem != NULL)
     _blk_material_data = &_blk_feproblem->getMaterialData(Moose::BLOCK_MATERIAL_DATA, _blk_tid);
 
   // The 'block' input is defined
   if (moose_object->isParamValid("block"))
   {
     // Extract the blocks from the input
     _blocks = moose_object->getParam<std::vector<SubdomainName>>("block");
 
     // Store the IDs in a set, handling ANY_BLOCK_ID if supplied
     if (std::find(_blocks.begin(), _blocks.end(), "ANY_BLOCK_ID") != _blocks.end())
       _blk_ids.insert(Moose::ANY_BLOCK_ID);
     else
     {
       // Get the IDs from the supplied names
       _vec_ids = _blk_mesh->getSubdomainIDs(_blocks);
       _blk_ids.insert(_vec_ids.begin(), _vec_ids.end());
     }
   }
 
   // When 'blocks' is not set and there is a "variable", use the blocks from the variable
   else if (moose_object->isParamValid("variable"))
   {
     std::string variable_name = moose_object->parameters().getMooseType("variable");
     if (!variable_name.empty())
       _blk_ids = _blk_feproblem
                      ->getVariable(_blk_tid,
                                    variable_name,
                                    Moose::VarKindType::VAR_ANY,
                                    Moose::VarFieldType::VAR_FIELD_ANY)
                      .activeSubdomains();
   }
 
   // Produce error if the object is not allowed to be both block and boundary restricted
   if (!_blk_dual_restrictable && !_boundary_ids.empty() && !_boundary_ids.empty())
     if (!_boundary_ids.empty() && _boundary_ids.find(Moose::ANY_BOUNDARY_ID) == _boundary_ids.end())
       moose_object->paramError("block",
                                "Attempted to restrict the object '",
                                _blk_name,
                                "' to a block, but the object is already restricted by boundary");
 
   // If no blocks were defined above, specify that it is valid on all blocks
   if (_blk_ids.empty() && !moose_object->isParamValid("boundary"))
   {
     _blk_ids.insert(Moose::ANY_BLOCK_ID);
     _blocks = {"ANY_BLOCK_ID"};
   }
 
   // If this object is block restricted, check that defined blocks exist on the mesh
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) == _blk_ids.end())
   {
     const std::set<SubdomainID> & valid_ids = _blk_mesh->meshSubdomains();
     std::vector<SubdomainID> diff;
 
     std::set_difference(_blk_ids.begin(),
                         _blk_ids.end(),
                         valid_ids.begin(),
                         valid_ids.end(),
                         std::back_inserter(diff));
 
     if (!diff.empty())
     {
       std::ostringstream msg;
       auto sep = " ";
       msg << "the following blocks (ids) do not exist on the mesh:";
       for (const auto & id : diff)
       {
         if (_blk_name.size() > 0)
         {
           auto & name =
               _blocks.at(std::find(_vec_ids.begin(), _vec_ids.end(), id) - _vec_ids.begin());
           if (std::to_string(id) != name)
             msg << sep << name << " (" << id << ")";
           else
             msg << sep << id;
         }
         else
           msg << sep << id;
         sep = ", ";
       }
       std::vector<SubdomainID> valid_ids_vec(valid_ids.begin(), valid_ids.end());
       auto valid_names = _blk_mesh->getSubdomainNames(valid_ids_vec);
       msg << "\nBlocks names (resp. ids) that do exist: " << Moose::stringify(valid_names) << " ("
           << Moose::stringify(valid_ids) << ")";
       moose_object->paramError("block", msg.str());
     }
   }
 
   // Get the mesh dimension for the blocks
   if (blockRestricted())
     _blk_dim = _blk_mesh->getBlocksMaxDimension(_blocks);
   else
     _blk_dim = _blk_mesh->dimension();
 }

◆ initialSetup()

void MooseVariableBase::initialSetup ( )

overridevirtualinherited

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

Reimplemented from SetupInterface.

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 247 of file MooseVariableBase.C.

Referenced by MooseLinearVariableFV< Real >::initialSetup(), and MooseVariableFV< Real >::initialSetup().

 {
   // Currently the scaling vector is only used through AD residual computing objects
   if ((_var_kind == Moose::VAR_SOLVER) && _subproblem.haveADObjects() &&
       (_subproblem.automaticScaling() || (std::find_if(_scaling_factor.begin(),
                                                        _scaling_factor.end(),
                                                        [](const Real element) {
                                                          return !MooseUtils::absoluteFuzzyEqual(
                                                              element, 1.);
                                                        }) != _scaling_factor.end())))
 
     _sys.addScalingVector();
 }

◆ insert()

void MooseVariableFE< Real >::insert ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtualinherited

Set the current local DOF values to the input vector.

Implements MooseVariableFieldBase.

Definition at line 209 of file MooseVariableFE.C.

 {
   _element_data->insert(vector);
 }

◆ insertLower()

void MooseVariableFE< Real >::insertLower ( libMesh::NumericVector< libMesh::Number > & vector )

overridevirtualinherited

Insert the currently cached degree of freedom values for a lower-dimensional element into the provided vector.

Implements MooseVariableFieldBase.

Definition at line 216 of file MooseVariableFE.C.

 {
   _lower_data->insert(vector);
 }

◆ insertNodalValue()

void MooseVariableFE< Real >::insertNodalValue	(	libMesh::NumericVector< libMesh::Number > &	residual,
		const OutputData &	v
	)

inherited

Write a nodal value to the passed-in solution vector.

Definition at line 709 of file MooseVariableFE.C.

 {
   _element_data->insertNodalValue(residual, v);
 }

◆ isArray()

bool MooseVariableField< Real >::isArray ( ) const

overridevirtualinherited

Returns: whether this is an array variable

Reimplemented from MooseVariableBase.

Definition at line 86 of file MooseVariableField.C.

 {
   const auto is_array = MooseVariableBase::isArray();
   if (std::is_same<OutputType, RealEigenVector>::value != is_array)
     mooseError("A variable is marked as an array variable in a base class, but in a derived class "
                "the output type is not consistent.");
   return is_array;
 }

◆ 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

ids	A 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 256 of file BlockRestrictable.C.

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

 {
   // An empty input is assumed to be ANY_BLOCK_ID
   if (ids.empty() || ids.find(Moose::ANY_BLOCK_ID) != ids.end())
     return true;
 
   if (_blk_ids.find(Moose::ANY_BLOCK_ID) != _blk_ids.end())
     return std::includes(ids.begin(),
                          ids.end(),
                          _blk_mesh->meshSubdomains().begin(),
                          _blk_mesh->meshSubdomains().end());
   else
     return std::includes(ids.begin(), ids.end(), _blk_ids.begin(), _blk_ids.end());
 }

◆ 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

ids	A 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 272 of file BlockRestrictable.C.

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

◆ isConstant()

template<typename T>

virtual bool Moose::FunctorBase< T >::isConstant ( ) const

inlinevirtualinherited

Returns true if this functor is a constant.

Definition at line 260 of file MooseFunctor.h.

Referenced by Moose::ADWrapperFunctor< T >::isConstant().

260 { return false; }

◆ isExtrapolatedBoundaryFace()

template<typename T>

virtual bool Moose::FunctorBase< T >::isExtrapolatedBoundaryFace	(	const FaceInfo &	,
		const Elem *	,
		const StateArg &
	)		const

inlinevirtualinherited

Returns whether this (sided) face is an extrapolated boundary face for this functor.

Definition at line 247 of file MooseFunctor.h.

Referenced by Moose::ADWrapperFunctor< T >::isExtrapolatedBoundaryFace().

   {
     mooseError("not implemented");
   }

◆ isFV()

virtual bool MooseVariableFieldBase::isFV ( ) const

inlinevirtualinherited

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 81 of file MooseVariableFieldBase.h.

Referenced by ComputeFullJacobianThread::computeOnBoundary(), ComputeFullJacobianThread::computeOnElement(), ComputeFullJacobianThread::computeOnInterface(), ComputeFullJacobianThread::computeOnInternalFace(), GradientJumpIndicator::computeQpIntegral(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), InterfaceDiffusiveFluxIntegralTempl< is_ad >::InterfaceDiffusiveFluxIntegralTempl(), InterfaceIntegralVariableValuePostprocessor::InterfaceIntegralVariableValuePostprocessor(), and InternalSideIndicatorTempl< ComputeValueType >::isVarFV().

81 { return false; }

◆ isInternalFace()

template<typename T >

bool Moose::FunctorBase< T >::isInternalFace ( const FaceInfo & fi ) const

inherited

Returns true if the face is an internal face.

Definition at line 569 of file MooseFunctor.h.

Referenced by FVAnisotropicDiffusion::computeQpResidual(), and FVDiffusion::computeQpResidual().

 {
   if (!fi.neighborPtr())
     return false;
 
   return hasBlocks(fi.elem().subdomain_id()) && hasBlocks(fi.neighborPtr()->subdomain_id());
 }

◆ isLowerD()

bool MooseVariableBase::isLowerD ( ) const

inlineinherited

Returns: whether this variable lives on lower dimensional blocks

Definition at line 189 of file MooseVariableBase.h.

189 { return _is_lower_d; }

MooseVariableBase::_is_lower_d

bool _is_lower_d

Whether this variable lives on lower dimensional blocks.

Definition: MooseVariableBase.h:249

◆ isNodal()

bool MooseVariableFE< Real >::isNodal ( ) const

inlineoverridevirtualinherited

Is this variable nodal.

Returns: true if it nodal, otherwise false

Reimplemented from MooseVariableBase.

Definition at line 147 of file MooseVariableFE.h.

147 { return _element_data->isNodal(); }

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseBaseParameterInterface::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MFEMSolverBase::setPreconditioner(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ isNodalDefined()

bool MooseVariableFE< Real >::isNodalDefined ( ) const

overridevirtualinherited

Is this variable defined at nodes.

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

Implements MooseVariableFieldBase.

Definition at line 829 of file MooseVariableFE.C.

 {
   return _element_data->isNodalDefined();
 }

◆ isNodalNeighborDefined()

bool MooseVariableFE< Real >::isNodalNeighborDefined ( ) const

inherited

Definition at line 836 of file MooseVariableFE.C.

 {
   return _neighbor_data->isNodalDefined();
 }

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 128 of file MooseBaseParameterInterface.h.

128 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

bool isParamSetByUser(const std::string &name) const

Method returns true if the parameter was set by the user.

Definition: InputParameters.C:1178

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 122 of file MooseBaseParameterInterface.h.

122 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

InputParameters::isParamValid

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

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:390

◆ isVector()

bool MooseVariableField< Real >::isVector ( ) const

overridevirtualinherited

Returns: true if this is a vector-valued element, false otherwise.

Implements MooseVariableFieldBase.

Definition at line 97 of file MooseVariableField.C.

 {
   return std::is_same<OutputType, RealVectorValue>::value;
 }

◆ jacobianSetup()

void MooseVariableFE< Real >::jacobianSetup ( )

overridevirtualinherited

Reimplemented from MooseVariableField< Real >.

Definition at line 1372 of file MooseVariableFE.C.

 {
   _current_elem_qp_functor_elem = nullptr;
   _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
   MooseVariableField<OutputType>::jacobianSetup();
 }

◆ kind()

Moose::VarKindType MooseVariableBase::kind ( ) const

inlineinherited

Kind of the variable (Nonlinear, Auxiliary, ...)

Definition at line 88 of file MooseVariableBase.h.

Referenced by ADPenaltyPeriodicSegmentalConstraint::ADPenaltyPeriodicSegmentalConstraint(), ADPeriodicSegmentalConstraint::ADPeriodicSegmentalConstraint(), FVFluxBC::FVFluxBC(), MooseVariableInterface< Real >::MooseVariableInterface(), PenaltyPeriodicSegmentalConstraint::PenaltyPeriodicSegmentalConstraint(), and PeriodicSegmentalConstraint::PeriodicSegmentalConstraint().

88 { return _var_kind; }

MooseVariableBase::_var_kind

Moose::VarKindType _var_kind

Variable type (see MooseTypes.h)

Definition: MooseVariableBase.h:213

◆ matrixTagValue()

const FieldVariableValue& MooseVariableFE< Real >::matrixTagValue ( TagID tag ) const

inlineoverridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 278 of file MooseVariableFE.h.

   {
     return _element_data->matrixTagValue(tag);
   }

◆ 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 279 of file BlockRestrictable.C.

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

 {
   return _blk_mesh->meshSubdomains();
 }

◆ meshChanged()

void MooseVariableFE< Real >::meshChanged ( )

overridevirtualinherited

Called on this object when the mesh changes.

Reimplemented from MeshChangedInterface.

Definition at line 1354 of file MooseVariableFE.C.

 {
   _current_elem_qp_functor_elem = nullptr;
   _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
   MooseVariableField<OutputType>::meshChanged();
 }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, _moose_base.errorPrefix("deprecation"), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 98 of file MooseBaseErrorInterface.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), SolutionUserObjectBase::SolutionUserObjectBase(), and SymmetryTransformGenerator::SymmetryTransformGenerator().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), SampledOutput::cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), CartesianGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchedMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), SphericalGridDivision::initialize(), CylindricalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), CartesianGridDivision::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), SampledOutput::updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 85 of file MooseBaseErrorInterface.h.

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

◆ name()

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

inlineoverridevirtualinherited

Get the variable name.

Reimplemented from MooseBase.

Definition at line 72 of file MooseVariableBase.h.

Referenced by SetupResidualDebugAction::act(), DiffusionLHDGKernel::additionalROVariables(), IPHDGAssemblyHelper::additionalROVariables(), InitialConditionWarehouse::addObject(), MooseLinearVariableFV< Real >::adError(), MooseVariableBase::allDofIndices(), ArrayParsedAux::ArrayParsedAux(), SamplerBase::checkForStandardFieldVariableType(), DomainUserObject::checkVariable(), BlockRestrictable::checkVariable(), Coupleable::checkWritableVar(), Coupleable::coupledName(), DebugResidualAux::DebugResidualAux(), GreaterThanLessThanPostprocessor::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppGeometricInterpolationTransfer::fillSourceInterpolationPoints(), FunctionArrayAux::FunctionArrayAux(), FVInitialConditionTempl< T >::FVInitialConditionTempl(), GapValueAux::GapValueAux(), MultiAppGeometricInterpolationTransfer::interpolateTargetPoints(), DerivativeMaterialInterface< MortarScalarBase >::isNotObjectVariable(), MooseLinearVariableFV< Real >::lowerDError(), MooseVariableBase::MooseVariableBase(), MooseLinearVariableFV< Real >::nodalError(), ParsedODEKernel::ParsedODEKernel(), ConstraintWarehouse::subdomainsCovered(), MooseLinearVariableFV< Real >::timeIntegratorError(), MultiAppDofCopyTransfer::transfer(), MultiAppShapeEvaluationTransfer::transferVariable(), FVFluxBC::uOnGhost(), and FVFluxBC::uOnUSub().

72 { return _var_name; }

MooseVariableBase::_var_name

std::string _var_name

Variable name.

Definition: MooseVariableBase.h:243

◆ needsGradientVectorStorage()

virtual bool MooseVariableFieldBase::needsGradientVectorStorage ( ) const

inlinevirtualinherited

Check if this variable needs a raw vector of gradients at dof-values.

This is mainly used for finite volume variables.

Reimplemented in MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, and MooseLinearVariableFV< Real >.

Definition at line 120 of file MooseVariableFieldBase.h.

120 { return false; }

◆ neighbor()

const Elem* const& MooseVariableFE< Real >::neighbor ( ) const

inlineinherited

Current neighboring element.

Definition at line 171 of file MooseVariableFE.h.

171 { return _neighbor_data->currentElem(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ nodalDofIndex()

const dof_id_type& MooseVariableFE< Real >::nodalDofIndex ( ) const

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 151 of file MooseVariableFE.h.

151 { return _element_data->nodalDofIndex(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ nodalDofIndexNeighbor()

const dof_id_type& MooseVariableFE< Real >::nodalDofIndexNeighbor ( ) const

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 155 of file MooseVariableFE.h.

   {
     return _neighbor_data->nodalDofIndex();
   }

◆ nodalMatrixTagValue()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::nodalMatrixTagValue ( TagID tag ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 590 of file MooseVariableFE.C.

 {
   return _element_data->nodalMatrixTagValue(tag);
 }

◆ nodalValue()

const Real & MooseVariableFE< Real >::nodalValue ( ) const

inherited

Methods for retrieving values of variables at the nodes.

Definition at line 569 of file MooseVariableFE.C.

 {
   return _element_data->nodalValue(Moose::Current);
 }

◆ nodalValueArray()

const MooseArray<Real >& MooseVariableFE< Real >::nodalValueArray ( ) const

inlineoverridevirtualinherited

Methods for retrieving values of variables at the nodes in a MooseArray for AuxKernelBase.

Implements MooseVariableField< Real >.

Definition at line 683 of file MooseVariableFE.h.

   {
     return _element_data->nodalValueArray(Moose::Current);
   }

◆ nodalValueDot()

const Real & MooseVariableFE< Real >::nodalValueDot ( ) const

inherited

Definition at line 639 of file MooseVariableFE.C.

 {
   return _element_data->nodalValueDot();
 }

◆ nodalValueDotDot()

const Real & MooseVariableFE< Real >::nodalValueDotDot ( ) const

inherited

Definition at line 646 of file MooseVariableFE.C.

 {
   return _element_data->nodalValueDotDot();
 }

◆ nodalValueDotDotNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotDotNeighbor ( ) const

inherited

◆ nodalValueDotDotNeighborResidual()

const Real & MooseVariableFE< Real >::nodalValueDotDotNeighborResidual ( ) const

inherited

◆ nodalValueDotDotOld()

const Real & MooseVariableFE< Real >::nodalValueDotDotOld ( ) const

inherited

Definition at line 660 of file MooseVariableFE.C.

 {
   return _element_data->nodalValueDotDotOld();
 }

◆ nodalValueDotDotOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotDotOldNeighbor ( ) const

inherited

◆ nodalValueDotNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotNeighbor ( ) const

inherited

◆ nodalValueDotNeighborResidual()

const Real & MooseVariableFE< Real >::nodalValueDotNeighborResidual ( ) const

inherited

◆ nodalValueDotOld()

const Real & MooseVariableFE< Real >::nodalValueDotOld ( ) const

inherited

Definition at line 653 of file MooseVariableFE.C.

 {
   return _element_data->nodalValueDotOld();
 }

◆ nodalValueDotOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDotOldNeighbor ( ) const

inherited

◆ nodalValueDuDotDotDu()

const Real & MooseVariableFE< Real >::nodalValueDuDotDotDu ( ) const

inherited

◆ nodalValueDuDotDotDuNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDuDotDotDuNeighbor ( ) const

inherited

◆ nodalValueDuDotDu()

const Real & MooseVariableFE< Real >::nodalValueDuDotDu ( ) const

inherited

◆ nodalValueDuDotDuNeighbor()

const Real & MooseVariableFE< Real >::nodalValueDuDotDuNeighbor ( ) const

inherited

◆ nodalValueNeighbor()

const Real & MooseVariableFE< Real >::nodalValueNeighbor ( ) const

inherited

Definition at line 576 of file MooseVariableFE.C.

 {
   return _neighbor_data->nodalValue(Moose::Current);
 }

◆ nodalValueOld()

const Real & MooseVariableFE< Real >::nodalValueOld ( ) const

inherited

Definition at line 597 of file MooseVariableFE.C.

 {
   return _element_data->nodalValue(Moose::Old);
 }

◆ nodalValueOldArray()

const MooseArray<Real >& MooseVariableFE< Real >::nodalValueOldArray ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 687 of file MooseVariableFE.h.

   {
     return _element_data->nodalValueArray(Moose::Old);
   }

◆ nodalValueOlder()

const Real & MooseVariableFE< Real >::nodalValueOlder ( ) const

inherited

Definition at line 611 of file MooseVariableFE.C.

 {
   return _element_data->nodalValue(Moose::Older);
 }

◆ nodalValueOlderArray()

const MooseArray<Real >& MooseVariableFE< Real >::nodalValueOlderArray ( ) const

inlineoverridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 691 of file MooseVariableFE.h.

   {
     return _element_data->nodalValueArray(Moose::Older);
   }

◆ nodalValueOlderNeighbor()

const Real & MooseVariableFE< Real >::nodalValueOlderNeighbor ( ) const

inherited

Definition at line 618 of file MooseVariableFE.C.

 {
   return _neighbor_data->nodalValue(Moose::Older);
 }

◆ nodalValueOldNeighbor()

const Real & MooseVariableFE< Real >::nodalValueOldNeighbor ( ) const

inherited

Definition at line 604 of file MooseVariableFE.C.

 {
   return _neighbor_data->nodalValue(Moose::Old);
 }

◆ nodalValuePreviousNL()

const Real & MooseVariableFE< Real >::nodalValuePreviousNL ( ) const

inherited

Definition at line 625 of file MooseVariableFE.C.

 {
   return _element_data->nodalValue(Moose::PreviousNL);
 }

◆ nodalValuePreviousNLNeighbor()

const Real & MooseVariableFE< Real >::nodalValuePreviousNLNeighbor ( ) const

inherited

Definition at line 632 of file MooseVariableFE.C.

 {
   return _neighbor_data->nodalValue(Moose::PreviousNL);
 }

◆ nodalVectorTagValue()

const MooseVariableFE< Real >::DoFValue & MooseVariableFE< Real >::nodalVectorTagValue ( TagID tag ) const

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 583 of file MooseVariableFE.C.

 {
   return _element_data->nodalVectorTagValue(tag);
 }

◆ node()

const Node* const& MooseVariableFE< Real >::node ( ) const

inlineinherited

Definition at line 150 of file MooseVariableFE.h.

150 { return _element_data->node(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ nodeNeighbor()

const Node* const& MooseVariableFE< Real >::nodeNeighbor ( ) const

inlineinherited

Definition at line 154 of file MooseVariableFE.h.

154 { return _neighbor_data->node(); }

MooseVariableBase::_var_num

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ number()

unsigned int MooseVariableBase::number ( ) const

inlineinherited

Get variable number coming from libMesh.

Returns: the libmesh variable number

Definition at line 52 of file MooseVariableBase.h.

52 { return _var_num; }

unsigned int _var_num

variable number (from libMesh)

Definition: MooseVariableBase.h:204

◆ numberOfDofs()

unsigned int MooseVariableFE< Real >::numberOfDofs ( ) const

inlinefinalvirtualinherited

Get the number of local DoFs.

Reimplemented from MooseVariableBase.

Definition at line 176 of file MooseVariableFE.h.

176 { return _element_data->numberOfDofs(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ numberOfDofsNeighbor()

unsigned int MooseVariableFE< Real >::numberOfDofsNeighbor ( )

inlineoverridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 188 of file MooseVariableFE.h.

188 { return _neighbor_data->dofIndices().size(); }

Referenced by FEProblemBase::checkDisplacementOrders(), AuxScalarKernel::compute(), ScalarInitialCondition::compute(), ADScalarKernel::computeADJacobian(), ODEKernel::computeJacobian(), FVBoundaryScalarLagrangeMultiplierConstraint::computeJacobian(), FVScalarLagrangeMultiplierConstraint::computeOffDiagJacobian(), ODEKernel::computeOffDiagJacobianScalar(), Kernel::computeOffDiagJacobianScalar(), ScalarLagrangeMultiplier::computeOffDiagJacobianScalar(), MortarScalarBase::computeOffDiagJacobianScalar(), KernelScalarBase::computeOffDiagJacobianScalarLocal(), ArrayDGDiffusion::computeQpJacobian(), DGDiffusion::computeQpJacobian(), DGFunctionDiffusionDirichletBC::computeQpJacobian(), ArrayIntegratedBC::computeQpOffDiagJacobianScalar(), ArrayKernel::computeQpOffDiagJacobianScalar(), ADDGDiffusion::computeQpResidual(), DGDiffusion::computeQpResidual(), DGFunctionDiffusionDirichletBC::computeQpResidual(), ScalarKernel::computeResidual(), ADScalarKernel::computeResidual(), ODETimeKernel::computeResidual(), ODEKernel::computeResidual(), FVScalarLagrangeMultiplierConstraint::computeResidual(), FVBoundaryScalarLagrangeMultiplierConstraint::computeResidual(), KernelScalarBase::computeScalarOffDiagJacobianScalar(), MortarScalarBase::computeScalarOffDiagJacobianScalar(), ProjectionAux::computeValue(), ScalarCoupleable::coupledScalarOrder(), MultiAppPostprocessorToAuxScalarTransfer::execute(), FunctionScalarAux::FunctionScalarAux(), GapValueAux::GapValueAux(), ArrayDGDiffusion::initQpResidual(), NodalPatchRecovery::NodalPatchRecovery(), FEProblemBase::projectInitialConditionOnCustomRange(), ProjectionAux::ProjectionAux(), FEProblemBase::projectSolution(), and ScalarComponentIC::ScalarComponentIC().

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ numBlocks()

unsigned int BlockRestrictable::numBlocks ( ) const

inherited

Return the number of blocks for this object.

Returns: The number of subdomains

Definition at line 203 of file BlockRestrictable.C.

Referenced by ElementCentroidPositions::initialize(), and QuadraturePointsPositions::initialize().

 {
   return (unsigned int)_blk_ids.size();
 }

◆ oldestSolutionStateRequested()

unsigned int MooseVariableFE< Real >::oldestSolutionStateRequested ( ) const

finaloverridevirtualinherited

The oldest solution state that is requested for this variable (0 = current, 1 = old, 2 = older, etc).

Implements MooseVariableFieldBase.

Definition at line 843 of file MooseVariableFE.C.

 {
   unsigned int state = 0;
   state = std::max(state, _element_data->oldestSolutionStateRequested());
   state = std::max(state, _neighbor_data->oldestSolutionStateRequested());
   state = std::max(state, _lower_data->oldestSolutionStateRequested());
   return state;
 }

◆ operator()() [1/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemArg &	elem,
		const StateArg &	state
	)		const

inherited

Same as their evaluate overloads with the same arguments but allows for caching implementation.

These are the methods a user will call in their code

Definition at line 597 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem, state);
 
   mooseAssert(state.state == 0,
               "Cached evaluations are only currently supported for the current state.");
 
   return queryFVArgCache(_elem_arg_to_value, elem);
 }

◆ operator()() [2/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const FaceArg &	face,
		const StateArg &	state
	)		const

inherited

Definition at line 610 of file MooseFunctor.h.

 {
   checkFace(face_in);
 
   if (_always_evaluate)
     return evaluate(face_in, state);
 
   mooseAssert(state.state == 0,
               "Cached evaluations are only currently supported for the current state.");
 
   return queryFVArgCache(_face_arg_to_value, face_in);
 }

◆ operator()() [3/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 656 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem_qp, state);
 
   const auto elem_id = elem_qp.elem->id();
   if (elem_id != _current_qp_map_key)
   {
     _current_qp_map_key = elem_id;
     _current_qp_map_value = &_qp_to_value[elem_id];
   }
   auto & qp_data = *_current_qp_map_value;
   const auto qp = elem_qp.qp;
   const auto * const qrule = elem_qp.qrule;
   mooseAssert(qrule, "qrule must be non-null");
 
   return queryQpCache(qp, *qrule, qp_data, elem_qp, state);
 }

◆ operator()() [4/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemSideQpArg &	qp,
		const StateArg &	state
	)		const

inherited

Definition at line 677 of file MooseFunctor.h.

 {
   if (_always_evaluate)
     return evaluate(elem_side_qp, state);
 
   const Elem * const elem = elem_side_qp.elem;
   mooseAssert(elem, "elem must be non-null");
   const auto elem_id = elem->id();
   if (elem_id != _current_side_qp_map_key)
   {
     _current_side_qp_map_key = elem_id;
     _current_side_qp_map_value = &_side_qp_to_value[elem_id];
   }
   auto & side_qp_data = *_current_side_qp_map_value;
   const auto side = elem_side_qp.side;
   const auto qp = elem_side_qp.qp;
   const auto * const qrule = elem_side_qp.qrule;
   mooseAssert(qrule, "qrule must be non-null");
 
   // Check and see whether we even have sized for this side
   if (side >= side_qp_data.size())
     side_qp_data.resize(elem->n_sides());
 
   // Ok we were sized enough for our side
   auto & qp_data = side_qp_data[side];
   return queryQpCache(qp, *qrule, qp_data, elem_side_qp, state);
 }

◆ operator()() [5/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const ElemPointArg &	elem_point,
		const StateArg &	state
	)		const

inherited

Definition at line 707 of file MooseFunctor.h.

 {
   return evaluate(elem_point, state);
 }

◆ operator()() [6/6]

template<typename T >

FunctorBase< T >::ValueType Moose::FunctorBase< T >::operator()	(	const NodeArg &	node,
		const StateArg &	state
	)		const

inherited

Definition at line 724 of file MooseFunctor.h.

 {
   mooseAssert(node.subdomain_ids, "Subdomain IDs must be supplied to the node argument");
   return evaluate(node, state);
 }

◆ order()

Order MooseVariableBase::order ( ) const

inherited

Get the order of this variable Note: Order enum can be implicitly converted to unsigned int.

Definition at line 213 of file MooseVariableBase.C.

 {
   return _fe_type.order;
 }

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::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 255 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::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 272 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

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

◆ paramWarning()

template<typename... Args>

void MooseBaseParameterInterface::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 265 of file MooseBaseParameterInterface.h.

Referenced by GridPartitioner::_do_partition(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

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

◆ phi()

const FieldVariablePhiValue& MooseVariableFE< Real >::phi ( ) const

inlineoverridevirtualinherited

Return the variable's elemental shape functions.

Implements MooseVariableField< Real >.

Definition at line 190 of file MooseVariableFE.h.

190 { return _element_data->phi(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ phiFace()

const FieldVariablePhiValue& MooseVariableFE< Real >::phiFace ( ) const

inlinefinaloverridevirtualinherited

Return the variable's shape functions on an element face.

Implements MooseVariableField< Real >.

Definition at line 203 of file MooseVariableFE.h.

203 { return _element_data->phiFace(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ phiFaceNeighbor()

const FieldVariablePhiValue& MooseVariableFE< Real >::phiFaceNeighbor ( ) const

inlinefinaloverridevirtualinherited

Return the variable's shape functions on a neighboring element face.

Implements MooseVariableField< Real >.

Definition at line 229 of file MooseVariableFE.h.

   {
     return _neighbor_data->phiFace();
   }

◆ phiFaceNeighborSize()

virtual std::size_t MooseVariableFE< Real >::phiFaceNeighborSize ( ) const

inlinefinalvirtualinherited

Return phiFaceNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 653 of file MooseVariableFE.h.

653 { return _neighbor_data->phiFaceSize(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ phiFaceSize()

virtual std::size_t MooseVariableFE< Real >::phiFaceSize ( ) const

inlinefinalvirtualinherited

Return phiFace size.

Implements MooseVariableFieldBase.

Definition at line 645 of file MooseVariableFE.h.

645 { return _element_data->phiFaceSize(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ phiLower()

virtual const FieldVariablePhiValue& MooseVariableFE< Real >::phiLower ( ) const

inlineoverridevirtualinherited

Return the variable's shape functions on a lower-dimensional element.

Implements MooseVariableField< Real >.

Definition at line 245 of file MooseVariableFE.h.

245 { return _lower_data->phi(); }

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

◆ phiLowerSize()

std::size_t MooseVariableFE< Real >::phiLowerSize ( ) const

inlinefinalvirtualinherited

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

Implements MooseVariableFieldBase.

Definition at line 655 of file MooseVariableFE.h.

655 { return _lower_data->phiSize(); }

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

◆ phiNeighbor()

const FieldVariablePhiValue& MooseVariableFE< Real >::phiNeighbor ( ) const

inlinefinaloverridevirtualinherited

Return the variable's shape functions on a neighboring element.

Implements MooseVariableField< Real >.

Definition at line 216 of file MooseVariableFE.h.

216 { return _neighbor_data->phi(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ phiNeighborSize()

virtual std::size_t MooseVariableFE< Real >::phiNeighborSize ( ) const

inlinefinalvirtualinherited

Return phiNeighbor size.

Implements MooseVariableFieldBase.

Definition at line 649 of file MooseVariableFE.h.

649 { return _neighbor_data->phiSize(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ phiSize()

virtual std::size_t MooseVariableFE< Real >::phiSize ( ) const

inlinefinalvirtualinherited

Return phi size.

Implements MooseVariableFieldBase.

Definition at line 641 of file MooseVariableFE.h.

641 { return _element_data->phiSize(); }

MooseVariableBase::_scaling_factor

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ prepare()

void MooseVariableFE< Real >::prepare ( )

overridevirtualinherited

Prepare the elemental degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 94 of file MooseVariableFE.C.

 {
   _element_data->prepare();
 }

◆ prepareAux()

void MooseVariableFE< Real >::prepareAux ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 115 of file MooseVariableFE.C.

 {
   _element_data->prepareAux();
   _neighbor_data->prepareAux();
   _lower_data->prepareAux();
 }

◆ prepareIC()

void MooseVariableFE< Real >::prepareIC ( )

overridevirtualinherited

Prepare the initial condition.

Implements MooseVariableFieldBase.

Definition at line 392 of file MooseVariableFE.C.

 {
   _element_data->prepareIC();
 }

◆ prepareLowerD()

void MooseVariableFE< Real >::prepareLowerD ( )

overridevirtualinherited

Prepare a lower dimensional element's degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 108 of file MooseVariableFE.C.

 {
   _lower_data->prepare();
 }

◆ prepareNeighbor()

void MooseVariableFE< Real >::prepareNeighbor ( )

overridevirtualinherited

Prepare the neighbor element degrees of freedom.

Implements MooseVariableFieldBase.

Definition at line 101 of file MooseVariableFE.C.

 {
   _neighbor_data->prepare();
 }

◆ queryParam()

template<typename T >

const T * MooseBaseParameterInterface::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 222 of file MooseBaseParameterInterface.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ reinitAux()

void MooseVariableFE< Real >::reinitAux ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 131 of file MooseVariableFE.C.

 {
   _element_data->reinitAux();
 }

◆ reinitAuxNeighbor()

void MooseVariableFE< Real >::reinitAuxNeighbor ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 138 of file MooseVariableFE.C.

 {
   _neighbor_data->reinitAux();
 }

◆ reinitNode()

void MooseVariableFE< Real >::reinitNode ( )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 124 of file MooseVariableFE.C.

 {
   _element_data->reinitNode();
 }

◆ reinitNodes()

void MooseVariableFE< Real >::reinitNodes ( const std::vector< dof_id_type > & nodes )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 145 of file MooseVariableFE.C.

 {
   _element_data->reinitNodes(nodes);
 }

◆ reinitNodesNeighbor()

void MooseVariableFE< Real >::reinitNodesNeighbor ( const std::vector< dof_id_type > & nodes )

overridevirtualinherited

Implements MooseVariableFieldBase.

Definition at line 152 of file MooseVariableFE.C.

 {
   _neighbor_data->reinitNodes(nodes);
 }

◆ residualSetup()

void MooseVariableFE< Real >::residualSetup ( )

overridevirtualinherited

Reimplemented from MooseVariableField< Real >.

Definition at line 1363 of file MooseVariableFE.C.

 {
   _current_elem_qp_functor_elem = nullptr;
   _current_elem_side_qp_functor_elem_side = std::make_pair(nullptr, libMesh::invalid_uint);
   MooseVariableField<OutputType>::residualSetup();
 }

◆ scalingFactor() [1/2]

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

inherited

Set the scaling factor for this variable.

Definition at line 239 of file MooseVariableBase.C.

 {
   mooseAssert(factor.size() == _count, "Inconsistent scaling factor size");
   for (const auto i : make_range(_count))
     _scaling_factor[i] = factor[i];
 }

◆ scalingFactor() [2/2]

Real MooseVariableBase::scalingFactor ( ) const

inlineinherited

Get the scaling factor for this variable.

Definition at line 98 of file MooseVariableBase.h.

Referenced by MooseVariableBase::MooseVariableBase().

98 { return _scaling_factor[0]; }

std::vector< Real > _scaling_factor

scaling factor for this variable

Definition: MooseVariableBase.h:240

◆ secondPhi()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhi ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's elemental shape functions.

Implements MooseVariableField< Real >.

Definition at line 717 of file MooseVariableFE.C.

 {
   return _element_data->secondPhi();
 }

◆ secondPhiFace()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiFace ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on an element face.

Implements MooseVariableField< Real >.

Definition at line 738 of file MooseVariableFE.C.

 {
   return _element_data->secondPhiFace();
 }

◆ secondPhiFaceNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiFaceNeighbor ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element face.

Implements MooseVariableField< Real >.

Definition at line 780 of file MooseVariableFE.C.

 {
   return _neighbor_data->secondPhiFace();
 }

◆ secondPhiNeighbor()

const MooseVariableFE< Real >::FieldVariablePhiSecond & MooseVariableFE< Real >::secondPhiNeighbor ( ) const

finaloverridevirtualinherited

Return the rank-2 tensor of second derivatives of the variable's shape functions on a neighboring element.

Implements MooseVariableField< Real >.

Definition at line 759 of file MooseVariableFE.C.

 {
   return _neighbor_data->secondPhi();
 }

◆ secondSln()

const FieldVariableSecond& MooseVariableFE< Real >::secondSln ( ) const

inlineinherited

element seconds

Definition at line 312 of file MooseVariableFE.h.

312 { return _element_data->secondSln(Moose::Current); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Definition: MooseTypes.h:235

◆ secondSlnNeighbor()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnNeighbor ( ) const

inlineinherited

neighbor solution seconds

Definition at line 446 of file MooseVariableFE.h.

   {
     return _neighbor_data->secondSln(Moose::Current);
   }

◆ secondSlnOld()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnOld ( ) const

inlineinherited

Definition at line 313 of file MooseVariableFE.h.

313 { return _element_data->secondSln(Moose::Old); }

Definition: MooseTypes.h:236

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ secondSlnOlder()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnOlder ( ) const

inlineinherited

Definition at line 314 of file MooseVariableFE.h.

   {
     return _element_data->secondSln(Moose::Older);
   }

◆ secondSlnOlderNeighbor()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnOlderNeighbor ( ) const

inlineinherited

Definition at line 454 of file MooseVariableFE.h.

   {
     return _neighbor_data->secondSln(Moose::Older);
   }

◆ secondSlnOldNeighbor()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnOldNeighbor ( ) const

inlineinherited

Definition at line 450 of file MooseVariableFE.h.

   {
     return _neighbor_data->secondSln(Moose::Old);
   }

◆ secondSlnPreviousNL()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnPreviousNL ( ) const

inlineinherited

Definition at line 318 of file MooseVariableFE.h.

   {
     return _element_data->secondSln(Moose::PreviousNL);
   }

◆ secondSlnPreviousNLNeighbor()

const FieldVariableSecond& MooseVariableFE< Real >::secondSlnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 458 of file MooseVariableFE.h.

   {
     return _neighbor_data->secondSln(Moose::PreviousNL);
   }

◆ setActiveTags()

void MooseVariableFE< Real >::setActiveTags ( const std::set< TagID > & vtags )

overridevirtualinherited

Set the active vector tags.

Parameters

vtags Additional vector tags that this variable will need to query at dof indices for, in addition to our own required solution tags

Reimplemented from MooseVariableBase.

Definition at line 865 of file MooseVariableFE.h.

 {
   _element_data->setActiveTags(vtags);
   _neighbor_data->setActiveTags(vtags);
   _lower_data->setActiveTags(vtags);
 }

◆ setCacheClearanceSchedule()

template<typename T >

void Moose::FunctorBase< T >::setCacheClearanceSchedule ( const std::set< ExecFlagType > & clearance_schedule )

inherited

Set how often to clear the functor evaluation cache.

Definition at line 714 of file MooseFunctor.h.

 {
   if (clearance_schedule.count(EXEC_ALWAYS))
     _always_evaluate = true;
 
   _clearance_schedule = clearance_schedule;
 }

◆ setDofValue() [1/2]

virtual void MooseVariableField< Real >::setDofValue	(	const OutputData &	value,
		unsigned int	index
	)

pure virtualinherited

Degree of freedom value setters.

Implemented in MooseLinearVariableFV< Real >, and MooseVariableFV< Real >.

◆ setDofValue() [2/2]

void MooseVariableFE< Real >::setDofValue	(	const OutputData &	value,
		unsigned int	index
	)

overridevirtualinherited

Degree of freedom value setters.

Definition at line 688 of file MooseVariableFE.C.

 {
   _element_data->setDofValue(value, index);
 }

◆ setDofValues() [1/2]

virtual void MooseVariableField< Real >::setDofValues ( const DenseVector< OutputData > & values )

pure virtualinherited

Set local DOF values and evaluate the values on quadrature points.

Implemented in MooseVariableFV< Real >, and MooseLinearVariableFV< Real >.

◆ setDofValues() [2/2]

void MooseVariableFE< Real >::setDofValues ( const DenseVector< OutputData > & values )

overridevirtualinherited

Set local DOF values and evaluate the values on quadrature points.

Definition at line 695 of file MooseVariableFE.C.

 {
   _element_data->setDofValues(values);
 }

◆ setLowerDofValues() [1/2]

virtual void MooseVariableField< Real >::setLowerDofValues ( const DenseVector< OutputData > & values )

pure virtualinherited

Set local DOF values for a lower dimensional element and evaluate the values on quadrature points.

Implemented in MooseVariableFV< Real >, and MooseLinearVariableFV< Real >.

◆ setLowerDofValues() [2/2]

void MooseVariableFE< Real >::setLowerDofValues ( const DenseVector< OutputData > & values )

overridevirtualinherited

Set local DOF values for a lower dimensional element and evaluate the values on quadrature points.

Definition at line 702 of file MooseVariableFE.C.

 {
   _lower_data->setDofValues(values);
 }

◆ setNodalValue()

void MooseVariableFE< Real >::setNodalValue	(	const Real &	value,
		unsigned int	idx = `0`
	)

overridevirtualinherited

Implements MooseVariableField< Real >.

Definition at line 681 of file MooseVariableFE.C.

 {
   _element_data->setNodalValue(value, idx);
 }

◆ sln()

const FieldVariableValue& MooseVariableFE< Real >::sln ( ) const

inlineoverridevirtualinherited

element solutions

Implements MooseVariableField< Real >.

Definition at line 284 of file MooseVariableFE.h.

284 { return _element_data->sln(Moose::Current); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Definition: MooseTypes.h:235

◆ slnLower()

const FieldVariableValue& MooseVariableFE< Real >::slnLower ( ) const

inlineinherited

Definition at line 501 of file MooseVariableFE.h.

501 { return _lower_data->sln(Moose::Current); }

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

Definition: MooseTypes.h:235

◆ slnLowerOld()

const FieldVariableValue& MooseVariableFE< Real >::slnLowerOld ( ) const

inlineinherited

Definition at line 502 of file MooseVariableFE.h.

502 { return _lower_data->sln(Moose::Old); }

std::unique_ptr< MooseVariableData< Real > > _lower_data

Holder for all the data associated with the lower dimeensional element.

Definition: MooseVariableFE.h:725

Definition: MooseTypes.h:236

◆ slnNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::slnNeighbor ( ) const

inlineoverridevirtualinherited

neighbor solutions

Implements MooseVariableField< Real >.

Definition at line 406 of file MooseVariableFE.h.

   {
     return _neighbor_data->sln(Moose::Current);
   }

◆ slnOld()

const FieldVariableValue& MooseVariableFE< Real >::slnOld ( ) const

inlineoverridevirtualinherited

Returns: the old elemental solution, e.g. that of the previous timestep

Implements MooseVariableField< Real >.

Definition at line 285 of file MooseVariableFE.h.

285 { return _element_data->sln(Moose::Old); }

Definition: MooseTypes.h:236

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ slnOlder()

const FieldVariableValue& MooseVariableFE< Real >::slnOlder ( ) const

inlineoverridevirtualinherited

Returns: the older elemental solution, e.g. that of two timesteps ago

Implements MooseVariableField< Real >.

Definition at line 286 of file MooseVariableFE.h.

286 { return _element_data->sln(Moose::Older); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

Moose::Older

Definition: MooseTypes.h:237

◆ slnOlderNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::slnOlderNeighbor ( ) const

inlineinherited

Definition at line 414 of file MooseVariableFE.h.

414 { return _neighbor_data->sln(Moose::Older); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

Moose::Older

Definition: MooseTypes.h:237

◆ slnOldNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::slnOldNeighbor ( ) const

inlineoverridevirtualinherited

Returns: the old neighbor solution, e.g. that of the previous timestep

Implements MooseVariableField< Real >.

Definition at line 410 of file MooseVariableFE.h.

   {
     return _neighbor_data->sln(Moose::Old);
   }

◆ slnPreviousNL()

const FieldVariableValue& MooseVariableFE< Real >::slnPreviousNL ( ) const

inlineinherited

Definition at line 287 of file MooseVariableFE.h.

287 { return _element_data->sln(Moose::PreviousNL); }

Moose::PreviousNL

Definition: MooseTypes.h:238

MooseVariableBase::allDofIndices

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ slnPreviousNLNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::slnPreviousNLNeighbor ( ) const

inlineinherited

Definition at line 415 of file MooseVariableFE.h.

   {
     return _neighbor_data->sln(Moose::PreviousNL);
   }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ supportsElemSideQpArg()

bool MooseVariableFE< Real >::supportsElemSideQpArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with ElemSideQpArg.

Implements Moose::FunctorBase< T >.

Definition at line 713 of file MooseVariableFE.h.

713 { return true; }

◆ supportsFaceArg()

bool MooseVariableFE< Real >::supportsFaceArg ( ) const

inlinefinaloverridevirtualinherited

Whether this functor supports evaluation with FaceArg.

Implements Moose::FunctorBase< T >.

Definition at line 712 of file MooseVariableFE.h.

712 { return true; }

◆ sys() [1/2]

SystemBase& MooseVariableBase::sys ( )

inlineinherited

Get the system this variable is part of.

Definition at line 62 of file MooseVariableBase.h.

62 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:198

◆ sys() [2/2]

const SystemBase& MooseVariableBase::sys ( ) const

inlineinherited

Get the system this variable is part of.

Definition at line 67 of file MooseVariableBase.h.

67 { return _sys; }

MooseVariableBase::_sys

SystemBase & _sys

System this variable is part of.

Definition: MooseVariableBase.h:198

◆ timestepSetup()

void MooseVariableField< Real >::timestepSetup ( )

overridevirtualinherited

Reimplemented from Moose::FunctorBase< T >.

Reimplemented in MooseVariableFV< Real >.

Definition at line 52 of file MooseVariableField.C.

 {
   MooseVariableFieldBase::timestepSetup();
   FunctorBase<typename Moose::ADType<OutputType>::type>::timestepSetup();
 }

◆ totalVarDofs()

unsigned int MooseVariableBase::totalVarDofs ( )

inlineinherited

Definition at line 83 of file MooseVariableBase.h.

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

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

Get all global dofindices for the variable.

Definition: MooseVariableBase.C:201

◆ type()

const std::string& MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

Referenced by MaterialPropertyStorage::addProperty(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

 {
   return type() + std::string(" \"") + name() + std::string("\"");
 }

◆ uDot()

const FieldVariableValue& MooseVariableFE< Real >::uDot ( ) const

inlineinherited

element dots

Definition at line 398 of file MooseVariableFE.h.

398 { return _element_data->uDot(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ uDotDot()

const FieldVariableValue& MooseVariableFE< Real >::uDotDot ( ) const

inlineinherited

Definition at line 399 of file MooseVariableFE.h.

399 { return _element_data->uDotDot(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ uDotDotNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::uDotDotNeighbor ( ) const

inlineinherited

Definition at line 493 of file MooseVariableFE.h.

493 { return _neighbor_data->uDotDot(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ uDotDotOld()

const FieldVariableValue& MooseVariableFE< Real >::uDotDotOld ( ) const

inlineinherited

Definition at line 401 of file MooseVariableFE.h.

401 { return _element_data->uDotDotOld(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ uDotDotOldNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::uDotDotOldNeighbor ( ) const

inlineinherited

Definition at line 495 of file MooseVariableFE.h.

495 { return _neighbor_data->uDotDotOld(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ uDotNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::uDotNeighbor ( ) const

inlineinherited

neighbor dots

Definition at line 492 of file MooseVariableFE.h.

492 { return _neighbor_data->uDot(); }

std::unique_ptr< MooseVariableData< Real > > _neighbor_data

Holder for all the data associated with the neighbor element.

Definition: MooseVariableFE.h:722

◆ uDotOld()

const FieldVariableValue& MooseVariableFE< Real >::uDotOld ( ) const

inlineinherited

Definition at line 400 of file MooseVariableFE.h.

400 { return _element_data->uDotOld(); }

std::unique_ptr< MooseVariableData< Real > > _element_data

Holder for all the data associated with the "main" element.

Definition: MooseVariableFE.h:719

◆ uDotOldNeighbor()

const FieldVariableValue& MooseVariableFE< Real >::uDotOldNeighbor ( ) const

inlineinherited

Definition at line 494 of file MooseVariableFE.h.

494 { return _neighbor_data->uDotOld(); }