ADFunctionDirichletBC Class Reference

Boundary condition of a Dirichlet type. More...

#include <ADFunctionDirichletBC.h>

Inheritance diagram for ADFunctionDirichletBC:

Public Member Functions
	ADFunctionDirichletBC (const InputParameters &parameters)
virtual void	computeValue (NumericVector< Number > &current_solution) override
	Method to preset the nodal value if applicable.
const MooseVariableFE< T > &	variable () const override
bool	shouldSetComp (unsigned short i) const
MooseVariableBase *	mooseVariableBase () const
	Get the variable that this object is using.
MooseVariableField< T > &	mooseVariableField ()
	Return the MooseVariableField object that this interface acts on.
MooseVariableFE< T > *	mooseVariable () const
	Return the MooseVariableFE object that this interface acts on.
MooseVariableFV< T > *	mooseVariableFV () const
	Return the MooseVariableFV object that this interface acts on.
MooseLinearVariableFV< T > *	mooseLinearVariableFV () const
	Return the MooseLinearVariableFV object that this interface acts on.
template<>
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
template<>
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

Static Public Member Functions
static InputParameters	validParams ()
static std::string	deduceFunctorName (const std::string &name, const InputParameters &params)
	Helper to look up a functor name through the input parameter keys.

Protected Member Functions
virtual ADReal	computeQpValue () override
	Compute the value of the Dirichlet BC at the current quadrature point.
virtual Moose::ADType< Real >::type	computeQpResidual () override
	Compute this NodalBC's contribution to the residual at the current quadrature point.
virtual const OutputTools< T >::VariableValue &	value ()
	The value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	valueOld ()
	The old value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	valueOlder ()
	The older value of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dot ()
	The time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotDot ()
	The second time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotOld ()
	The old time derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableValue &	dotDotOld ()
	The old second time derivative of the variable this object is operating on.
virtual const VariableValue &	dotDu ()
	The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.
virtual const VariableValue &	dotDotDu ()
	The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.
virtual const OutputTools< T >::VariableGradient &	gradient ()
	The gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableGradient &	gradientOld ()
	The old gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableGradient &	gradientOlder ()
	The older gradient of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	second ()
	The second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	secondOld ()
	The old second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableSecond &	secondOlder ()
	The older second derivative of the variable this object is operating on.
virtual const OutputTools< T >::VariableTestSecond &	secondTest ()
	The second derivative of the test function.
virtual const OutputTools< T >::VariableTestSecond &	secondTestFace ()
	The second derivative of the test function on the current face.
virtual const OutputTools< T >::VariablePhiSecond &	secondPhi ()
	The second derivative of the trial function.
virtual const OutputTools< T >::VariablePhiSecond &	secondPhiFace ()
	The second derivative of the trial function on the current face.
std::string	deduceFunctorName (const std::string &name) const
	Small helper to look up a functor name through the input parameter keys.
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name)
	Retrieves a functor from the subproblem.
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, THREAD_ID tid)
	Retrieves a functor from the subproblem.
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem)
	Retrieves a functor from the passed-in subproblem.
template<typename T >
const Moose::Functor< T > &	getFunctor (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem.
bool	isFunctor (const std::string &name) const
	Checks the subproblem for the given functor.
bool	isFunctor (const std::string &name, const SubProblem &subproblem) const
	Checks the passed-in subproblem for the given functor.
Moose::ElemArg	makeElemArg (const Elem *elem, bool correct_skewnewss=false) const
	Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.
template<typename T >
void	checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
	Throws error if the functor does not support the requested side integration.
template<typename T >
const Moose::Functor< T > &	getFunctorByName (const std::string &name)
	Retrieves a functor from the subproblem.

Protected Attributes
const Function &	_function
	The function describing the Dirichlet condition.
	usingTransientInterfaceMembers
MooseVariableFE< T > &	_var
	The variable that this NodalBC operates on.
const Node *const &	_current_node
	current node being processed
const unsigned int	_qp = 0
	Pseudo-"quadrature point" index (Always zero for the current node)
const Moose::ADType< T >::type &	_u
	Value of the unknown variable this BC is acting on.
std::vector< bool >	_set_components
bool	_nodal
	Whether or not this object is acting only at nodes.
MooseVariableFE< T > *	_variable = nullptr
MooseVariableFV< T > *	_fv_variable = nullptr
MooseLinearVariableFV< T > *	_linear_fv_variable = nullptr
MooseVariableField< T > *	_field_variable = nullptr
Assembly *	_mvi_assembly

Private Member Functions
void	computeResidual () override final
void	computeJacobian () override final
void	computeResidualAndJacobian () override
void	computeOffDiagJacobian (unsigned int jvar) override final
void	computeOffDiagJacobianScalar (unsigned int jvar) override final
void	addResidual (const T &residual, const std::vector< dof_id_type > &dof_indices)
	process the residual into the global data structures
template<typename ADResidual >
void	addJacobian (const ADResidual &residual, const std::vector< dof_id_type > &dof_indices)
	process the Jacobian into the global data structures
virtual bool	isADObject () const override
	Whether this interface is for an AD object.
template<typename T >
const Moose::Functor< T > &	getFunctorByName (const std::string &name, SubProblem &subproblem, THREAD_ID tid)
	Retrieves a functor from the passed-in subproblem.
template<typename T >
const Moose::Functor< T > *	defaultFunctor (const std::string &name)
	Helper function to parse default functor values.
template<>
const Moose::Functor< Real > *	defaultFunctor (const std::string &name)
template<>
const Moose::Functor< ADReal > *	defaultFunctor (const std::string &name)

Private Attributes
Assembly &	_undisplaced_assembly
	A reference to the undisplaced assembly in order to ensure data gets correctly incorporated into the global residual/Jacobian.
const MooseObject &	_moose_object
const InputParameters &	_fi_params
	Parameters of the object with this interface.
const std::string	_fi_name
	The name of the object that this interface belongs to.
SubProblem *const	_fi_subproblem
	Pointer to subproblem if the subproblem pointer parameter was set.
const THREAD_ID	_fi_tid
	Current threaded it.
std::vector< std::unique_ptr< Moose::Functor< Real > > >	_default_real_functors
	Storage vector for Moose::Functor<Real> default objects.
std::vector< std::unique_ptr< Moose::Functor< ADReal > > >	_default_ad_real_functors
	Storage vector for Moose::Functor<ADReal> default objects.

Detailed Description

Boundary condition of a Dirichlet type.

Sets the values of a nodal variable at nodes to values specified by a function

Definition at line 19 of file ADFunctionDirichletBC.h.

Constructor & Destructor Documentation

ADFunctionDirichletBC()

ADFunctionDirichletBC::ADFunctionDirichletBC

(

const InputParameters &

parameters

)

Definition at line 27 of file ADFunctionDirichletBC.C.

  : ADDirichletBCBaseTempl<Real>(parameters), _function(getFunction("function"))
{
}

Member Function Documentation

addJacobian()

template<typename T , typename Base >

template<typename ADResidual >

void ADNodalBCTempl< T, Base >::addJacobian ( const ADResidual &  residual, const std::vector< dof_id_type > &  dof_indices  )

privateinherited

process the Jacobian into the global data structures

Definition at line 127 of file ADNodalBC.C.

{
  mooseAssert(dof_indices.size() <= _set_components.size(),
              "The number of dof indices must be less than the number of settable components");
  if (!std::is_same_v<T, RealVectorValue>)
    mooseAssert(dof_indices.size() == _var.count(),
                "The number of dof indices should match the variable count");
 
  for (const auto i : index_range(dof_indices))
    if (_set_components[i])
      // If we store into the displaced assembly for nodal bc objects the data never actually makes
      // it into the global Jacobian
      addJacobian(_undisplaced_assembly,
                  Moose::Span(&conversionHelper(residual, i), 1),
                  Moose::Span(&dof_indices[i], 1),
                  /*scaling_factor=*/1);
}

addResidual()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::addResidual ( const T &  residual, const std::vector< dof_id_type > &  dof_indices  )

privateinherited

process the residual into the global data structures

Definition at line 113 of file ADNodalBC.C.

{
  mooseAssert(dof_indices.size() <= _set_components.size(),
              "The number of dof indices must be less than the number of settable components");
 
  for (const auto i : index_range(dof_indices))
    if (_set_components[i])
      setResidual(_sys, conversionHelper(residual, i), dof_indices[i]);
}

checkFunctorSupportsSideIntegration()

template<typename T >

void FunctorInterface::checkFunctorSupportsSideIntegration ( const std::string &  name, bool  qp_integration  )

protectedinherited

Throws error if the functor does not support the requested side integration.

Parameters

[in]	name	Name of functor or functor parameter
[in]	qp_integration	True if performing qp integration, false if face info

Definition at line 261 of file FunctorInterface.h.

{
  const std::string functor_name = deduceFunctorName(name);
  const auto & functor = getFunctor<T>(name);
  if (qp_integration)
  {
    if (!functor.supportsElemSideQpArg())
      mooseError("Quadrature point integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
  else
  {
    if (!functor.supportsFaceArg())
      mooseError("Face info integration was requested, but the functor '",
                 functor_name,
                 "' does not support this.");
  }
}

computeJacobian()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::computeJacobian ( )

finaloverrideprivateinherited

Definition at line 161 of file ADNodalBC.C.

{
  const std::vector<dof_id_type> & dof_indices = _var.dofIndices();
  if (dof_indices.empty())
    return;
 
  const auto residual = computeQpResidual();
 
  addJacobian(residual, dof_indices);
}

computeOffDiagJacobian()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::computeOffDiagJacobian ( unsigned int  jvar )

finaloverrideprivateinherited

Definition at line 188 of file ADNodalBC.C.

{
  // Only need to do this once because AD does all the derivatives at once
  if (jvar_num == _var.number())
    computeJacobian();
}

computeOffDiagJacobianScalar()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::computeOffDiagJacobianScalar ( unsigned int  jvar )

finaloverrideprivateinherited

Definition at line 197 of file ADNodalBC.C.

{
  // scalar coupling will have been included in the all-at-once handling in computeOffDiagJacobian
}

computeQpResidual()

Moose::ADType< Real >::type ADDirichletBCBaseTempl< Real >::computeQpResidual ( )

overrideprotectedvirtualinherited

Compute this NodalBC's contribution to the residual at the current quadrature point.

Implements ADNodalBCTempl< T, Base >.

Definition at line 32 of file ADDirichletBCBaseTempl.C.

{
  return _u - computeQpValue();
}

computeQpValue()

ADReal ADFunctionDirichletBC::computeQpValue ( )

overrideprotectedvirtual

Compute the value of the Dirichlet BC at the current quadrature point.

Implements ADDirichletBCBaseTempl< Real >.

Definition at line 33 of file ADFunctionDirichletBC.C.

{
  return _function.value(_t, *_current_node);
}

computeResidual()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::computeResidual ( )

finaloverrideprivateinherited

Definition at line 148 of file ADNodalBC.C.

{
  const std::vector<dof_id_type> & dof_indices = _var.dofIndices();
  if (dof_indices.empty())
    return;
 
  const auto residual = MetaPhysicL::raw_value(computeQpResidual());
 
  addResidual(residual, dof_indices);
}

computeResidualAndJacobian()

template<typename T , typename Base >

void ADNodalBCTempl< T, Base >::computeResidualAndJacobian ( )

overrideprivateinherited

Definition at line 174 of file ADNodalBC.C.

{
  const std::vector<dof_id_type> & dof_indices = _var.dofIndices();
  if (dof_indices.empty())
    return;
 
  const auto residual = computeQpResidual();
 
  addResidual(MetaPhysicL::raw_value(residual), dof_indices);
  addJacobian(residual, dof_indices);
}

computeValue()

void ADDirichletBCBaseTempl< Real >::computeValue ( NumericVector< Number > &  current_solution )

overridevirtualinherited

Method to preset the nodal value if applicable.

Definition at line 27 of file ADDirichletBCBaseTempl.C.

{
  mooseAssert(this->_preset, "BC is not preset");
 
  if (_var.isNodalDefined())
  {
    const auto n_comp = _current_node->n_comp(_sys.number(), _var.number());
    const auto value = MetaPhysicL::raw_value(computeQpValue());
    for (const auto i : make_range(n_comp))
    {
      const auto dof_idx = _current_node->dof_number(_sys.number(), _var.number(), i);
      if constexpr (std::is_same<T, Real>::value)
      {
        mooseAssert(n_comp == 1, "This should only be unity");
        current_solution.set(dof_idx, value);
      }
      else
      {
        if (shouldSetComp(i))
          current_solution.set(dof_idx, value(i));
      }
    }
  }
}

deduceFunctorName() [1/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name ) const

protectedinherited

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

Definition at line 71 of file FunctorInterface.C.

{
  return deduceFunctorName(name, _fi_params);
}

deduceFunctorName() [2/2]

std::string FunctorInterface::deduceFunctorName ( const std::string &  name, const InputParameters &  params  )

staticinherited

Helper to look up a functor name through the input parameter keys.

Parameters

name	The input parameter name that we are trying to deduce the functor name for
params	The input parameters object that we will be checking for parameters named name

Returns

The functor name

Definition at line 39 of file FunctorInterface.C.

{
  if (params.isParamValid(name))
  {
    if (params.have_parameter<MooseFunctorName>(name))
      return params.get<MooseFunctorName>(name);
    // variables, functor material properties, functions, and post-processors are also functors
    else if (params.have_parameter<MaterialPropertyName>(name))
      return params.get<MaterialPropertyName>(name);
    else if (params.have_parameter<VariableName>(name))
      return params.get<VariableName>(name);
    else if (params.have_parameter<std::vector<VariableName>>(name))
    {
      const auto & var_names = params.get<std::vector<VariableName>>(name);
      if (var_names.size() != 1)
        mooseError("We only support a single variable name for retrieving a functor");
      return var_names[0];
    }
    else if (params.have_parameter<NonlinearVariableName>(name))
      return params.get<NonlinearVariableName>(name);
    else if (params.have_parameter<FunctionName>(name))
      return params.get<FunctionName>(name);
    else if (params.have_parameter<PostprocessorName>(name))
      return params.get<PostprocessorName>(name);
    else
      mooseError("Invalid parameter type for retrieving a functor");
  }
  else
    return name;
}

Referenced by FunctorInterface::checkFunctorSupportsSideIntegration(), FunctorInterface::deduceFunctorName(), FunctorInterface::getFunctor(), and FunctorInterface::isFunctor().

defaultFunctor() [1/5]

template<typename T >

const Moose::Functor< T > * FunctorInterface::defaultFunctor ( const std::string &  name )

privateinherited

Helper function to parse default functor values.

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

Definition at line 254 of file FunctorInterface.h.

{
  return nullptr;
}

defaultFunctor() [2/5]

template<>

const Moose::Functor< Real > * FunctorInterface::defaultFunctor ( const std::string &  name )

privateinherited

defaultFunctor() [3/5]

template<>

const Moose::Functor< ADReal > * FunctorInterface::defaultFunctor ( const std::string &  name )

privateinherited

defaultFunctor() [4/5]

template<>

const Moose::Functor< Real > * FunctorInterface::defaultFunctor ( const std::string &  name )

inherited

Definition at line 78 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;
 
  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_real_functors.emplace_back(std::make_unique<Moose::Functor<Real>>(
        std::make_unique<Moose::ConstantFunctor<Real>>(real_value)));
    auto & default_property = _default_real_functors.back();
    return default_property.get();
  }
 
  return nullptr;
}

defaultFunctor() [5/5]

template<>

const Moose::Functor< ADReal > * FunctorInterface::defaultFunctor ( const std::string &  name )

inherited

Definition at line 97 of file FunctorInterface.C.

{
  std::istringstream ss(name);
  Real real_value;
 
  // check if the string parsed cleanly into a Real number
  if (ss >> real_value && ss.eof())
  {
    _default_ad_real_functors.emplace_back(std::make_unique<Moose::Functor<ADReal>>(
        std::make_unique<Moose::ConstantFunctor<ADReal>>(real_value)));
    auto & default_property = _default_ad_real_functors.back();
    return default_property.get();
  }
 
  return nullptr;
}

dot()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dot ( )

protectedvirtualinherited

The time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 148 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDot();
  else
    return _variable->uDot();
}

dotDot()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotDot ( )

protectedvirtualinherited

The second time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 158 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDot();
  else
    return _variable->uDotDot();
}

dotDotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::dotDotDu ( )

protectedvirtualinherited

The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dotdot

Returns

The reference to be stored off and used later.

Definition at line 238 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDotDu();
  else
    return _variable->duDotDotDu();
}

dotDotOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotDotOld ( )

protectedvirtualinherited

The old second time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 178 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotDotOld();
  else
    return _variable->uDotDotOld();
}

dotDu()

template<typename T >

const VariableValue & MooseVariableInterface< T >::dotDu ( )

protectedvirtualinherited

The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients.

This is useful for creating Jacobian entries for residual statements that use _u_dot

Returns

The reference to be stored off and used later.

Definition at line 228 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDuDotDu();
  else
    return _variable->duDotDu();
}

dotOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::dotOld ( )

protectedvirtualinherited

The old time derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 168 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesDotOld();
  else
    return _variable->uDotOld();
}

getFunctor() [1/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file

Returns

The functor

Definition at line 217 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, _fi_tid);
}

Referenced by GenericFunctorGradientMaterialTempl< is_ad >::GenericFunctorGradientMaterialTempl(), GenericFunctorMaterialTempl< is_ad >::GenericFunctorMaterialTempl(), GenericVectorFunctorMaterialTempl< is_ad >::GenericVectorFunctorMaterialTempl(), MaterialFunctorConverterTempl< T >::MaterialFunctorConverterTempl(), and ParsedFunctorMaterialTempl< is_ad >::ParsedFunctorMaterialTempl().

getFunctor() [2/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem  )

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

The functor

Definition at line 202 of file FunctorInterface.h.

{
  return getFunctor<T>(name, subproblem, _fi_tid);
}

getFunctor() [3/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, SubProblem &  subproblem, THREAD_ID  tid  )

protectedinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the subproblem

Returns

The functor

Definition at line 193 of file FunctorInterface.h.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
  return getFunctorByName<T>(functor_name, subproblem, tid);
}

getFunctor() [4/4]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctor ( const std::string &  name, THREAD_ID  tid  )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
tid	The thread ID used to retrieve the functor from this interface's subproblem

Returns

The functor

Definition at line 209 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctor<T>(name, *_fi_subproblem, tid);
}

getFunctorByName() [1/2]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctorByName ( const std::string &  name )

protectedinherited

Retrieves a functor from the subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The name of the functor to retrieve. This should match the actual name of the functor created in the input file

Returns

The functor

Definition at line 225 of file FunctorInterface.h.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return getFunctorByName<T>(name, *_fi_subproblem, _fi_tid);
}

getFunctorByName() [2/2]

template<typename T >

const Moose::Functor< T > & FunctorInterface::getFunctorByName ( const std::string &  name, SubProblem &  subproblem, THREAD_ID  tid  )

privateinherited

Retrieves a functor from the passed-in subproblem.

This method also leverages the ability to create default functors if the user passed an integer or real in the input file

Parameters

name	The actual name of the functor to retrieve instead of the parameter name
subproblem	The subproblem to query for the functor
tid	The thread ID used to retrieve the functor from the subproblem

Returns

The functor

Definition at line 233 of file FunctorInterface.h.

{
  // Check if it's just a constant
  const auto * const default_functor = defaultFunctor<T>(name);
  if (default_functor)
    return *default_functor;
 
  return subproblem.getFunctor<T>(name, tid, _fi_name, isADObject());
}

gradient()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradient ( )

protectedvirtualinherited

The gradient of the variable this object is operating on.

This is computed by default and should already be available as _grad_u

Returns

The reference to be stored off and used later.

Definition at line 248 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSln();
}

Referenced by DiffusionFluxAux::computeValue().

gradientOld()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradientOld ( )

protectedvirtualinherited

The old gradient of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 258 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOld();
}

gradientOlder()

template<typename T >

const OutputTools< T >::VariableGradient & MooseVariableInterface< T >::gradientOlder ( )

protectedvirtualinherited

The older gradient of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 268 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("gradients are not defined at nodes");
 
  return _variable->gradSlnOlder();
}

isADObject()

virtual bool ADFunctorInterface::isADObject ( ) const

inlineoverrideprivatevirtualinherited

Whether this interface is for an AD object.

Implements FunctorInterface.

Definition at line 34 of file ADFunctorInterface.h.

{ return true; }

isFunctor() [1/2]

bool FunctorInterface::isFunctor ( const std::string &  name ) const

protectedinherited

Checks the subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, \emph not the actual name of the functor created in the input file

Returns

Whether the subproblem has the specified functor

Definition at line 124 of file FunctorInterface.C.

{
  mooseAssert(_fi_subproblem, "This must be non-null");
  return isFunctor(name, *_fi_subproblem);
}

Referenced by FunctorInterface::isFunctor().

isFunctor() [2/2]

bool FunctorInterface::isFunctor ( const std::string &  name, const SubProblem &  subproblem  ) const

protectedinherited

Checks the passed-in subproblem for the given functor.

This will not query default functors potentially stored in this object, e.g. this method will return false if the user passed an int or real to the functor param in the input file

Parameters

name	The name of the functor to check. This should match the functor parameter name, \emph not the actual name of the functor created in the input file
subproblem	The subproblem to query for the functor

Returns

Whether the subproblem has the specified functor

Definition at line 115 of file FunctorInterface.C.

{
  // Check if the supplied parameter is a valid input parameter key
  std::string functor_name = deduceFunctorName(name);
 
  return subproblem.hasFunctor(functor_name, _fi_tid);
}

makeElemArg()

Moose::ElemArg FunctorInterface::makeElemArg ( const Elem *  elem, bool  correct_skewnewss = false  ) const

protectedinherited

Helper method to create an elemental argument for a functor that includes whether to perform skewness corrections.

Definition at line 131 of file FunctorInterface.C.

{
  return {elem, correct_skewness};
}

Referenced by LinearFVAdvectionDiffusionFunctorDirichletBC::computeBoundaryNormalGradient(), LinearFVReaction::computeMatrixContribution(), LinearFVTimeDerivative::computeMatrixContribution(), FVCoupledForce::computeQpResidual(), FVFunctorTimeKernel::computeQpResidual(), FVMassMatrix::computeQpResidual(), FVBoundedValueConstraint::computeQpResidual(), FVIntegralValueConstraint::computeQpResidual(), FVPointValueConstraint::computeQpResidual(), LinearFVSource::computeRightHandSideContribution(), FunctorAux::computeValue(), FunctorCoordinatesFunctionAux::computeValue(), SecondTimeDerivativeAux::computeValue(), TimeDerivativeAux::computeValue(), LinearFVAnisotropicDiffusion::faceDiffusionTensor(), FunctorTimes::initialize(), and LinearFVTimeDerivative::setCurrentElemInfo().

mooseLinearVariableFV()

template<typename T >

MooseLinearVariableFV< T > * MooseVariableInterface< T >::mooseLinearVariableFV ( ) const

inherited

Return the MooseLinearVariableFV object that this interface acts on.

Definition at line 68 of file MooseVariableInterface.C.

{
  if (!_linear_fv_variable)
    mooseError(
        "The variable defined in ", _moose_object.name(), " is not a MooseLinearVariableFV!");
  return _linear_fv_variable;
}

mooseVariable()

template<typename T >

MooseVariableFE< T > * MooseVariableInterface< T >::mooseVariable ( ) const

inherited

Return the MooseVariableFE object that this interface acts on.

Definition at line 78 of file MooseVariableInterface.C.

{
  if (!_variable)
    mooseError(
        "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
  return _variable;
}

Referenced by ADDGKernel::ADDGKernel(), ADIntegratedBCTempl< T >::ADIntegratedBCTempl(), ADInterfaceKernelTempl< T >::ADInterfaceKernelTempl(), ADKernelTempl< T >::ADKernelTempl(), ArrayDGKernel::ArrayDGKernel(), DGKernel::DGKernel(), and InterfaceKernelTempl< T >::InterfaceKernelTempl().

mooseVariableBase()

template<typename T >

MooseVariableBase * MooseVariableInterface< T >::mooseVariableBase ( ) const

inlineinherited

Get the variable that this object is using.

Returns

The variable this object is using.

Definition at line 50 of file MooseVariableInterface.h.

{ return _var; };

Referenced by ElementAdaptivityLevelAux::ElementAdaptivityLevelAux(), ElementLpNormAux::ElementLpNormAux(), and VolumeAux::VolumeAux().

mooseVariableField()

template<typename T >

MooseVariableField< T > & MooseVariableInterface< T >::mooseVariableField ( )

inherited

Return the MooseVariableField object that this interface acts on.

Definition at line 354 of file MooseVariableInterface.C.

{
  return *_field_variable;
}

Referenced by DiracKernelTempl< T >::DiracKernelTempl(), and InternalSideIndicatorTempl< ComputeValueType >::InternalSideIndicatorTempl().

mooseVariableFV()

template<typename T >

MooseVariableFV< T > * MooseVariableInterface< T >::mooseVariableFV ( ) const

inherited

Return the MooseVariableFV object that this interface acts on.

Definition at line 57 of file MooseVariableInterface.C.

{
  if (!_fv_variable)
    mooseError("_fv_variable is null in ",
               _moose_object.name(),
               ". Did you forget to set fv = true in the Variables block?");
  return _fv_variable;
}

second()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::second ( )

protectedvirtualinherited

The second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 278 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSln();
}

Referenced by MooseVariableFV< OutputType >::getDirichletBoundaryFaceValue().

secondOld()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::secondOld ( )

protectedvirtualinherited

The old second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 288 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOld();
}

secondOlder()

template<typename T >

const OutputTools< T >::VariableSecond & MooseVariableInterface< T >::secondOlder ( )

protectedvirtualinherited

The older second derivative of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 298 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondSlnOlder();
}

secondPhi()

template<typename T >

const OutputTools< T >::VariablePhiSecond & MooseVariableInterface< T >::secondPhi ( )

protectedvirtualinherited

The second derivative of the trial function.

Returns

The reference to be stored off and used later.

Definition at line 328 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhi(*_variable);
}

secondPhiFace()

template<typename T >

const OutputTools< T >::VariablePhiSecond & MooseVariableInterface< T >::secondPhiFace ( )

protectedvirtualinherited

The second derivative of the trial function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the trial function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 341 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  if (_linear_fv_variable)
    mooseError("second order shape function derivatives not available for linear FV variables");
 
  return _mvi_assembly->secondPhiFace(*_variable);
}

secondTest()

template<typename T >

const OutputTools< T >::VariableTestSecond & MooseVariableInterface< T >::secondTest ( )

protectedvirtualinherited

The second derivative of the test function.

Returns

The reference to be stored off and used later.

Definition at line 308 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhi();
}

secondTestFace()

template<typename T >

const OutputTools< T >::VariableTestSecond & MooseVariableInterface< T >::secondTestFace ( )

protectedvirtualinherited

The second derivative of the test function on the current face.

This should be called in e.g. IntegratedBC when you need second derivatives of the test function function on the boundary.

Returns

The reference to be stored off and used later.

Definition at line 318 of file MooseVariableInterface.C.

{
  if (_nodal)
    mooseError("second derivatives are not defined at nodes");
 
  return _variable->secondPhiFace();
}

shouldSetComp()

template<typename T , typename Base >

bool ADNodalBCTempl< T, Base >::shouldSetComp ( unsigned short  i ) const

inlineinherited

Definition at line 30 of file ADNodalBC.h.

{ return _set_components[i]; }

validParams()

InputParameters ADFunctionDirichletBC::validParams ( )

static

Definition at line 18 of file ADFunctionDirichletBC.C.

{
  InputParameters params = ADDirichletBCBaseTempl<Real>::validParams();
  params.addClassDescription("Imposes the essential boundary condition $u=g$, where $g$ "
                             "is calculated by a function.");
  params.addParam<FunctionName>("function", 0, "The function describing the Dirichlet condition");
  return params;
}

value()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::value ( )

protectedvirtualinherited

The value of the variable this object is operating on.

This is computed by default and should already be available as _u

Returns

The reference to be stored off and used later.

Definition at line 88 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValues();
  else
    return _variable->sln();
}

Referenced by NodalConstraint::computeJacobian(), ConservativeAdvectionBCTempl< is_ad >::computeQpResidual(), BodyForceTempl< is_ad >::computeQpResidual(), ArrayBodyForce::computeQpResidual(), ElementUOAux::computeValue(), MeshDivisionAux::computeValue(), and ParsedVectorAux::computeValue().

valueOld()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::valueOld ( )

protectedvirtualinherited

The old value of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 108 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOld();
  else
    return _variable->slnOld();
}

valueOlder()

template<typename T >

const OutputTools< T >::VariableValue & MooseVariableInterface< T >::valueOlder ( )

protectedvirtualinherited

The older value of the variable this object is operating on.

Returns

The reference to be stored off and used later.

Definition at line 128 of file MooseVariableInterface.C.

{
  if (_nodal)
    return _variable->dofValuesOlder();
  else
    return _variable->slnOlder();
}

variable()

template<typename T , typename Base >

const MooseVariableFE< T > & ADNodalBCTempl< T, Base >::variable ( ) const

inlineoverrideinherited

Definition at line 28 of file ADNodalBC.h.

{ return _var; }

Member Data Documentation

_current_node

template<typename T , typename Base >

const Node* const& ADNodalBCTempl< T, Base >::_current_node

protectedinherited

current node being processed

Definition at line 42 of file ADNodalBC.h.

Referenced by computeQpValue(), ADVectorFunctionDirichletBC::computeQpValue(), and FunctorDirichletBC::computeQpValue().

_default_ad_real_functors

std::vector<std::unique_ptr<Moose::Functor<ADReal> > > FunctorInterface::_default_ad_real_functors

privateinherited

Storage vector for Moose::Functor<ADReal> default objects.

Definition at line 188 of file FunctorInterface.h.

Referenced by FunctorInterface::defaultFunctor().

_default_real_functors

std::vector<std::unique_ptr<Moose::Functor<Real> > > FunctorInterface::_default_real_functors

privateinherited

Storage vector for Moose::Functor<Real> default objects.

Definition at line 185 of file FunctorInterface.h.

Referenced by FunctorInterface::defaultFunctor().

_fi_name

const std::string FunctorInterface::_fi_name

privateinherited

The name of the object that this interface belongs to.

Definition at line 176 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctorByName().

_fi_params

const InputParameters& FunctorInterface::_fi_params

privateinherited

Parameters of the object with this interface.

Definition at line 173 of file FunctorInterface.h.

Referenced by FunctorInterface::deduceFunctorName().

_fi_subproblem

SubProblem* const FunctorInterface::_fi_subproblem

privateinherited

Pointer to subproblem if the subproblem pointer parameter was set.

Definition at line 179 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctor(), FunctorInterface::getFunctor(), FunctorInterface::getFunctorByName(), and FunctorInterface::isFunctor().

_fi_tid

const THREAD_ID FunctorInterface::_fi_tid

privateinherited

Current threaded it.

Definition at line 182 of file FunctorInterface.h.

Referenced by FunctorInterface::getFunctor(), FunctorInterface::getFunctor(), FunctorInterface::getFunctorByName(), and FunctorInterface::isFunctor().

_field_variable

template<typename T >

MooseVariableField<T>* MooseVariableInterface< T >::_field_variable = nullptr

protectedinherited

Definition at line 230 of file MooseVariableInterface.h.

_function

const Function& ADFunctionDirichletBC::_function

protected

The function describing the Dirichlet condition.

Definition at line 30 of file ADFunctionDirichletBC.h.

Referenced by computeQpValue().

_fv_variable

template<typename T >

MooseVariableFV<T>* MooseVariableInterface< T >::_fv_variable = nullptr

protectedinherited

Definition at line 228 of file MooseVariableInterface.h.

_linear_fv_variable

template<typename T >

MooseLinearVariableFV<T>* MooseVariableInterface< T >::_linear_fv_variable = nullptr

protectedinherited

Definition at line 229 of file MooseVariableInterface.h.

_moose_object

template<typename T >

const MooseObject& MooseVariableInterface< T >::_moose_object

privateinherited

Definition at line 236 of file MooseVariableInterface.h.

Referenced by MooseVariableInterface< T >::MooseVariableInterface().

_mvi_assembly

template<typename T >

Assembly* MooseVariableInterface< T >::_mvi_assembly

protectedinherited

Definition at line 233 of file MooseVariableInterface.h.

_nodal

template<typename T >

bool MooseVariableInterface< T >::_nodal

protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 223 of file MooseVariableInterface.h.

_qp

template<typename T , typename Base >

const unsigned int ADNodalBCTempl< T, Base >::_qp = 0

protectedinherited

Pseudo-"quadrature point" index (Always zero for the current node)

Definition at line 45 of file ADNodalBC.h.

_set_components

template<typename T , typename Base >

std::vector<bool> ADNodalBCTempl< T, Base >::_set_components

protectedinherited

Definition at line 50 of file ADNodalBC.h.

Referenced by ADNodalBCTempl< T, Base >::shouldSetComp().

_u

template<typename T , typename Base >

const Moose::ADType<T>::type& ADNodalBCTempl< T, Base >::_u

protectedinherited

Value of the unknown variable this BC is acting on.

Definition at line 48 of file ADNodalBC.h.

Referenced by ADArrayDirichletBC::computeQpResidual(), and ADVectorMatchedValueBC::computeQpResidual().

_undisplaced_assembly

template<typename T , typename Base >

Assembly& ADNodalBCTempl< T, Base >::_undisplaced_assembly

privateinherited

A reference to the undisplaced assembly in order to ensure data gets correctly incorporated into the global residual/Jacobian.

Definition at line 80 of file ADNodalBC.h.

_var

template<typename T , typename Base >

MooseVariableFE<T>& ADNodalBCTempl< T, Base >::_var

protectedinherited

The variable that this NodalBC operates on.

Definition at line 39 of file ADNodalBC.h.

Referenced by ADArrayDirichletBC::ADArrayDirichletBC(), and ADNodalBCTempl< T, Base >::variable().

_variable

template<typename T >

MooseVariableFE<T>* MooseVariableInterface< T >::_variable = nullptr

protectedinherited

Definition at line 227 of file MooseVariableInterface.h.

usingTransientInterfaceMembers

ADDirichletBCBaseTempl< Real >::usingTransientInterfaceMembers

protectedinherited

Definition at line 39 of file ADDirichletBCBaseTempl.h.

---

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

• include/bcs/ADFunctionDirichletBC.h
• src/bcs/ADFunctionDirichletBC.C