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

Implements a simple coupled boundary condition where u=v on the boundary. More...

#include <ADVectorMatchedValueBC.h>

Inheritance diagram for ADVectorMatchedValueBC:
[legend]

Public Member Functions

 ADVectorMatchedValueBC (const InputParameters &parameters)
 
const MooseVariableFE< T > & variable () const override
 
bool shouldSetComp (unsigned short i) const
 
MooseVariableBasemooseVariableBase () const
 Get the variable that this object is using. More...
 
MooseVariableField< T > & mooseVariableField ()
 Return the MooseVariableField<T> object that this interface acts on. More...
 
MooseVariableFE< T > * mooseVariable () const
 
MooseVariableFV< T > * mooseVariableFV () const
 

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. More...
 

Protected Member Functions

ADRealVectorValue computeQpResidual () override
 Compute this NodalBC's contribution to the residual at the current quadrature point. More...
 
virtual const OutputTools< T >::VariableValuevalue ()
 The value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuevalueOld ()
 The old value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuevalueOlder ()
 The older value of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedot ()
 The time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotDot ()
 The second time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotOld ()
 The old time derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableValuedotDotOld ()
 The old second time derivative of the variable this object is operating on. More...
 
virtual const VariableValuedotDu ()
 The derivative of the time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
 
virtual const VariableValuedotDotDu ()
 The derivative of the second time derivative of the variable this object is operating on with respect to this variable's coefficients. More...
 
virtual const OutputTools< T >::VariableGradientgradient ()
 The gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableGradientgradientOld ()
 The old gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableGradientgradientOlder ()
 The older gradient of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecond ()
 The second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecondOld ()
 The old second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableSecondsecondOlder ()
 The older second derivative of the variable this object is operating on. More...
 
virtual const OutputTools< T >::VariableTestSecondsecondTest ()
 The second derivative of the test function. More...
 
virtual const OutputTools< T >::VariableTestSecondsecondTestFace ()
 The second derivative of the test function on the current face. More...
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhi ()
 The second derivative of the trial function. More...
 
virtual const OutputTools< T >::VariablePhiSecondsecondPhiFace ()
 The second derivative of the trial function on the current face. More...
 
std::string deduceFunctorName (const std::string &name) const
 Small helper to look up a functor name through the input parameter keys. More...
 
template<typename T >
const Moose::Functor< T > & getFunctor (const std::string &name)
 Retrieves a functor from the subproblem. More...
 
template<typename T >
const Moose::Functor< T > & getFunctor (const std::string &name, THREAD_ID tid)
 Retrieves a functor from the subproblem. More...
 
template<typename T >
const Moose::Functor< T > & getFunctor (const std::string &name, SubProblem &subproblem)
 Retrieves a functor from the passed-in subproblem. More...
 
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. More...
 
bool isFunctor (const std::string &name) const
 Checks the subproblem for the given functor. More...
 
bool isFunctor (const std::string &name, const SubProblem &subproblem) const
 Checks the passed-in subproblem for the given functor. More...
 
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. More...
 
template<typename T >
void checkFunctorSupportsSideIntegration (const std::string &name, bool qp_integration)
 Throws error if the functor does not support the requested side integration. More...
 

Protected Attributes

const ADRealVectorValue_v
 
MooseVariableFE< T > & _var
 The variable that this NodalBC operates on. More...
 
const Node *const & _current_node
 current node being processed More...
 
const unsigned int _qp = 0
 Pseudo-"quadrature point" index (Always zero for the current node) More...
 
const Moose::ADType< T >::type & _u
 Value of the unknown variable this BC is acting on. More...
 
const std::array< bool, 3 > _set_components
 
bool _nodal
 Whether or not this object is acting only at nodes. More...
 
MooseVariableFE< T > * _variable = nullptr
 
MooseVariableFV< T > * _fv_variable = nullptr
 
Assembly_mvi_assembly
 

Detailed Description

Implements a simple coupled boundary condition where u=v on the boundary.

Definition at line 17 of file ADVectorMatchedValueBC.h.

Constructor & Destructor Documentation

◆ ADVectorMatchedValueBC()

ADVectorMatchedValueBC::ADVectorMatchedValueBC ( const InputParameters parameters)

Definition at line 25 of file ADVectorMatchedValueBC.C.

26  : ADVectorNodalBC(parameters), _v(adCoupledNodalValue<RealVectorValue>("v"))
27 {
28 }
const ADRealVectorValue & _v
ADNodalBCTempl< RealVectorValue, NodalBCBase > ADVectorNodalBC
Definition: ADNodalBC.h:91

Member Function Documentation

◆ 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]nameName of functor or functor parameter
[in]qp_integrationTrue if performing qp integration, false if face info

Definition at line 236 of file FunctorInterface.h.

237 {
238  const std::string functor_name = deduceFunctorName(name);
239  const auto & functor = getFunctor<T>(name);
240  if (qp_integration)
241  {
242  if (!functor.supportsElemSideQpArg())
243  mooseError("Quadrature point integration was requested, but the functor '",
244  functor_name,
245  "' does not support this.");
246  }
247  else
248  {
249  if (!functor.supportsFaceArg())
250  mooseError("Face info integration was requested, but the functor '",
251  functor_name,
252  "' does not support this.");
253  }
254 }
std::string name(const ElemQuality q)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
static std::string deduceFunctorName(const std::string &name, const InputParameters &params)
Helper to look up a functor name through the input parameter keys.

◆ computeQpResidual()

ADRealVectorValue ADVectorMatchedValueBC::computeQpResidual ( )
overrideprotectedvirtual

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

Implements ADNodalBCTempl< T, Base >.

Definition at line 31 of file ADVectorMatchedValueBC.C.

32 {
33  return _u - _v;
34 }
const Moose::ADType< T >::type & _u
Value of the unknown variable this BC is acting on.
Definition: ADNodalBC.h:48
const ADRealVectorValue & _v

◆ deduceFunctorName() [1/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
nameThe input parameter name that we are trying to deduce the functor name for
paramsThe input parameters object that we will be checking for parameters named name
Returns
The functor name

Definition at line 28 of file FunctorInterface.C.

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

29 {
30  if (params.isParamValid(name))
31  {
32  if (params.have_parameter<MooseFunctorName>(name))
33  return params.get<MooseFunctorName>(name);
34  // variables, functor material properties, functions, and post-processors are also functors
35  else if (params.have_parameter<MaterialPropertyName>(name))
36  return params.get<MaterialPropertyName>(name);
37  else if (params.have_parameter<VariableName>(name))
38  return params.get<VariableName>(name);
39  else if (params.have_parameter<std::vector<VariableName>>(name))
40  {
41  const auto & var_names = params.get<std::vector<VariableName>>(name);
42  if (var_names.size() != 1)
43  mooseError("We only support a single variable name for retrieving a functor");
44  return var_names[0];
45  }
46  else if (params.have_parameter<NonlinearVariableName>(name))
47  return params.get<NonlinearVariableName>(name);
48  else if (params.have_parameter<FunctionName>(name))
49  return params.get<FunctionName>(name);
50  else if (params.have_parameter<PostprocessorName>(name))
51  return params.get<PostprocessorName>(name);
52  else
53  mooseError("Invalid parameter type for retrieving a functor");
54  }
55  else
56  return name;
57 }
std::string name(const ElemQuality q)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
std::vector< std::pair< R1, R2 > > get(const std::string &param1, const std::string &param2) const
Combine two vector parameters into a single vector of pairs.
bool have_parameter(std::string_view name) const
A wrapper around the Parameters base class method.
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

◆ deduceFunctorName() [2/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 60 of file FunctorInterface.C.

61 {
62  return deduceFunctorName(name, _fi_params);
63 }
const InputParameters & _fi_params
Parameters of the object with this interface.
static std::string deduceFunctorName(const std::string &name, const InputParameters &params)
Helper to look up a functor name through the input parameter keys.

◆ 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 134 of file MooseVariableInterface.C.

135 {
136  if (_nodal)
137  return _variable->dofValuesDot();
138  else
139  return _variable->uDot();
140 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & uDot() const
element dots
MooseVariableFE< T > * _variable
const DoFValue & dofValuesDot() const override

◆ 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 144 of file MooseVariableInterface.C.

145 {
146  if (_nodal)
147  return _variable->dofValuesDotDot();
148  else
149  return _variable->uDotDot();
150 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesDotDot() const override
const FieldVariableValue & uDotDot() const
MooseVariableFE< T > * _variable

◆ 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 224 of file MooseVariableInterface.C.

225 {
226  if (_nodal)
227  return _variable->dofValuesDuDotDotDu();
228  else
229  return _variable->duDotDotDu();
230 }
const MooseArray< Number > & dofValuesDuDotDotDu() const override
bool _nodal
Whether or not this object is acting only at nodes.
const VariableValue & duDotDotDu() const
MooseVariableFE< T > * _variable

◆ 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 164 of file MooseVariableInterface.C.

165 {
166  if (_nodal)
167  return _variable->dofValuesDotDotOld();
168  else
169  return _variable->uDotDotOld();
170 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & uDotDotOld() const
MooseVariableFE< T > * _variable
const DoFValue & dofValuesDotDotOld() const override

◆ 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 214 of file MooseVariableInterface.C.

215 {
216  if (_nodal)
217  return _variable->dofValuesDuDotDu();
218  else
219  return _variable->duDotDu();
220 }
const MooseArray< Number > & dofValuesDuDotDu() const override
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const VariableValue & duDotDu() const

◆ 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 154 of file MooseVariableInterface.C.

155 {
156  if (_nodal)
157  return _variable->dofValuesDotOld();
158  else
159  return _variable->uDotOld();
160 }
const DoFValue & dofValuesDotOld() const override
const FieldVariableValue & uDotOld() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ 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
nameThe name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
Returns
The functor

Definition at line 200 of file FunctorInterface.h.

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

201 {
202  mooseAssert(_fi_subproblem, "This must be non-null");
203  return getFunctor<T>(name, *_fi_subproblem, _fi_tid);
204 }
std::string name(const ElemQuality q)
SubProblem *const _fi_subproblem
Pointer to subproblem if the subproblem pointer parameter was set.
const THREAD_ID _fi_tid
Current threaded it.

◆ getFunctor() [2/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
nameThe name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
tidThe thread ID used to retrieve the functor from this interface's subproblem
Returns
The functor

Definition at line 192 of file FunctorInterface.h.

193 {
194  mooseAssert(_fi_subproblem, "This must be non-null");
195  return getFunctor<T>(name, *_fi_subproblem, tid);
196 }
std::string name(const ElemQuality q)
SubProblem *const _fi_subproblem
Pointer to subproblem if the subproblem pointer parameter was set.

◆ getFunctor() [3/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
nameThe name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblemThe subproblem to query for the functor
Returns
The functor

Definition at line 185 of file FunctorInterface.h.

186 {
187  return getFunctor<T>(name, subproblem, _fi_tid);
188 }
std::string name(const ElemQuality q)
const THREAD_ID _fi_tid
Current threaded it.

◆ getFunctor() [4/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
nameThe name of the functor to retrieve. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblemThe subproblem to query for the functor
tidThe thread ID used to retrieve the functor from the subproblem
Returns
The functor

Definition at line 176 of file FunctorInterface.h.

177 {
178  // Check if the supplied parameter is a valid input parameter key
179  std::string functor_name = deduceFunctorName(name);
180  return getFunctorByName<T>(functor_name, subproblem, tid);
181 }
static std::string deduceFunctorName(const std::string &name, const InputParameters &params)
Helper to look up a functor name through the input parameter keys.

◆ 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 234 of file MooseVariableInterface.C.

235 {
236  if (_nodal)
237  mooseError("gradients are not defined at nodes");
238 
239  return _variable->gradSln();
240 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
const FieldVariableGradient & gradSln() const override
element gradients
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ 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 244 of file MooseVariableInterface.C.

245 {
246  if (_nodal)
247  mooseError("gradients are not defined at nodes");
248 
249  return _variable->gradSlnOld();
250 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnOld() const override

◆ 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 254 of file MooseVariableInterface.C.

255 {
256  if (_nodal)
257  mooseError("gradients are not defined at nodes");
258 
259  return _variable->gradSlnOlder();
260 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableGradient & gradSlnOlder() const

◆ 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
nameThe name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file
Returns
Whether the subproblem has the specified functor

Definition at line 113 of file FunctorInterface.C.

114 {
115  mooseAssert(_fi_subproblem, "This must be non-null");
116  return isFunctor(name, *_fi_subproblem);
117 }
SubProblem *const _fi_subproblem
Pointer to subproblem if the subproblem pointer parameter was set.
bool isFunctor(const std::string &name) const
Checks the subproblem for the given functor.

◆ 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
nameThe name of the functor to check. This should match the functor parameter name, not the actual name of the functor created in the input file
subproblemThe subproblem to query for the functor
Returns
Whether the subproblem has the specified functor

Definition at line 104 of file FunctorInterface.C.

105 {
106  // Check if the supplied parameter is a valid input parameter key
107  std::string functor_name = deduceFunctorName(name);
108 
109  return subproblem.hasFunctor(functor_name, _fi_tid);
110 }
bool hasFunctor(const std::string &name, const THREAD_ID tid) const
checks whether we have a functor corresponding to name on the thread id tid
Definition: SubProblem.C:1215
const THREAD_ID _fi_tid
Current threaded it.
static std::string deduceFunctorName(const std::string &name, const InputParameters &params)
Helper to look up a functor name through the input parameter keys.

◆ makeElemArg()

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

◆ mooseVariable()

template<typename T >
MooseVariableFE< T > * MooseVariableInterface< T >::mooseVariable ( ) const
inherited

Definition at line 64 of file MooseVariableInterface.C.

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

65 {
66  if (!_variable)
67  mooseError(
68  "_variable is null in ", _moose_object.name(), ". Are you using a finite volume variable?");
69  return _variable;
70 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
MooseVariableFE< T > * _variable
const MooseObject & _moose_object

◆ 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 48 of file MooseVariableInterface.h.

48 { return _var; };
MooseVariableBase * _var
The variable this object is acting on.

◆ mooseVariableField()

template<typename T >
MooseVariableField< T > & MooseVariableInterface< T >::mooseVariableField ( )
inherited

Return the MooseVariableField<T> object that this interface acts on.

Definition at line 334 of file MooseVariableInterface.C.

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

335 {
336  if (_variable)
337  return *_variable;
338  else
339  {
340  if (!_fv_variable)
341  mooseError("Either _variable or _fv_variable must be non-null in MooseVariableInterface");
342 
343  return *_fv_variable;
344  }
345 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
MooseVariableFV< T > * _fv_variable
MooseVariableFE< T > * _variable

◆ mooseVariableFV()

template<typename T >
MooseVariableFV< T > * MooseVariableInterface< T >::mooseVariableFV ( ) const
inherited

Definition at line 53 of file MooseVariableInterface.C.

54 {
55  if (!_fv_variable)
56  mooseError("_fv_variable is null in ",
58  ". Did you forget to set fv = true in the Variables block?");
59  return _fv_variable;
60 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
MooseVariableFV< T > * _fv_variable
virtual const std::string & name() const
Get the name of the class.
Definition: MooseBase.h:57
const MooseObject & _moose_object

◆ 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 264 of file MooseVariableInterface.C.

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

265 {
266  if (_nodal)
267  mooseError("second derivatives are not defined at nodes");
268 
269  return _variable->secondSln();
270 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable
const FieldVariableSecond & secondSln() const
element seconds

◆ 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 274 of file MooseVariableInterface.C.

275 {
276  if (_nodal)
277  mooseError("second derivatives are not defined at nodes");
278 
279  return _variable->secondSlnOld();
280 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
const FieldVariableSecond & secondSlnOld() const
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ 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 284 of file MooseVariableInterface.C.

285 {
286  if (_nodal)
287  mooseError("second derivatives are not defined at nodes");
288 
289  return _variable->secondSlnOlder();
290 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableSecond & secondSlnOlder() const
MooseVariableFE< T > * _variable

◆ 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 314 of file MooseVariableInterface.C.

315 {
316  if (_nodal)
317  mooseError("second derivatives are not defined at nodes");
318 
320 }
const VariablePhiSecond & secondPhi() const
Definition: Assembly.h:1278
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _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 324 of file MooseVariableInterface.C.

325 {
326  if (_nodal)
327  mooseError("second derivatives are not defined at nodes");
328 
330 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
const VariablePhiSecond & secondPhiFace(const MooseVariableField< Real > &) const
Definition: Assembly.h:1291
MooseVariableFE< T > * _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 294 of file MooseVariableInterface.C.

295 {
296  if (_nodal)
297  mooseError("second derivatives are not defined at nodes");
298 
299  return _variable->secondPhi();
300 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
const FieldVariablePhiSecond & secondPhi() const override final
Return the rank-2 tensor of second derivatives of the variable&#39;s elemental shape functions.
bool _nodal
Whether or not this object is acting only at nodes.
MooseVariableFE< T > * _variable

◆ 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 304 of file MooseVariableInterface.C.

305 {
306  if (_nodal)
307  mooseError("second derivatives are not defined at nodes");
308 
309  return _variable->secondPhiFace();
310 }
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:284
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariablePhiSecond & secondPhiFace() const override final
Return the rank-2 tensor of second derivatives of the variable&#39;s shape functions on an element face...
MooseVariableFE< T > * _variable

◆ shouldSetComp()

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

Definition at line 30 of file ADNodalBC.h.

30 { return _set_components[i]; }
const std::array< bool, 3 > _set_components
Definition: ADNodalBC.h:50

◆ validParams()

InputParameters ADVectorMatchedValueBC::validParams ( )
static

Definition at line 15 of file ADVectorMatchedValueBC.C.

16 {
18  params.addRequiredCoupledVar("v", "The variable whose value we are to match.");
19  params.addClassDescription(
20  "Implements a ADVectorNodalBC which equates two different Variables' values "
21  "on a specified boundary.");
22  return params;
23 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
Definition: ADNodalBC.C:25
void addRequiredCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...

◆ 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 74 of file MooseVariableInterface.C.

Referenced by ReporterPointSource::fillPoint().

75 {
76  if (_nodal)
77  return _variable->dofValues();
78  else
79  return _variable->sln();
80 }
bool _nodal
Whether or not this object is acting only at nodes.
const FieldVariableValue & sln() const override
element solutions
MooseVariableFE< T > * _variable
const DoFValue & dofValues() const override
dof values getters

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

95 {
96  if (_nodal)
97  return _variable->dofValuesOld();
98  else
99  return _variable->slnOld();
100 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesOld() const override
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOld() const override

◆ 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 114 of file MooseVariableInterface.C.

115 {
116  if (_nodal)
117  return _variable->dofValuesOlder();
118  else
119  return _variable->slnOlder();
120 }
bool _nodal
Whether or not this object is acting only at nodes.
const DoFValue & dofValuesOlder() const override
MooseVariableFE< T > * _variable
const FieldVariableValue & slnOlder() const override

◆ variable()

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

Definition at line 28 of file ADNodalBC.h.

28 { return _var; }
MooseVariableFE< T > & _var
The variable that this NodalBC operates on.
Definition: ADNodalBC.h:39

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.

◆ _fv_variable

template<typename T>
MooseVariableFV<T>* MooseVariableInterface< T >::_fv_variable = nullptr
protectedinherited

◆ _mvi_assembly

template<typename T>
Assembly* MooseVariableInterface< T >::_mvi_assembly
protectedinherited

◆ _nodal

template<typename T>
bool MooseVariableInterface< T >::_nodal
protectedinherited

Whether or not this object is acting only at nodes.

Definition at line 210 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>
const std::array<bool, 3> ADNodalBCTempl< T, Base >::_set_components
protectedinherited

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

◆ _v

const ADRealVectorValue& ADVectorMatchedValueBC::_v
protected

Definition at line 27 of file ADVectorMatchedValueBC.h.

Referenced by computeQpResidual().

◆ _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 ADNodalBCTempl< RealVectorValue, ADDirichletBCBase >::variable().

◆ _variable

template<typename T>
MooseVariableFE<T>* MooseVariableInterface< T >::_variable = nullptr
protectedinherited

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