https://mooseframework.inl.gov
Coupleable.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #ifdef MOOSE_KOKKOS_SCOPE
13 #include "KokkosVariableValue.h"
14 #endif
15 
16 #include <unordered_map>
17 #include "MooseTypes.h"
18 #include "MooseArray.h"
19 #include "MooseVariableFE.h"
20 #include "MooseVariableFV.h"
21 #include "MooseLinearVariableFV.h"
22 #include "InputParameters.h"
23 #include "HasMembers.h"
24 
25 #define usingCoupleableMembers \
26  using Coupleable::_zero; \
27  using Coupleable::_grad_zero; \
28  using Coupleable::_ad_zero; \
29  using Coupleable::_ad_grad_zero
30 
31 // Forward declarations
32 class MooseVariableScalar;
33 class MooseObject;
34 
35 namespace libMesh
36 {
37 template <typename T>
38 class DenseVector;
39 }
40 
41 template <typename>
42 class MooseVariableField;
43 typedef MooseVariableField<Real> MooseWritableVariable;
44 
49 class Coupleable
50 {
51 public:
58  Coupleable(const MooseObject * moose_object, bool nodal, bool is_fv = false);
59 
60 #ifdef MOOSE_KOKKOS_ENABLED
61 
64  Coupleable(const Coupleable & object, const Moose::Kokkos::FunctorCopy & key);
65 #endif
66 
71  const std::unordered_map<std::string, std::vector<MooseVariableFieldBase *>> &
72  getCoupledVars() const
73  {
74  return _coupled_vars;
75  }
76 
81  const std::vector<MooseVariableFieldBase *> & getCoupledMooseVars() const
82  {
83  return _coupled_moose_vars;
84  }
85 
90  const std::vector<MooseVariable *> & getCoupledStandardMooseVars() const
91  {
92  return _coupled_standard_moose_vars;
93  }
94 
99  const std::vector<VectorMooseVariable *> & getCoupledVectorMooseVars() const
100  {
101  return _coupled_vector_moose_vars;
102  }
103 
108  const std::vector<ArrayMooseVariable *> & getCoupledArrayMooseVars() const
109  {
110  return _coupled_array_moose_vars;
111  }
112 
113  void addFEVariableCoupleableVectorTag(TagID tag) { _fe_coupleable_vector_tags.insert(tag); }
114 
115  void addFEVariableCoupleableMatrixTag(TagID tag) { _fe_coupleable_matrix_tags.insert(tag); }
116 
117  std::set<TagID> & getFEVariableCoupleableVectorTags() { return _fe_coupleable_vector_tags; }
118 
119  std::set<TagID> & getFEVariableCoupleableMatrixTags() { return _fe_coupleable_matrix_tags; }
120 
121  const std::set<TagID> & getFEVariableCoupleableVectorTags() const
122  {
123  return _fe_coupleable_vector_tags;
124  }
125 
126  const std::set<TagID> & getFEVariableCoupleableMatrixTags() const
127  {
128  return _fe_coupleable_matrix_tags;
129  }
130 
134  auto & getWritableCoupledVariables() const { return _writable_coupled_variables[_c_tid]; }
135 
139  bool hasWritableCoupledVariables() const { return !getWritableCoupledVariables().empty(); }
140 
141 protected:
146  virtual void coupledCallback(const std::string & /*var_name*/, bool /*is_old*/) const {}
147 
154  virtual bool isCoupled(const std::string & var_name, unsigned int i = 0) const;
155 
161  virtual bool isCoupledConstant(const std::string & var_name) const;
162 
168  unsigned int coupledComponents(const std::string & var_name) const;
169 
176  VariableName coupledName(const std::string & var_name, unsigned int comp = 0) const;
177 
183  std::vector<VariableName> coupledNames(const std::string & var_name) const;
184 
192  virtual unsigned int coupled(const std::string & var_name, unsigned int comp = 0) const;
193 
199  std::vector<unsigned int> coupledIndices(const std::string & var_name) const;
200 
208  virtual const VariableValue & coupledValue(const std::string & var_name,
209  unsigned int comp = 0) const;
210 
216  std::vector<const VariableValue *> coupledValues(const std::string & var_name) const;
217 
223  std::vector<const VectorVariableValue *> coupledVectorValues(const std::string & var_name) const;
224 
231  template <bool is_ad>
232  const GenericVariableValue<is_ad> & coupledGenericValue(const std::string & var_name,
233  unsigned int comp = 0) const;
234 
242  template <bool is_ad>
243  const GenericVectorVariableValue<is_ad> & coupledGenericVectorValue(const std::string & var_name,
244  unsigned int comp = 0) const;
245 
252  template <bool is_ad>
253  std::vector<const GenericVariableValue<is_ad> *>
254  coupledGenericValues(const std::string & var_name) const;
255 
262  template <bool is_ad>
263  const GenericVariableValue<is_ad> & coupledGenericDofValue(const std::string & var_name,
264  unsigned int comp = 0) const;
265 
273  template <bool is_ad>
274  const GenericVariableValue<is_ad> & coupledGenericDot(const std::string & var_name,
275  unsigned int comp = 0) const;
276 
284  template <bool is_ad>
285  const GenericVariableValue<is_ad> & coupledGenericDotDot(const std::string & var_name,
286  unsigned int comp = 0) const;
287 
294  virtual const VariableValue & coupledValueLower(const std::string & var_name,
295  unsigned int comp = 0) const;
296 
303  const ADVariableValue & adCoupledValue(const std::string & var_name, unsigned int comp = 0) const;
304 
311  std::vector<const ADVariableValue *> adCoupledValues(const std::string & var_name) const;
312 
319  const ADVariableValue & adCoupledLowerValue(const std::string & var_name,
320  unsigned int comp = 0) const;
321 
329  const ADVectorVariableValue & adCoupledVectorValue(const std::string & var_name,
330  unsigned int comp = 0) const;
331 
338  std::vector<const ADVectorVariableValue *>
339  adCoupledVectorValues(const std::string & var_name) const;
340 
349  virtual const VariableValue &
350  coupledVectorTagValue(const std::string & var_names, TagID tag, unsigned int index = 0) const;
351 
352  virtual const VariableValue & coupledVectorTagValue(const std::string & var_names,
353  const std::string & tag_name,
354  unsigned int index = 0) const;
355 
362  std::vector<const VariableValue *> coupledVectorTagValues(const std::string & var_names,
363  TagID tag) const;
364 
365  std::vector<const VariableValue *> coupledVectorTagValues(const std::string & var_names,
366  const std::string & tag_name) const;
367 
376  virtual const ArrayVariableValue & coupledVectorTagArrayValue(const std::string & var_names,
377  TagID tag,
378  unsigned int index = 0) const;
379 
380  virtual const ArrayVariableValue & coupledVectorTagArrayValue(const std::string & var_names,
381  const std::string & tag_name,
382  unsigned int index = 0) const;
383 
390  std::vector<const ArrayVariableValue *> coupledVectorTagArrayValues(const std::string & var_names,
391  TagID tag) const;
392 
393  std::vector<const ArrayVariableValue *>
394  coupledVectorTagArrayValues(const std::string & var_names, const std::string & tag_name) const;
395 
404  virtual const VariableGradient &
405  coupledVectorTagGradient(const std::string & var_names, TagID tag, unsigned int index = 0) const;
406 
407  virtual const VariableGradient & coupledVectorTagGradient(const std::string & var_names,
408  const std::string & tag_name,
409  unsigned int index = 0) const;
410 
417  std::vector<const VariableGradient *> coupledVectorTagGradients(const std::string & var_names,
418  TagID tag) const;
419 
420  std::vector<const VariableGradient *>
421  coupledVectorTagGradients(const std::string & var_names, const std::string & tag_name) const;
422 
432  virtual const ArrayVariableGradient & coupledVectorTagArrayGradient(const std::string & var_names,
433  TagID tag,
434  unsigned int index = 0) const;
435 
436  virtual const ArrayVariableGradient & coupledVectorTagArrayGradient(const std::string & var_names,
437  const std::string & tag_name,
438  unsigned int index = 0) const;
439 
446  std::vector<const ArrayVariableGradient *>
447  coupledVectorTagArrayGradients(const std::string & var_names, TagID tag) const;
448 
449  std::vector<const ArrayVariableGradient *>
450  coupledVectorTagArrayGradients(const std::string & var_names, const std::string & tag_name) const;
451 
459  virtual const VariableValue &
460  coupledVectorTagDofValue(const std::string & var_name, TagID tag, unsigned int index = 0) const;
461 
462  virtual const VariableValue & coupledVectorTagDofValue(const std::string & var_names,
463  const std::string & tag_name,
464  unsigned int index = 0) const;
465 
472  const ArrayVariableValue & coupledVectorTagArrayDofValue(const std::string & var_name,
473  const std::string & tag_name,
474  unsigned int comp = 0) const;
475 
482  std::vector<const VariableValue *> coupledVectorTagDofValues(const std::string & var_names,
483  TagID tag) const;
484 
485  std::vector<const VariableValue *> coupledVectorTagDofValues(const std::string & var_names,
486  const std::string & tag_name) const;
487 
496  virtual const VariableValue &
497  coupledMatrixTagValue(const std::string & var_names, TagID tag, unsigned int index = 0) const;
498 
499  virtual const VariableValue & coupledMatrixTagValue(const std::string & var_names,
500  const std::string & tag_name,
501  unsigned int index = 0) const;
502 
509  std::vector<const VariableValue *> coupledMatrixTagValues(const std::string & var_names,
510  TagID tag) const;
511 
512  std::vector<const VariableValue *> coupledMatrixTagValues(const std::string & var_names,
513  const std::string & tag_name) const;
514 
522  virtual const VectorVariableValue & coupledVectorValue(const std::string & var_name,
523  unsigned int comp = 0) const;
524 
532  virtual const ArrayVariableValue & coupledArrayValue(const std::string & var_name,
533  unsigned int comp = 0) const;
534 
540  std::vector<const ArrayVariableValue *> coupledArrayValues(const std::string & var_name) const;
541 
554  MooseWritableVariable & writableVariable(const std::string & var_name, unsigned int comp = 0);
555 
565  virtual VariableValue & writableCoupledValue(const std::string & var_name, unsigned int comp = 0);
566 
570  void checkWritableVar(MooseWritableVariable * var);
571 
579  virtual const VariableValue & coupledValueOld(const std::string & var_name,
580  unsigned int comp = 0) const;
581 
587  std::vector<const VariableValue *> coupledValuesOld(const std::string & var_name) const;
588 
594  std::vector<const VectorVariableValue *>
595  coupledVectorValuesOld(const std::string & var_name) const;
596 
604  virtual const VariableValue & coupledValueOlder(const std::string & var_name,
605  unsigned int comp = 0) const;
606 
612  std::vector<const VariableValue *> coupledValuesOlder(const std::string & var_name) const;
613 
620  virtual const VariableValue & coupledValuePreviousNL(const std::string & var_name,
621  unsigned int comp = 0) const;
622 
630  virtual const VectorVariableValue & coupledVectorValueOld(const std::string & var_name,
631  unsigned int comp = 0) const;
632 
640  virtual const VectorVariableValue & coupledVectorValueOlder(const std::string & var_name,
641  unsigned int comp = 0) const;
642 
650  virtual const ArrayVariableValue & coupledArrayValueOld(const std::string & var_name,
651  unsigned int comp = 0) const;
652 
660  virtual const ArrayVariableValue & coupledArrayValueOlder(const std::string & var_name,
661  unsigned int comp = 0) const;
662 
670  virtual const VariableGradient & coupledGradient(const std::string & var_name,
671  unsigned int comp = 0) const;
672 
678  std::vector<const VariableGradient *> coupledGradients(const std::string & var_name) const;
679 
687  const ADVariableGradient & adCoupledGradient(const std::string & var_name,
688  unsigned int comp = 0) const;
689 
697  const ADVariableGradient & adCoupledGradientDot(const std::string & var_name,
698  unsigned int comp = 0) const;
699 
706  std::vector<const ADVariableGradient *> adCoupledGradients(const std::string & var_name) const;
707 
715  template <bool is_ad>
716  const GenericVariableGradient<is_ad> & coupledGenericGradient(const std::string & var_name,
717  unsigned int comp = 0) const;
718 
725  template <bool is_ad>
726  std::vector<const GenericVariableGradient<is_ad> *>
727  coupledGenericGradients(const std::string & var_name) const;
728 
736  const ADVectorVariableGradient & adCoupledVectorGradient(const std::string & var_name,
737  unsigned int comp = 0) const;
738 
745  const ADVariableSecond & adCoupledSecond(const std::string & var_name,
746  unsigned int comp = 0) const;
747 
755  const ADVectorVariableSecond & adCoupledVectorSecond(const std::string & var_name,
756  unsigned int comp = 0) const;
757 
765  virtual const VariableGradient & coupledGradientOld(const std::string & var_name,
766  unsigned int comp = 0) const;
767 
773  std::vector<const VariableGradient *> coupledGradientsOld(const std::string & var_name) const;
774 
782  virtual const VariableGradient & coupledGradientOlder(const std::string & var_name,
783  unsigned int comp = 0) const;
784 
791  virtual const VariableGradient & coupledGradientPreviousNL(const std::string & var_name,
792  unsigned int comp = 0) const;
793 
801  virtual const VariableGradient & coupledGradientDot(const std::string & var_name,
802  unsigned int comp = 0) const;
803 
811  virtual const VariableGradient & coupledGradientDotDot(const std::string & var_name,
812  unsigned int comp = 0) const;
813 
821  virtual const VectorVariableGradient & coupledVectorGradient(const std::string & var_name,
822  unsigned int comp = 0) const;
823 
831  virtual const VectorVariableGradient & coupledVectorGradientOld(const std::string & var_name,
832  unsigned int comp = 0) const;
833 
841  virtual const VectorVariableGradient & coupledVectorGradientOlder(const std::string & var_name,
842  unsigned int comp = 0) const;
843 
851  virtual const ArrayVariableGradient & coupledArrayGradient(const std::string & var_name,
852  unsigned int comp = 0) const;
853 
861  virtual const ArrayVariableGradient & coupledArrayGradientOld(const std::string & var_name,
862  unsigned int comp = 0) const;
863 
871  virtual const ArrayVariableGradient & coupledArrayGradientOlder(const std::string & var_name,
872  unsigned int comp = 0) const;
873 
881  virtual const ArrayVariableGradient & coupledArrayGradientDot(const std::string & var_name,
882  unsigned int comp = 0) const;
883 
891  virtual const VectorVariableCurl & coupledCurl(const std::string & var_name,
892  unsigned int comp = 0) const;
893 
901  virtual const VectorVariableCurl & coupledCurlOld(const std::string & var_name,
902  unsigned int comp = 0) const;
903 
911  virtual const VectorVariableCurl & coupledCurlOlder(const std::string & var_name,
912  unsigned int comp = 0) const;
913 
921  const ADVectorVariableCurl & adCoupledCurl(const std::string & var_name,
922  unsigned int comp = 0) const;
923 
932  virtual const VectorVariableDivergence & coupledDiv(const std::string & var_name,
933  unsigned int comp = 0) const;
934 
943  virtual const VectorVariableDivergence & coupledDivOld(const std::string & var_name,
944  unsigned int comp = 0) const;
945 
954  virtual const VectorVariableDivergence & coupledDivOlder(const std::string & var_name,
955  unsigned int comp = 0) const;
956 
964  virtual const VariableSecond & coupledSecond(const std::string & var_name,
965  unsigned int comp = 0) const;
966 
975  virtual const VariableSecond & coupledSecondOld(const std::string & var_name,
976  unsigned int comp = 0) const;
977 
986  virtual const VariableSecond & coupledSecondOlder(const std::string & var_name,
987  unsigned int comp = 0) const;
988 
995  virtual const VariableSecond & coupledSecondPreviousNL(const std::string & var_name,
996  unsigned int comp = 0) const;
997 
1004  virtual const VariableValue & coupledDot(const std::string & var_name,
1005  unsigned int comp = 0) const;
1006 
1012  std::vector<const VariableValue *> coupledDots(const std::string & var_name) const;
1013 
1021  virtual const VariableValue & coupledDotDot(const std::string & var_name,
1022  unsigned int comp = 0) const;
1023 
1030  virtual const VariableValue & coupledDotOld(const std::string & var_name,
1031  unsigned int comp = 0) const;
1032 
1040  virtual const VariableValue & coupledDotDotOld(const std::string & var_name,
1041  unsigned int comp = 0) const;
1042 
1050  const ADVariableValue & adCoupledDot(const std::string & var_name, unsigned int comp = 0) const;
1051 
1057  std::vector<const ADVariableValue *> adCoupledDots(const std::string & var_name) const;
1058 
1066  const ADVariableValue & adCoupledDotDot(const std::string & var_name,
1067  unsigned int comp = 0) const;
1068 
1077  const ADVectorVariableValue & adCoupledVectorDot(const std::string & var_name,
1078  unsigned int comp = 0) const;
1079 
1087  virtual const VectorVariableValue & coupledVectorDot(const std::string & var_name,
1088  unsigned int comp = 0) const;
1089 
1097  virtual const VectorVariableValue & coupledVectorDotDot(const std::string & var_name,
1098  unsigned int comp = 0) const;
1099 
1107  virtual const VectorVariableValue & coupledVectorDotOld(const std::string & var_name,
1108  unsigned int comp = 0) const;
1109 
1117  virtual const VectorVariableValue & coupledVectorDotDotOld(const std::string & var_name,
1118  unsigned int comp = 0) const;
1119 
1127  virtual const VariableValue & coupledVectorDotDu(const std::string & var_name,
1128  unsigned int comp = 0) const;
1129 
1137  virtual const VariableValue & coupledVectorDotDotDu(const std::string & var_name,
1138  unsigned int comp = 0) const;
1139 
1147  virtual const ArrayVariableValue & coupledArrayDot(const std::string & var_name,
1148  unsigned int comp = 0) const;
1149 
1157  virtual const ArrayVariableValue & coupledArrayDotDot(const std::string & var_name,
1158  unsigned int comp = 0) const;
1159 
1167  virtual const ArrayVariableValue & coupledArrayDotOld(const std::string & var_name,
1168  unsigned int comp = 0) const;
1169 
1177  virtual const ArrayVariableValue & coupledArrayDotDotOld(const std::string & var_name,
1178  unsigned int comp = 0) const;
1179 
1187  virtual const VariableValue & coupledDotDu(const std::string & var_name,
1188  unsigned int comp = 0) const;
1189 
1197  virtual const VariableValue & coupledDotDotDu(const std::string & var_name,
1198  unsigned int comp = 0) const;
1199 
1207  const VariableValue & coupledArrayDotDu(const std::string & var_name,
1208  unsigned int comp = 0) const;
1209 
1216  template <typename T>
1217  const T & coupledNodalValue(const std::string & var_name, unsigned int comp = 0) const;
1218 
1225  template <typename T>
1226  const typename Moose::ADType<T>::type & adCoupledNodalValue(const std::string & var_name,
1227  unsigned int comp = 0) const;
1228 
1235  template <typename T>
1236  const T & coupledNodalValueOld(const std::string & var_name, unsigned int comp = 0) const;
1237 
1244  template <typename T>
1245  const T & coupledNodalValueOlder(const std::string & var_name, unsigned int comp = 0) const;
1246 
1253  template <typename T>
1254  const T & coupledNodalValuePreviousNL(const std::string & var_name, unsigned int comp = 0) const;
1255 
1263  template <typename T>
1264  const T & coupledNodalDot(const std::string & var_name, unsigned int comp = 0) const;
1265 
1273  virtual const VariableValue & coupledNodalDotDot(const std::string & var_name,
1274  unsigned int comp = 0) const;
1275 
1283  virtual const VariableValue & coupledNodalDotOld(const std::string & var_name,
1284  unsigned int comp = 0) const;
1285 
1293  virtual const VariableValue & coupledNodalDotDotOld(const std::string & var_name,
1294  unsigned int comp = 0) const;
1295  // coupled-dof-values-begin
1302  virtual const VariableValue & coupledDofValues(const std::string & var_name,
1303  unsigned int comp = 0) const;
1304 
1311  std::vector<const VariableValue *> coupledAllDofValues(const std::string & var_name) const;
1312 
1319  virtual const VariableValue & coupledDofValuesOld(const std::string & var_name,
1320  unsigned int comp = 0) const;
1321 
1328  std::vector<const VariableValue *> coupledAllDofValuesOld(const std::string & var_name) const;
1329 
1336  virtual const VariableValue & coupledDofValuesOlder(const std::string & var_name,
1337  unsigned int comp = 0) const;
1338 
1345  std::vector<const VariableValue *> coupledAllDofValuesOlder(const std::string & var_name) const;
1346 
1353  virtual const ArrayVariableValue & coupledArrayDofValues(const std::string & var_name,
1354  unsigned int comp = 0) const;
1355  // coupled-dof-values-end
1356 
1363  virtual const ADVariableValue & adCoupledDofValues(const std::string & var_name,
1364  unsigned int comp = 0) const;
1365 
1370  const ADVariableValue & adZeroValue() const;
1371 
1376  const ADVariableGradient & adZeroGradient() const;
1377 
1381  const ADVariableSecond & adZeroSecond() const;
1382 
1387  template <bool is_ad>
1388  const GenericVariableValue<is_ad> & genericZeroValue();
1389 
1394  template <bool is_ad>
1395  const GenericVariableGradient<is_ad> & genericZeroGradient();
1396 
1401  template <bool is_ad>
1402  const GenericVariableSecond<is_ad> & genericZeroSecond();
1403 
1404 protected:
1405  // Reference to the interface's input parameters
1406  const InputParameters & _c_parameters;
1407 
1409  const std::string & _c_name;
1411  const std::string & _c_type;
1412 
1413  // Reference to FEProblemBase
1414  FEProblemBase & _c_fe_problem;
1415 
1417  const SystemBase * const _c_sys;
1418 
1420  std::unordered_map<std::string, std::vector<MooseVariableFieldBase *>> _coupled_vars;
1421 
1423  std::vector<MooseVariableFieldBase *> _coupled_moose_vars;
1424 
1426  std::vector<MooseVariable *> _coupled_standard_moose_vars;
1427 
1429  std::vector<VectorMooseVariable *> _coupled_vector_moose_vars;
1430 
1432  std::vector<ArrayMooseVariable *> _coupled_array_moose_vars;
1433 
1435  std::vector<MooseVariableField<Real> *> _coupled_fv_moose_vars;
1436 
1438  const std::unordered_map<std::string, std::string> & _new_to_deprecated_coupled_vars;
1439 
1441  bool _c_nodal;
1442 
1444  bool _c_is_implicit;
1445 
1446  // Argument to allow element-to-nodal coupling
1447  const bool _c_allow_element_to_nodal_coupling;
1448 
1450  THREAD_ID _c_tid;
1451 
1453  mutable std::unordered_map<std::string, std::vector<std::unique_ptr<VariableValue>>>
1454  _default_value;
1455 
1457  mutable std::unordered_map<std::string, std::unique_ptr<MooseArray<ADReal>>> _ad_default_value;
1458 
1460  mutable std::unordered_map<std::string, std::unique_ptr<VectorVariableValue>>
1461  _default_vector_value;
1462 
1464  mutable std::unordered_map<std::string, std::unique_ptr<ArrayVariableValue>> _default_array_value;
1465 
1467  mutable std::unordered_map<std::string, std::unique_ptr<MooseArray<ADRealVectorValue>>>
1468  _ad_default_vector_value;
1469 
1474  mutable VariableValue _default_value_zero;
1475 
1477  mutable VariableGradient _default_gradient;
1478 
1480  mutable MooseArray<ADRealVectorValue> _ad_default_gradient;
1481 
1483  mutable MooseArray<ADRealTensorValue> _ad_default_vector_gradient;
1484 
1486  mutable VariableSecond _default_second;
1487 
1489  mutable MooseArray<ADRealTensorValue> _ad_default_second;
1490 
1492  mutable MooseArray<ADRealVectorValue> _ad_default_curl;
1493 
1495  const VariableValue & _zero;
1496  const VariablePhiValue & _phi_zero;
1497  const MooseArray<ADReal> & _ad_zero;
1498 
1500  const VariableGradient & _grad_zero;
1501  const MooseArray<ADRealVectorValue> & _ad_grad_zero;
1502 
1504  const VariablePhiGradient & _grad_phi_zero;
1505 
1507  const VariableSecond & _second_zero;
1508  const MooseArray<ADRealTensorValue> & _ad_second_zero;
1510  const VariablePhiSecond & _second_phi_zero;
1512  const VectorVariableValue & _vector_zero;
1514  const VectorVariableCurl & _vector_curl_zero;
1515 
1520  mutable VectorVariableValue _default_vector_value_zero;
1521 
1523  mutable VectorVariableGradient _default_vector_gradient;
1524 
1526  mutable VectorVariableCurl _default_vector_curl;
1527 
1529  mutable VectorVariableDivergence _default_div;
1530 
1535  ArrayVariableValue _default_array_value_zero;
1536 
1538  ArrayVariableGradient _default_array_gradient;
1539 
1545  bool
1546  checkVar(const std::string & var_name, unsigned int comp = 0, unsigned int comp_bound = 0) const;
1547 
1548 private:
1552  template <typename T>
1553  const typename OutputTools<T>::VariableValue &
1554  vectorTagValueHelper(const std::string & var_names, TagID tag, unsigned int index = 0) const;
1555 
1559  template <typename T>
1560  const typename OutputTools<T>::VariableValue & vectorTagValueHelper(const std::string & var_names,
1561  const std::string & tag_name,
1562  unsigned int index = 0) const;
1563 
1567  template <typename T>
1568  const typename OutputTools<T>::VariableValue &
1569  vectorTagDofValueHelper(const std::string & var_name, TagID tag, unsigned int comp = 0) const;
1570 
1574  template <typename T>
1575  const typename OutputTools<T>::VariableValue & vectorTagDofValueHelper(
1576  const std::string & var_name, const std::string & tag_name, unsigned int comp = 0) const;
1577 
1583  template <typename T>
1584  void
1585  requestStates(const std::string & var_name, const TagName & tag_name, const unsigned int comp);
1586 
1587  enum class FuncAge
1588  {
1589  Curr,
1590  Old,
1591  Older,
1592  };
1593 
1594  enum class VarType
1595  {
1596  Ignore,
1597  Gradient,
1598  Second,
1599  GradientDot,
1600  Dot,
1601  };
1602 
1603  void checkFuncType(const std::string var_name, VarType t, FuncAge age) const;
1604 
1605 protected:
1614  const MooseVariableFieldBase * getFEVar(const std::string & var_name, unsigned int comp) const;
1615 
1616  /*
1617  * Extract pointer to a base coupled field variable. Could be either a finite volume or finite
1618  * element variable
1619  * @param var_name Name of parameter desired
1620  * @param comp Component number of multiple coupled variables
1621  * @return Pointer to the desired variable
1622  */
1623  const MooseVariableFieldBase * getFieldVar(const std::string & var_name, unsigned int comp) const;
1624 
1625  /*
1626  * Extract pointer to a base coupled field variable. Could be either a finite volume or finite
1627  * element variable
1628  * @param var_name Name of variable desired
1629  * @param comp Component number of multiple coupled variables
1630  * @return Pointer to the desired variable
1631  */
1632  MooseVariableFieldBase * getFieldVar(const std::string & var_name, unsigned int comp);
1633 
1637  template <typename T>
1638  const T * getVarHelper(const std::string & var_name, unsigned int comp) const;
1639 
1643  template <typename T>
1644  T * getVarHelper(const std::string & var_name, unsigned int comp);
1645 
1652  MooseVariable * getVar(const std::string & var_name, unsigned int comp);
1653 
1660  VectorMooseVariable * getVectorVar(const std::string & var_name, unsigned int comp);
1661 
1668  ArrayMooseVariable * getArrayVar(const std::string & var_name, unsigned int comp);
1669 
1676  const MooseVariable * getVar(const std::string & var_name, unsigned int comp) const;
1677 
1684  const VectorMooseVariable * getVectorVar(const std::string & var_name, unsigned int comp) const;
1685 
1692  const ArrayMooseVariable * getArrayVar(const std::string & var_name, unsigned int comp) const;
1693 
1700  void validateExecutionerType(const std::string & name, const std::string & fn_name) const;
1701 
1702  template <typename T, typename Func>
1703  std::vector<T> coupledVectorHelper(const std::string & var_name, const Func & func) const
1704  {
1705  const auto components = coupledComponents(var_name);
1706  std::vector<T> vals(components);
1707  for (MooseIndex(components) comp = 0; comp < components; ++comp)
1708  vals[comp] = func(comp);
1709  return vals;
1710  }
1711 
1713  bool _coupleable_neighbor;
1714 
1715 public:
1722  const ADVariableValue * getADDefaultValue(const std::string & var_name) const;
1723 
1730  const ADVectorVariableValue * getADDefaultVectorValue(const std::string & var_name) const;
1731 
1738  const ADVariableGradient & getADDefaultGradient() const;
1739 
1746  const ADVectorVariableGradient & getADDefaultVectorGradient() const;
1747 
1754  const ADVariableSecond & getADDefaultSecond() const;
1755 
1762  const ADVectorVariableCurl & getADDefaultCurl() const;
1763 
1764 private:
1771  const VariableValue * getDefaultValue(const std::string & var_name, unsigned int comp) const;
1772 
1779  const VectorVariableValue * getDefaultVectorValue(const std::string & var_name) const;
1780 
1787  const ArrayVariableValue * getDefaultArrayValue(const std::string & var_name) const;
1788 
1792  template <typename T>
1793  const T & getDefaultNodalValue(const std::string & var_name, unsigned int comp = 0) const;
1794 
1795  template <typename T>
1796  const Moose::Functor<T> & getDefaultFunctor(const std::string & var_name) const;
1797 
1799  unsigned int _coupleable_max_qps;
1800 
1802  std::unordered_map<std::string, std::vector<unsigned int>> _optional_var_index;
1803 
1805  std::unordered_map<std::string, std::vector<MooseVariableScalar *>> _c_coupled_scalar_vars;
1806 
1807  std::set<TagID> _fe_coupleable_vector_tags;
1808 
1809  std::set<TagID> _fe_coupleable_matrix_tags;
1810 
1812  const bool _is_fv;
1813 
1814  const MooseObject * const _obj;
1815 
1817  const std::set<std::string> _older_state_tags = {Moose::OLD_SOLUTION_TAG,
1818  Moose::OLDER_SOLUTION_TAG};
1819 
1821  std::vector<std::set<MooseWritableVariable *>> _writable_coupled_variables;
1822 
1826 private:
1827  const Real _kokkos_default_value_zero = 0;
1828 
1829 #ifdef MOOSE_KOKKOS_SCOPE
1830  Moose::Kokkos::Variable kokkosCoupledVectorTagVariable(const std::string & var_name,
1831  const std::string & tag_name,
1832  unsigned int comp);
1833  Moose::Kokkos::Variable kokkosCoupledVectorTagVariables(const std::string & var_name,
1834  const std::string & tag_name);
1835  Moose::Kokkos::Variable kokkosZeroVariable();
1836 
1837 public:
1838  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValueByName(const std::string & var_name,
1839  const std::string & tag_name,
1840  unsigned int comp = 0);
1841  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValuesByName(const std::string & var_name,
1842  const std::string & tag_name);
1843  Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientByName(const std::string & var_name,
1844  const std::string & tag_name,
1845  unsigned int comp = 0);
1846  Moose::Kokkos::VariableGradient
1847  kokkosCoupledVectorTagGradientsByName(const std::string & var_name, const std::string & tag_name);
1848  Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValueByName(const std::string & var_name,
1849  const std::string & tag_name,
1850  unsigned int comp = 0);
1851  Moose::Kokkos::VariableValue
1852  kokkosCoupledVectorTagNodalValuesByName(const std::string & var_name,
1853  const std::string & tag_name);
1854 
1855  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValue(const std::string & var_name,
1856  const std::string & tag_param_name,
1857  unsigned int comp = 0);
1858  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValues(const std::string & var_name,
1859  const std::string & tag_param_name);
1860  Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradient(const std::string & var_name,
1861  const std::string & tag_param_name,
1862  unsigned int comp = 0);
1863  Moose::Kokkos::VariableGradient
1864  kokkosCoupledVectorTagGradients(const std::string & var_name, const std::string & tag_param_name);
1865  Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValue(const std::string & var_name,
1866  const std::string & tag_param_name,
1867  unsigned int comp = 0);
1868  Moose::Kokkos::VariableValue
1869  kokkosCoupledVectorTagNodalValues(const std::string & var_name,
1870  const std::string & tag_param_name);
1871 
1872  Moose::Kokkos::VariableValue kokkosCoupledValue(const std::string & var_name,
1873  unsigned int comp = 0);
1874  Moose::Kokkos::VariableValue kokkosCoupledValues(const std::string & var_name);
1875  Moose::Kokkos::VariableGradient kokkosCoupledGradient(const std::string & var_name,
1876  unsigned int comp = 0);
1877  Moose::Kokkos::VariableGradient kokkosCoupledGradients(const std::string & var_name);
1878  Moose::Kokkos::VariableValue kokkosCoupledNodalValue(const std::string & var_name,
1879  unsigned int comp = 0);
1880  Moose::Kokkos::VariableValue kokkosCoupledNodalValues(const std::string & var_name);
1881 
1882  Moose::Kokkos::VariableValue kokkosCoupledValueOld(const std::string & var_name,
1883  unsigned int comp = 0);
1884  Moose::Kokkos::VariableValue kokkosCoupledValuesOld(const std::string & var_name);
1885  Moose::Kokkos::VariableGradient kokkosCoupledGradientOld(const std::string & var_name,
1886  unsigned int comp = 0);
1887  Moose::Kokkos::VariableGradient kokkosCoupledGradientsOld(const std::string & var_name);
1888  Moose::Kokkos::VariableValue kokkosCoupledNodalValueOld(const std::string & var_name,
1889  unsigned int comp = 0);
1890  Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOld(const std::string & var_name);
1891 
1892  Moose::Kokkos::VariableValue kokkosCoupledValueOlder(const std::string & var_name,
1893  unsigned int comp = 0);
1894  Moose::Kokkos::VariableValue kokkosCoupledValuesOlder(const std::string & var_name);
1895  Moose::Kokkos::VariableGradient kokkosCoupledGradientOlder(const std::string & var_name,
1896  unsigned int comp = 0);
1897  Moose::Kokkos::VariableGradient kokkosCoupledGradientsOlder(const std::string & var_name);
1898  Moose::Kokkos::VariableValue kokkosCoupledNodalValueOlder(const std::string & var_name,
1899  unsigned int comp = 0);
1900  Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOlder(const std::string & var_name);
1901 
1902  Moose::Kokkos::VariableValue kokkosCoupledDot(const std::string & var_name,
1903  unsigned int comp = 0);
1904  Moose::Kokkos::VariableValue kokkosCoupledDots(const std::string & var_name);
1905  Moose::Kokkos::VariableValue kokkosCoupledNodalDot(const std::string & var_name,
1906  unsigned int comp = 0);
1907  Moose::Kokkos::VariableValue kokkosCoupledNodalDots(const std::string & var_name);
1908 
1909  Moose::Kokkos::Scalar<const Real> kokkosCoupledDotDu(const std::string & var_name,
1910  unsigned int comp = 0);
1911 
1912  Moose::Kokkos::VariableValue kokkosZeroValue();
1913  Moose::Kokkos::VariableGradient kokkosZeroGradient();
1914  Moose::Kokkos::VariableValue kokkosZeroNodalValue();
1915 #endif
1916 };
1917 
1918 template <typename T>
1919 T *
1920 Coupleable::getVarHelper(const std::string & var_name_in, unsigned int comp)
1921 {
1922  const auto var_name = _c_parameters.checkForRename(var_name_in);
1923  auto name_to_use = var_name;
1924 
1925  // First check for supplied name
1926  if (!checkVar(var_name, comp, 0))
1927  {
1928  // See if there is an associated deprecated name that the user may have used instead
1929  auto it = _new_to_deprecated_coupled_vars.find(var_name);
1930  if (it == _new_to_deprecated_coupled_vars.end())
1931  return nullptr;
1932  else
1933  {
1934  auto deprecated_name = it->second;
1935  if (checkVar(deprecated_name, comp, 0))
1936  name_to_use = deprecated_name;
1937  else
1938  return nullptr;
1939  }
1940  }
1941 
1942  auto coupled_vars_it = _coupled_vars.find(name_to_use);
1943 
1944  mooseAssert(coupled_vars_it != _coupled_vars.end(),
1945  "Trying to get a coupled var " << name_to_use << " that doesn't exist");
1946 
1947  if (auto coupled_var = dynamic_cast<T *>(coupled_vars_it->second[comp]))
1948  return coupled_var;
1949  else
1950  {
1951  for (auto & var : _coupled_standard_moose_vars)
1952  if (var->name() == name_to_use)
1953  mooseError("The named variable is a standard variable, try a "
1954  "'coupled[Value/Gradient/Dot/etc]...' function instead");
1955  for (auto & var : _coupled_vector_moose_vars)
1956  if (var->name() == name_to_use)
1957  mooseError("The named variable is a vector variable, try a "
1958  "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
1959  for (auto & var : _coupled_array_moose_vars)
1960  if (var->name() == name_to_use)
1961  mooseError("The named variable is an array variable, try a "
1962  "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
1963  for (auto & var : _coupled_fv_moose_vars)
1964  if (var->name() == name_to_use)
1965  mooseError("The named variable is a finite volume variable, which the coupled[...] routine "
1966  "used does not support. Try using the functor system routines instead.");
1967  mooseError(
1968  "Variable '", name_to_use, "' is of a different C++ type than you tried to fetch it as.");
1969  }
1970 }
1971 
1972 template <typename T>
1973 const T *
1974 Coupleable::getVarHelper(const std::string & var_name, unsigned int comp) const
1975 {
1976  return const_cast<Coupleable *>(this)->getVarHelper<T>(var_name, comp);
1977 }
Coupleable::coupledArrayDotDotOld
virtual const ArrayVariableValue & coupledArrayDotDotOld(const std::string &var_name, unsigned int comp=0) const
Old second time derivative of a coupled array variable.
Definition: Coupleable.C:1446
Coupleable::coupledDofValues
virtual const VariableValue & coupledDofValues(const std::string &var_name, unsigned int comp=0) const
Returns DoFs in the current solution vector of a coupled variable for the local element.
Definition: Coupleable.C:2057
Coupleable::coupledVectorTagValue
virtual const VariableValue & coupledVectorTagValue(const std::string &var_names, TagID tag, unsigned int index=0) const
Returns value of a coupled variable for a given tag.
Definition: Coupleable.C:649
Coupleable::coupledVectorTagGradient
virtual const VariableGradient & coupledVectorTagGradient(const std::string &var_names, TagID tag, unsigned int index=0) const
Returns gradient of a coupled variable for a given tag.
Definition: Coupleable.C:681
Coupleable::coupledArrayValueOlder
virtual const ArrayVariableValue & coupledArrayValueOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old value from two time steps previous of a coupled array variable.
Definition: Coupleable.C:1148
VariableGradient
OutputTools< Real >::VariableGradient VariableGradient
Definition: MooseTypes.h:316
Coupleable::kokkosCoupledDots
Moose::Kokkos::VariableValue kokkosCoupledDots(const std::string &var_name)
Coupleable::coupledNodalDot
const T & coupledNodalDot(const std::string &var_name, unsigned int comp=0) const
Nodal values of time derivative of a coupled variable.
Definition: Coupleable.C:1995
Coupleable::kokkosZeroNodalValue
Moose::Kokkos::VariableValue kokkosZeroNodalValue()
VectorVariableDivergence
OutputTools< RealVectorValue >::VariableDivergence VectorVariableDivergence
Definition: MooseTypes.h:336
Coupleable::validateExecutionerType
void validateExecutionerType(const std::string &name, const std::string &fn_name) const
Checks to make sure that the current Executioner has set "_is_transient" when old/older values are co...
Definition: Coupleable.C:2148
Coupleable::isCoupled
virtual bool isCoupled(const std::string &var_name, unsigned int i=0) const
Returns true if a variables has been coupled as name.
Definition: Coupleable.C:159
Coupleable::coupledVectorGradient
virtual const VectorVariableGradient & coupledVectorGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled vector variable.
Definition: Coupleable.C:1640
Coupleable::getCoupledArrayMooseVars
const std::vector< ArrayMooseVariable * > & getCoupledArrayMooseVars() const
Get the list of array coupled variables.
Definition: Coupleable.h:108
Coupleable::_c_nodal
bool _c_nodal
True if we provide coupling to nodal values.
Definition: Coupleable.h:1441
Coupleable::checkFuncType
void checkFuncType(const std::string var_name, VarType t, FuncAge age) const
Definition: Coupleable.C:222
Coupleable::getCoupledVectorMooseVars
const std::vector< VectorMooseVariable * > & getCoupledVectorMooseVars() const
Get the list of vector coupled variables.
Definition: Coupleable.h:99
Coupleable::kokkosZeroVariable
Moose::Kokkos::Variable kokkosZeroVariable()
Coupleable::_default_vector_curl
VectorVariableCurl _default_vector_curl
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1526
Coupleable::kokkosCoupledVectorTagValue
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValue(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)
GenericVectorVariableValue
Moose::GenericType< VectorVariableValue, is_ad > GenericVectorVariableValue
Definition: MooseTypes.h:665
Coupleable::kokkosCoupledValuesOlder
Moose::Kokkos::VariableValue kokkosCoupledValuesOlder(const std::string &var_name)
Coupleable::getVectorVar
VectorMooseVariable * getVectorVar(const std::string &var_name, unsigned int comp)
Extract pointer to a coupled vector variable.
Definition: Coupleable.C:324
Coupleable::_zero
const VariableValue & _zero
Zero value of a variable.
Definition: Coupleable.h:1495
Coupleable::_grad_phi_zero
const VariablePhiGradient & _grad_phi_zero
Zero gradient of trial function.
Definition: Coupleable.h:1504
Coupleable::coupled
virtual unsigned int coupled(const std::string &var_name, unsigned int comp=0) const
Returns the index for a coupled variable by name.
Definition: Coupleable.C:472
Coupleable::coupledVectorDotDot
virtual const VectorVariableValue & coupledVectorDotDot(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled vector variable.
Definition: Coupleable.C:1300
Coupleable::_second_phi_zero
const VariablePhiSecond & _second_phi_zero
Zero second derivative of a test function.
Definition: Coupleable.h:1510
Coupleable::coupledSecondPreviousNL
virtual const VariableSecond & coupledSecondPreviousNL(const std::string &var_name, unsigned int comp=0) const
Returns second derivative of a coupled variable for the previous Newton iterate.
Definition: Coupleable.C:1901
Coupleable::_ad_default_vector_value
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADRealVectorValue > > > _ad_default_vector_value
Will hold the default value for optional vector coupled variables for automatic differentiation.
Definition: Coupleable.h:1468
Coupleable::getDefaultArrayValue
const ArrayVariableValue * getDefaultArrayValue(const std::string &var_name) const
Helper method to return (and insert if necessary) the default value for an uncoupled array variable...
Definition: Coupleable.C:427
Coupleable::coupledGenericGradient
const GenericVariableGradient< is_ad > & coupledGenericGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled variable for use in templated automatic differentiation.
Coupleable::kokkosCoupledGradientsOld
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOld(const std::string &var_name)
Coupleable::coupledValuesOlder
std::vector< const VariableValue * > coupledValuesOlder(const std::string &var_name) const
Returns the older values for all of a coupled variable&#39;s components.
Definition: Coupleable.C:2726
Coupleable::adZeroSecond
const ADVariableSecond & adZeroSecond() const
Retrieve a zero second for automatic differentiation.
Definition: Coupleable.C:2444
Coupleable::getADDefaultVectorValue
const ADVectorVariableValue * getADDefaultVectorValue(const std::string &var_name) const
Helper method to return (and insert if necessary) the default vector value for Automatic Differentiat...
Definition: Coupleable.C:2385
Coupleable::coupledSecond
virtual const VariableSecond & coupledSecond(const std::string &var_name, unsigned int comp=0) const
Returns second spatial derivatives of a coupled variable.
Definition: Coupleable.C:1853
Coupleable::isCoupledConstant
virtual bool isCoupledConstant(const std::string &var_name) const
Returns true if a variable passed as a coupled value is really a constant.
Definition: Coupleable.C:182
Coupleable::coupledDotOld
virtual const VariableValue & coupledDotOld(const std::string &var_name, unsigned int comp=0) const
Old time derivative of a coupled variable.
Definition: Coupleable.C:1234
Coupleable::kokkosCoupledVectorTagVariables
Moose::Kokkos::Variable kokkosCoupledVectorTagVariables(const std::string &var_name, const std::string &tag_name)
Coupleable::coupledVectorValueOld
virtual const VectorVariableValue & coupledVectorValueOld(const std::string &var_name, unsigned int comp=0) const
Returns an old value from previous time step of a coupled vector variable.
Definition: Coupleable.C:1098
Coupleable::kokkosCoupledGradientsOlder
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOlder(const std::string &var_name)
Coupleable::kokkosCoupledVectorTagNodalValuesByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValuesByName(const std::string &var_name, const std::string &tag_name)
Coupleable::coupledArrayValues
std::vector< const ArrayVariableValue * > coupledArrayValues(const std::string &var_name) const
Returns the values for all of a coupled array variable&#39;s components.
Definition: Coupleable.C:901
Coupleable::coupledDots
std::vector< const VariableValue * > coupledDots(const std::string &var_name) const
Returns the time derivatives for all of a coupled variable&#39;s components.
Definition: Coupleable.C:2777
Coupleable::coupledArrayValueOld
virtual const ArrayVariableValue & coupledArrayValueOld(const std::string &var_name, unsigned int comp=0) const
Returns an old value from previous time step of a coupled array variable.
Definition: Coupleable.C:1126
TagID
unsigned int TagID
Definition: MooseTypes.h:210
Coupleable::kokkosZeroValue
Moose::Kokkos::VariableValue kokkosZeroValue()
Coupleable::coupledName
VariableName coupledName(const std::string &var_name, unsigned int comp=0) const
Names of the variable in the Coupleable interface.
Definition: Coupleable.C:2514
Coupleable::coupledVectorGradientOld
virtual const VectorVariableGradient & coupledVectorGradientOld(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from previous time step of a coupled vector variable.
Definition: Coupleable.C:1656
MooseWritableVariable
MooseVariableField< Real > MooseWritableVariable
Definition: Coupleable.h:42
MooseVariableField
Class for stuff related to variables.
Definition: FVInitialConditionTempl.h:23
Coupleable::_vector_zero
const VectorVariableValue & _vector_zero
Zero value of a vector variable.
Definition: Coupleable.h:1512
Coupleable::_grad_zero
const VariableGradient & _grad_zero
Zero gradient of a variable.
Definition: Coupleable.h:1500
Coupleable::_coupled_vars
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _coupled_vars
Coupled vars whose values we provide.
Definition: Coupleable.h:1420
Coupleable::_fe_coupleable_matrix_tags
std::set< TagID > _fe_coupleable_matrix_tags
Definition: Coupleable.h:1809
Coupleable::_ad_grad_zero
const MooseArray< ADRealVectorValue > & _ad_grad_zero
Definition: Coupleable.h:1501
Coupleable::coupledVectorDot
virtual const VectorVariableValue & coupledVectorDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled vector variable.
Definition: Coupleable.C:1284
Coupleable::coupledDotDotDu
virtual const VariableValue & coupledDotDotDu(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled variable with respect to the coefficients.
Definition: Coupleable.C:1493
Coupleable::checkWritableVar
void checkWritableVar(MooseWritableVariable *var)
Checks that the passed in variable is only accessed writable by one object in a given subdomain...
Definition: Coupleable.C:982
mooseError
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:323
Coupleable::_is_fv
const bool _is_fv
Whether the MooseObject is a finite volume object.
Definition: Coupleable.h:1812
Coupleable::coupledDofValuesOld
virtual const VariableValue & coupledDofValuesOld(const std::string &var_name, unsigned int comp=0) const
Returns DoFs in the old solution vector of a coupled variable for the local element.
Definition: Coupleable.C:2077
Moose::OLDER_SOLUTION_TAG
const TagName OLDER_SOLUTION_TAG
Definition: MooseTypes.C:27
Coupleable::kokkosCoupledGradientOlder
Moose::Kokkos::VariableGradient kokkosCoupledGradientOlder(const std::string &var_name, unsigned int comp=0)
Coupleable::coupledGenericValues
std::vector< const GenericVariableValue< is_ad > * > coupledGenericValues(const std::string &var_name) const
Returns the values for all of a coupled variable&#39;s components for use in templated automatic differen...
Coupleable::_coupled_array_moose_vars
std::vector< ArrayMooseVariable * > _coupled_array_moose_vars
Vector of array coupled variables.
Definition: Coupleable.h:1432
Coupleable::coupledVectorTagArrayDofValue
const ArrayVariableValue & coupledVectorTagArrayDofValue(const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Returns evaluations of a tagged vector at the requested variable&#39;s degree of freedom indices...
Definition: Coupleable.C:813
Coupleable::_second_zero
const VariableSecond & _second_zero
Zero second derivative of a variable.
Definition: Coupleable.h:1507
Coupleable::coupledVectorValuesOld
std::vector< const VectorVariableValue * > coupledVectorValuesOld(const std::string &var_name) const
Returns the old values for all of a coupled vector variable&#39;s components.
Definition: Coupleable.C:2733
Coupleable::coupledNodalValue
const T & coupledNodalValue(const std::string &var_name, unsigned int comp=0) const
Returns nodal values of a coupled variable.
Definition: Coupleable.C:1919
Coupleable::coupledVectorHelper
std::vector< T > coupledVectorHelper(const std::string &var_name, const Func &func) const
Definition: Coupleable.h:1703
Coupleable::coupledVectorTagDofValue
virtual const VariableValue & coupledVectorTagDofValue(const std::string &var_name, TagID tag, unsigned int index=0) const
Returns dof value of a coupled variable for a given tag.
Definition: Coupleable.C:797
VectorVariableValue
OutputTools< RealVectorValue >::VariableValue VectorVariableValue
Definition: MooseTypes.h:332
Coupleable::adCoupledGradient
const ADVariableGradient & adCoupledGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled variable for use in Automatic Differentiation.
Definition: Coupleable.C:2222
Coupleable::_default_div
VectorVariableDivergence _default_div
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1529
Coupleable::kokkosCoupledNodalValuesOlder
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOlder(const std::string &var_name)
Coupleable::_c_allow_element_to_nodal_coupling
const bool _c_allow_element_to_nodal_coupling
Definition: Coupleable.h:1447
Coupleable::coupledVectorTagArrayValues
std::vector< const ArrayVariableValue * > coupledVectorTagArrayValues(const std::string &var_names, TagID tag) const
Returns the values for all the coupled variables desired for a given tag.
Definition: Coupleable.C:2604
Coupleable::kokkosCoupledVectorTagGradientsByName
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientsByName(const std::string &var_name, const std::string &tag_name)
Coupleable::coupledArrayDofValues
virtual const ArrayVariableValue & coupledArrayDofValues(const std::string &var_name, unsigned int comp=0) const
Returns DoFs in the current solution vector of a coupled array variable for the local element...
Definition: Coupleable.C:2118
Coupleable::coupledVectorTagGradients
std::vector< const VariableGradient * > coupledVectorTagGradients(const std::string &var_names, TagID tag) const
Returns gradients for all the coupled variables desired for a given tag.
Definition: Coupleable.C:2627
Coupleable::_fe_coupleable_vector_tags
std::set< TagID > _fe_coupleable_vector_tags
Definition: Coupleable.h:1807
Moose::FunctorEnvelope
This is a wrapper that forwards calls to the implementation, which can be switched out at any time wi...
Definition: MooseFunctor.h:1040
Coupleable::_ad_default_curl
MooseArray< ADRealVectorValue > _ad_default_curl
This will always be zero because the default values for optionally coupled vector variables is always...
Definition: Coupleable.h:1492
Coupleable::kokkosCoupledValue
Moose::Kokkos::VariableValue kokkosCoupledValue(const std::string &var_name, unsigned int comp=0)
Coupleable::coupledDot
virtual const VariableValue & coupledDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled variable.
Definition: Coupleable.C:1170
Coupleable::_c_tid
THREAD_ID _c_tid
Thread ID of the thread using this object.
Definition: Coupleable.h:1450
Coupleable::adCoupledValue
const ADVariableValue & adCoupledValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled variable for use in Automatic Differentiation.
Definition: Coupleable.C:2184
Coupleable::kokkosCoupledDot
Moose::Kokkos::VariableValue kokkosCoupledDot(const std::string &var_name, unsigned int comp=0)
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition: InputParameters.h:66
Coupleable::coupledNodalDotDot
virtual const VariableValue & coupledNodalDotDot(const std::string &var_name, unsigned int comp=0) const
Nodal values of second time derivative of a coupled variable.
Definition: Coupleable.C:2009
Coupleable::getADDefaultGradient
const ADVariableGradient & getADDefaultGradient() const
Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation ...
Definition: Coupleable.C:2402
Coupleable::getDefaultVectorValue
const VectorVariableValue * getDefaultVectorValue(const std::string &var_name) const
Helper method to return (and insert if necessary) the default value for an uncoupled vector variable...
Definition: Coupleable.C:392
Coupleable::_writable_coupled_variables
std::vector< std::set< MooseWritableVariable * > > _writable_coupled_variables
keep a set of allocated writable variable references to make sure only one object can obtain them per...
Definition: Coupleable.h:1821
Coupleable::coupledGradientDotDot
virtual const VariableGradient & coupledGradientDotDot(const std::string &var_name, unsigned int comp=0) const
Second time derivative of the gradient of a coupled variable.
Definition: Coupleable.C:1624
VariablePhiValue
OutputTools< Real >::VariablePhiValue VariablePhiValue
Definition: MooseTypes.h:320
Coupleable::_c_coupled_scalar_vars
std::unordered_map< std::string, std::vector< MooseVariableScalar * > > _c_coupled_scalar_vars
Scalar variables coupled into this object (for error checking)
Definition: Coupleable.h:1805
Coupleable::_default_value_zero
VariableValue _default_value_zero
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1474
Coupleable::getVar
MooseVariable * getVar(const std::string &var_name, unsigned int comp)
Extract pointer to a coupled variable.
Definition: Coupleable.C:318
Coupleable::getADDefaultCurl
const ADVectorVariableCurl & getADDefaultCurl() const
Helper method to return (and insert if necessary) the default curl value for Automatic Differentiatio...
Definition: Coupleable.C:2423
Coupleable::kokkosCoupledNodalValue
Moose::Kokkos::VariableValue kokkosCoupledNodalValue(const std::string &var_name, unsigned int comp=0)
Coupleable::genericZeroGradient
const GenericVariableGradient< is_ad > & genericZeroGradient()
Returns zero gradient templated with automatic differentiation boolean.
VectorVariableCurl
OutputTools< RealVectorValue >::VariableCurl VectorVariableCurl
Definition: MooseTypes.h:335
Coupleable::coupledArrayDotOld
virtual const ArrayVariableValue & coupledArrayDotOld(const std::string &var_name, unsigned int comp=0) const
Old time derivative of a coupled array variable.
Definition: Coupleable.C:1424
Coupleable::kokkosCoupledNodalValueOld
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOld(const std::string &var_name, unsigned int comp=0)
Coupleable::coupledValueOld
virtual const VariableValue & coupledValueOld(const std::string &var_name, unsigned int comp=0) const
Returns an old value from previous time step of a coupled variable.
Definition: Coupleable.C:1031
MooseVariableFieldBase
This class provides an interface for common operations on field variables of both FE and FV types wit...
Definition: MooseVariableFieldBase.h:29
Coupleable::coupledArrayDot
virtual const ArrayVariableValue & coupledArrayDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled array variable.
Definition: Coupleable.C:1380
Coupleable::coupledGenericDotDot
const GenericVariableValue< is_ad > & coupledGenericDotDot(const std::string &var_name, unsigned int comp=0) const
Returns the second time derivative of a coupled variable for use in templated automatic differentiati...
Coupleable::kokkosCoupledValues
Moose::Kokkos::VariableValue kokkosCoupledValues(const std::string &var_name)
libMesh
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
Coupleable::coupledMatrixTagValue
virtual const VariableValue & coupledMatrixTagValue(const std::string &var_names, TagID tag, unsigned int index=0) const
Returns value of a coupled variable for a given tag.
Definition: Coupleable.C:821
Coupleable::coupledCallback
virtual void coupledCallback(const std::string &, bool) const
A call-back function provided by the derived object for actions before coupling a variable with funct...
Definition: Coupleable.h:146
Coupleable::adZeroGradient
const ADVariableGradient & adZeroGradient() const
method that returns _grad_zero to RESIDUAL computing objects and _ad_grad_zero to JACOBIAN computing ...
Definition: Coupleable.C:2437
Coupleable::writableVariable
MooseWritableVariable & writableVariable(const std::string &var_name, unsigned int comp=0)
Returns a writable MooseVariable object for a nodal or elemental variable.
Definition: Coupleable.C:908
SystemBase
Base class for a system (of equations)
Definition: SystemBase.h:84
Coupleable::coupledDivOlder
virtual const VectorVariableDivergence & coupledDivOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old divergence from two time steps previous of a coupled variable.
Definition: Coupleable.C:1837
Coupleable::_default_vector_value
std::unordered_map< std::string, std::unique_ptr< VectorVariableValue > > _default_vector_value
Will hold the default value for optional vector coupled variables.
Definition: Coupleable.h:1461
Coupleable::writableCoupledValue
virtual VariableValue & writableCoupledValue(const std::string &var_name, unsigned int comp=0)
Returns a writable reference to a coupled variable for writing to multiple AuxVariables from a single...
Definition: Coupleable.C:944
Coupleable::coupledNames
std::vector< VariableName > coupledNames(const std::string &var_name) const
Names of the variables in the Coupleable interface.
Definition: Coupleable.C:2531
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblemBase.h:144
Coupleable::coupledGradient
virtual const VariableGradient & coupledGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled variable.
Definition: Coupleable.C:1543
Coupleable::getVarHelper
const T * getVarHelper(const std::string &var_name, unsigned int comp) const
Helper that that be used to retrieve a variable of arbitrary type T.
Definition: Coupleable.h:1974
Coupleable::kokkosCoupledGradients
Moose::Kokkos::VariableGradient kokkosCoupledGradients(const std::string &var_name)
VariablePhiSecond
OutputTools< Real >::VariablePhiSecond VariablePhiSecond
Definition: MooseTypes.h:322
Coupleable::coupledNodalValuePreviousNL
const T & coupledNodalValuePreviousNL(const std::string &var_name, unsigned int comp=0) const
Returns nodal values of a coupled variable for previous Newton iterate.
Definition: Coupleable.C:1979
Coupleable::kokkosCoupledValueOld
Moose::Kokkos::VariableValue kokkosCoupledValueOld(const std::string &var_name, unsigned int comp=0)
Coupleable::adCoupledValues
std::vector< const ADVariableValue * > adCoupledValues(const std::string &var_name) const
Returns the values for all of a coupled variable&#39;s components for use in Automatic Differentiation...
Definition: Coupleable.C:2566
Coupleable::coupledValueOlder
virtual const VariableValue & coupledValueOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old value from two time steps previous of a coupled variable.
Definition: Coupleable.C:1053
Coupleable::_coupled_standard_moose_vars
std::vector< MooseVariable * > _coupled_standard_moose_vars
Vector of standard coupled variables.
Definition: Coupleable.h:1426
Coupleable::kokkosCoupledVectorTagGradient
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradient(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)
Coupleable::kokkosCoupledGradient
Moose::Kokkos::VariableGradient kokkosCoupledGradient(const std::string &var_name, unsigned int comp=0)
Coupleable::getCoupledStandardMooseVars
const std::vector< MooseVariable * > & getCoupledStandardMooseVars() const
Get the list of standard coupled variables.
Definition: Coupleable.h:90
Coupleable::adCoupledDotDot
const ADVariableValue & adCoupledDotDot(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled variable for ad simulations.
Definition: Coupleable.C:2304
Coupleable::_c_sys
const SystemBase *const _c_sys
Pointer to the system object if the moose object this is an interface for has one.
Definition: Coupleable.h:1417
Coupleable::_c_fe_problem
FEProblemBase & _c_fe_problem
Definition: Coupleable.h:1414
Coupleable::coupledVectorTagArrayValue
virtual const ArrayVariableValue & coupledVectorTagArrayValue(const std::string &var_names, TagID tag, unsigned int index=0) const
Returns value of a coupled array variable for a given tag.
Definition: Coupleable.C:665
Coupleable::coupledGenericVectorValue
const GenericVectorVariableValue< is_ad > & coupledGenericVectorValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled vector variable for use in templated automatic differentiation classes...
Coupleable::coupledSecondOlder
virtual const VariableSecond & coupledSecondOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old second derivative from two time steps previous of a coupled variable.
Definition: Coupleable.C:1885
Coupleable::vectorTagDofValueHelper
const OutputTools< T >::VariableValue & vectorTagDofValueHelper(const std::string &var_name, TagID tag, unsigned int comp=0) const
Generic helper method to get vector tag degree of freedom values based on tag ID. ...
Definition: Coupleable.C:758
Coupleable::_c_is_implicit
bool _c_is_implicit
True if implicit value is required.
Definition: Coupleable.h:1444
Coupleable::coupledValue
virtual const VariableValue & coupledValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled variable.
Definition: Coupleable.C:527
Coupleable::adCoupledLowerValue
const ADVariableValue & adCoupledLowerValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled lower-dimensional variable for use in Automatic Differentiation.
Definition: Coupleable.C:2204
Coupleable::coupledVectorValueOlder
virtual const VectorVariableValue & coupledVectorValueOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old value from two time steps previous of a coupled vector variable.
Definition: Coupleable.C:1113
Coupleable::kokkosCoupledNodalValues
Moose::Kokkos::VariableValue kokkosCoupledNodalValues(const std::string &var_name)
Coupleable::adCoupledVectorSecond
const ADVectorVariableSecond & adCoupledVectorSecond(const std::string &var_name, unsigned int comp=0) const
Returns second derivatives of a coupled vector variable for use in Automatic Differentiation.
Coupleable::_coupled_vector_moose_vars
std::vector< VectorMooseVariable * > _coupled_vector_moose_vars
Vector of vector coupled variables.
Definition: Coupleable.h:1429
Coupleable::requestStates
void requestStates(const std::string &var_name, const TagName &tag_name, const unsigned int comp)
Method that may request additional solution states from the variable&#39;s system depending on the value ...
Definition: Coupleable.C:578
Coupleable::coupledValueLower
virtual const VariableValue & coupledValueLower(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled lower-dimensional variable.
Definition: Coupleable.C:632
Coupleable::Coupleable
Coupleable(const MooseObject *moose_object, bool nodal, bool is_fv=false)
Constructing the object.
Definition: Coupleable.C:27
Coupleable::coupledGradientOld
virtual const VariableGradient & coupledGradientOld(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from previous time step of a coupled variable.
Definition: Coupleable.C:1559
Coupleable::kokkosZeroGradient
Moose::Kokkos::VariableGradient kokkosZeroGradient()
Coupleable::coupledVectorTagDofValues
std::vector< const VariableValue * > coupledVectorTagDofValues(const std::string &var_names, TagID tag) const
Returns the dof values for all the coupled variables desired for a given tag.
Definition: Coupleable.C:2673
Coupleable::_kokkos_default_value_zero
const Real _kokkos_default_value_zero
kokkos-related variables and methods
Definition: Coupleable.h:1827
ArrayVariableValue
OutputTools< RealEigenVector >::VariableValue ArrayVariableValue
Definition: MooseTypes.h:349
Coupleable::coupledVectorDotDu
virtual const VariableValue & coupledVectorDotDu(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled vector variable with respect to the coefficients.
Definition: Coupleable.C:1348
Coupleable::addFEVariableCoupleableVectorTag
void addFEVariableCoupleableVectorTag(TagID tag)
Definition: Coupleable.h:113
Coupleable::coupledSecondOld
virtual const VariableSecond & coupledSecondOld(const std::string &var_name, unsigned int comp=0) const
Returns an old second spatial derivatives from previous time step of a coupled variable.
Definition: Coupleable.C:1869
GenericVariableValue
Moose::GenericType< VariableValue, is_ad > GenericVariableValue
Definition: MooseTypes.h:663
Coupleable::getWritableCoupledVariables
auto & getWritableCoupledVariables() const
returns a reference to the set of writable coupled variables
Definition: Coupleable.h:134
Moose::OLD_SOLUTION_TAG
const TagName OLD_SOLUTION_TAG
Definition: MooseTypes.C:26
MooseObject
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:27
GenericVariableGradient
Moose::GenericType< VariableGradient, is_ad > GenericVariableGradient
Definition: MooseTypes.h:667
Coupleable::coupledArrayValue
virtual const ArrayVariableValue & coupledArrayValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled array variable.
Definition: Coupleable.C:879
Coupleable::vectorTagValueHelper
const OutputTools< T >::VariableValue & vectorTagValueHelper(const std::string &var_names, TagID tag, unsigned int index=0) const
Generic helper method to get vector tag values based on tag ID.
Definition: Coupleable.C:552
Coupleable::coupledGradientsOld
std::vector< const VariableGradient * > coupledGradientsOld(const std::string &var_name) const
Returns the old gradients for all of a coupled variable&#39;s components.
Definition: Coupleable.C:2770
Coupleable::coupledVectorTagArrayGradient
virtual const ArrayVariableGradient & coupledVectorTagArrayGradient(const std::string &var_names, TagID tag, unsigned int index=0) const
Returns gradient of a coupled array variable for a given tag.
Definition: Coupleable.C:719
Coupleable::_default_gradient
VariableGradient _default_gradient
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1477
Coupleable::_default_second
VariableSecond _default_second
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1486
Coupleable::_ad_default_value
std::unordered_map< std::string, std::unique_ptr< MooseArray< ADReal > > > _ad_default_value
Will hold the default value for optional coupled variables for automatic differentiation.
Definition: Coupleable.h:1457
Coupleable::getDefaultValue
const VariableValue * getDefaultValue(const std::string &var_name, unsigned int comp) const
Helper method to return (and insert if necessary) the default value for an uncoupled variable...
Definition: Coupleable.C:365
Coupleable::kokkosCoupledNodalValuesOld
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOld(const std::string &var_name)
Coupleable::adCoupledDots
std::vector< const ADVariableValue * > adCoupledDots(const std::string &var_name) const
Returns the time derivatives for all of a coupled variable&#39;s components for ad simulations.
Definition: Coupleable.C:2784
Coupleable::coupledGenericValue
const GenericVariableValue< is_ad > & coupledGenericValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled variable for use in templated automatic differentiation classes...
Coupleable::coupledGradientDot
virtual const VariableGradient & coupledGradientDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of the gradient of a coupled variable.
Definition: Coupleable.C:1608
Coupleable::getADDefaultValue
const ADVariableValue * getADDefaultValue(const std::string &var_name) const
Helper method to return (and insert if necessary) the default value for Automatic Differentiation for...
Definition: Coupleable.C:2371
Coupleable::adCoupledDot
const ADVariableValue & adCoupledDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled variable for ad simulations.
Definition: Coupleable.C:2281
Coupleable::kokkosCoupledValueOlder
Moose::Kokkos::VariableValue kokkosCoupledValueOlder(const std::string &var_name, unsigned int comp=0)
Coupleable::_c_name
const std::string & _c_name
The name of the object this interface is part of.
Definition: Coupleable.h:1409
Coupleable::kokkosCoupledNodalDots
Moose::Kokkos::VariableValue kokkosCoupledNodalDots(const std::string &var_name)
Coupleable::coupledGenericDofValue
const GenericVariableValue< is_ad > & coupledGenericDofValue(const std::string &var_name, unsigned int comp=0) const
Returns DOF value of a coupled variable for use in templated automatic differentiation classes...
Coupleable::coupledCurlOld
virtual const VectorVariableCurl & coupledCurlOld(const std::string &var_name, unsigned int comp=0) const
Returns an old curl from previous time step of a coupled variable.
Definition: Coupleable.C:1756
Coupleable::adCoupledDofValues
virtual const ADVariableValue & adCoupledDofValues(const std::string &var_name, unsigned int comp=0) const
Returns DOF value of a coupled variable for use in Automatic Differentiation.
Definition: Coupleable.C:2131
Coupleable::coupledNodalDotDotOld
virtual const VariableValue & coupledNodalDotDotOld(const std::string &var_name, unsigned int comp=0) const
Nodal values of old second time derivative of a coupled variable.
Definition: Coupleable.C:2041
Coupleable::coupledAllDofValuesOld
std::vector< const VariableValue * > coupledAllDofValuesOld(const std::string &var_name) const
Returns DoFs in the old solution vector of all of a coupled variable&#39;s components for the local eleme...
Definition: Coupleable.C:2090
Coupleable::coupledGradients
std::vector< const VariableGradient * > coupledGradients(const std::string &var_name) const
Returns the gradients for all of a coupled variable&#39;s components.
Definition: Coupleable.C:2741
Coupleable::coupledAllDofValuesOlder
std::vector< const VariableValue * > coupledAllDofValuesOlder(const std::string &var_name) const
Returns DoFs in the older solution vector of all of a coupled variable&#39;s components for the local ele...
Definition: Coupleable.C:2110
Coupleable::getFEVariableCoupleableMatrixTags
const std::set< TagID > & getFEVariableCoupleableMatrixTags() const
Definition: Coupleable.h:126
Coupleable::adCoupledVectorDot
const ADVectorVariableValue & adCoupledVectorDot(const std::string &var_name, unsigned int comp=0) const
Time derivative of a vector coupled variable for ad simulations.
Definition: Coupleable.C:2321
Coupleable::getDefaultFunctor
const Moose::Functor< T > & getDefaultFunctor(const std::string &var_name) const
Coupleable::coupledDofValuesOlder
virtual const VariableValue & coupledDofValuesOlder(const std::string &var_name, unsigned int comp=0) const
Returns DoFs in the older solution vector of a coupled variable for the local element.
Definition: Coupleable.C:2097
Coupleable::_vector_curl_zero
const VectorVariableCurl & _vector_curl_zero
Zero value of the curl of a vector variable.
Definition: Coupleable.h:1514
Coupleable::getADDefaultVectorGradient
const ADVectorVariableGradient & getADDefaultVectorGradient() const
Helper method to return (and insert if necessary) the default gradient for Automatic Differentiation ...
Definition: Coupleable.C:2409
Coupleable::adZeroValue
const ADVariableValue & adZeroValue() const
method that returns _zero to RESIDUAL computing objects and _ad_zero to JACOBIAN computing objects ...
Definition: Coupleable.C:2430
Coupleable::coupledIndices
std::vector< unsigned int > coupledIndices(const std::string &var_name) const
Returns the indices for a coupled variable&#39;s components.
Definition: Coupleable.C:2507
Coupleable::coupledNodalValueOlder
const T & coupledNodalValueOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old nodal value from two time steps previous of a coupled variable.
Definition: Coupleable.C:1959
Coupleable::getCoupledMooseVars
const std::vector< MooseVariableFieldBase * > & getCoupledMooseVars() const
Get the list of all coupled variables.
Definition: Coupleable.h:81
Coupleable::coupledGenericDot
const GenericVariableValue< is_ad > & coupledGenericDot(const std::string &var_name, unsigned int comp=0) const
Returns time derivative of a coupled variable for use in templated automatic differentiation classes...
Coupleable::kokkosCoupledNodalDot
Moose::Kokkos::VariableValue kokkosCoupledNodalDot(const std::string &var_name, unsigned int comp=0)
Coupleable::_obj
const MooseObject *const _obj
Definition: Coupleable.h:1814
Coupleable::_default_vector_gradient
VectorVariableGradient _default_vector_gradient
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1523
Coupleable::_coupled_moose_vars
std::vector< MooseVariableFieldBase * > _coupled_moose_vars
Vector of all coupled variables.
Definition: Coupleable.h:1423
Coupleable::coupledCurl
virtual const VectorVariableCurl & coupledCurl(const std::string &var_name, unsigned int comp=0) const
Returns curl of a coupled variable.
Definition: Coupleable.C:1740
VariableValue
OutputTools< Real >::VariableValue VariableValue
Definition: MooseTypes.h:315
Coupleable::getFEVariableCoupleableMatrixTags
std::set< TagID > & getFEVariableCoupleableMatrixTags()
Definition: Coupleable.h:119
Coupleable::coupledArrayGradient
virtual const ArrayVariableGradient & coupledArrayGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled array variable.
Definition: Coupleable.C:1688
Coupleable::coupledDotDu
virtual const VariableValue & coupledDotDu(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled variable with respect to the coefficients.
Definition: Coupleable.C:1468
VariablePhiGradient
OutputTools< Real >::VariablePhiGradient VariablePhiGradient
Definition: MooseTypes.h:321
Coupleable::coupledComponents
unsigned int coupledComponents(const std::string &var_name) const
Number of coupled components.
Definition: Coupleable.C:188
Coupleable::_coupleable_neighbor
bool _coupleable_neighbor
Whether or not this object is a "neighbor" object: ie all of it&#39;s coupled values should be neighbor v...
Definition: Coupleable.h:1713
Coupleable::coupledArrayGradientOlder
virtual const ArrayVariableGradient & coupledArrayGradientOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from two time steps previous of a coupled array variable. ...
Definition: Coupleable.C:1714
Coupleable::coupledVectorDotDotDu
virtual const VariableValue & coupledVectorDotDotDu(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled vector variable with respect to the coefficients.
Definition: Coupleable.C:1364
Coupleable::adCoupledGradients
std::vector< const ADVariableGradient * > adCoupledGradients(const std::string &var_name) const
Returns the gradients for all of a coupled variable&#39;s components for use in Automatic Differentiation...
Definition: Coupleable.C:2763
Coupleable
Interface for objects that needs coupling capabilities.
Definition: Coupleable.h:49
Coupleable::_coupled_fv_moose_vars
std::vector< MooseVariableField< Real > * > _coupled_fv_moose_vars
Vector of all finite volume coupled variables.
Definition: Coupleable.h:1435
Coupleable::kokkosCoupledVectorTagNodalValues
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValues(const std::string &var_name, const std::string &tag_param_name)
Coupleable::kokkosCoupledVectorTagValuesByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValuesByName(const std::string &var_name, const std::string &tag_name)
Coupleable::genericZeroSecond
const GenericVariableSecond< is_ad > & genericZeroSecond()
Returns zero second derivative templated with automatic differentiation boolean.
Coupleable::coupledValues
std::vector< const VariableValue * > coupledValues(const std::string &var_name) const
Returns the values for all of a coupled variable components.
Definition: Coupleable.C:2538
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Coupleable::coupledVectorTagArrayGradients
std::vector< const ArrayVariableGradient * > coupledVectorTagArrayGradients(const std::string &var_names, TagID tag) const
Returns gradients for all the coupled variables desired for a given tag.
Definition: Coupleable.C:2650
Coupleable::getDefaultNodalValue
const T & getDefaultNodalValue(const std::string &var_name, unsigned int comp=0) const
Get nodal default value.
Definition: Coupleable.C:449
Coupleable::_c_type
const std::string & _c_type
The type of the object this interface is part of.
Definition: Coupleable.h:1411
Coupleable::coupledVectorGradientOlder
virtual const VectorVariableGradient & coupledVectorGradientOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from two time steps previous of a coupled vector variable.
Definition: Coupleable.C:1672
Coupleable::_ad_second_zero
const MooseArray< ADRealTensorValue > & _ad_second_zero
Definition: Coupleable.h:1508
Coupleable::_default_vector_value_zero
VectorVariableValue _default_vector_value_zero
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1520
Coupleable::checkVar
bool checkVar(const std::string &var_name, unsigned int comp=0, unsigned int comp_bound=0) const
Check that the right kind of variable is being coupled in.
Definition: Coupleable.C:239
Coupleable::coupledValuePreviousNL
virtual const VariableValue & coupledValuePreviousNL(const std::string &var_name, unsigned int comp=0) const
Returns value of previous Newton iterate of a coupled variable.
Definition: Coupleable.C:1075
Coupleable::_ad_default_vector_gradient
MooseArray< ADRealTensorValue > _ad_default_vector_gradient
This will always be zero because the default values for optionally coupled vector variables is always...
Definition: Coupleable.h:1483
Coupleable::coupledVectorValue
virtual const VectorVariableValue & coupledVectorValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled vector variable.
Definition: Coupleable.C:854
Coupleable::getFEVariableCoupleableVectorTags
const std::set< TagID > & getFEVariableCoupleableVectorTags() const
Definition: Coupleable.h:121
InputParameters::checkForRename
std::string checkForRename(const std::string &name) const
Checks whether the provided name is a renamed parameter name.
Definition: InputParameters.C:1772
Coupleable::coupledDotDotOld
virtual const VariableValue & coupledDotDotOld(const std::string &var_name, unsigned int comp=0) const
Old second time derivative of a coupled variable.
Definition: Coupleable.C:1259
Moose::Kokkos::Variable
The Kokkos variable object that carries the coupled variable and tag information. ...
Definition: KokkosVariable.h:28
Coupleable::_ad_default_second
MooseArray< ADRealTensorValue > _ad_default_second
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1489
Coupleable::kokkosCoupledNodalValueOlder
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOlder(const std::string &var_name, unsigned int comp=0)
Coupleable::coupledArrayDotDu
const VariableValue & coupledArrayDotDu(const std::string &var_name, unsigned int comp=0) const
Time derivative of a coupled array variable with respect to the coefficients.
Definition: Coupleable.C:1518
Coupleable::coupledVectorTagValues
std::vector< const VariableValue * > coupledVectorTagValues(const std::string &var_names, TagID tag) const
Returns the values for all the coupled variables desired for a given tag.
Definition: Coupleable.C:2581
Coupleable::_phi_zero
const VariablePhiValue & _phi_zero
Definition: Coupleable.h:1496
Coupleable::getArrayVar
ArrayMooseVariable * getArrayVar(const std::string &var_name, unsigned int comp)
Extract pointer to a coupled array variable.
Definition: Coupleable.C:336
Coupleable::kokkosCoupledValuesOld
Moose::Kokkos::VariableValue kokkosCoupledValuesOld(const std::string &var_name)
Coupleable::coupledArrayDotDot
virtual const ArrayVariableValue & coupledArrayDotDot(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled array variable.
Definition: Coupleable.C:1402
MooseVariableScalar
Class for scalar variables (they are different).
Definition: MooseVariableScalar.h:29
Coupleable::adCoupledVectorGradient
const ADVectorVariableGradient & adCoupledVectorGradient(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled vector variable for use in Automatic Differentiation.
Definition: Coupleable.C:2355
Coupleable::kokkosCoupledVectorTagGradients
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradients(const std::string &var_name, const std::string &tag_param_name)
Coupleable::_optional_var_index
std::unordered_map< std::string, std::vector< unsigned int > > _optional_var_index
Unique indices for optionally coupled vars that weren&#39;t provided.
Definition: Coupleable.h:1802
Coupleable::kokkosCoupledVectorTagValues
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValues(const std::string &var_name, const std::string &tag_param_name)
Coupleable::getFEVar
const MooseVariableFieldBase * getFEVar(const std::string &var_name, unsigned int comp) const
Deprecated method.
Definition: Coupleable.C:298
Coupleable::_default_value
std::unordered_map< std::string, std::vector< std::unique_ptr< VariableValue > > > _default_value
Will hold the default value for optional coupled variables.
Definition: Coupleable.h:1454
Coupleable::coupledMatrixTagValues
std::vector< const VariableValue * > coupledMatrixTagValues(const std::string &var_names, TagID tag) const
Returns the diagonal matrix values for all the coupled variables desired for a given tag...
Definition: Coupleable.C:2696
GenericVariableSecond
Moose::GenericType< VariableSecond, is_ad > GenericVariableSecond
Definition: MooseTypes.h:669
Coupleable::_c_parameters
const InputParameters & _c_parameters
Definition: Coupleable.h:1406
VariableSecond
OutputTools< Real >::VariableSecond VariableSecond
Definition: MooseTypes.h:317
Coupleable::_ad_zero
const MooseArray< ADReal > & _ad_zero
Definition: Coupleable.h:1497
Coupleable::coupledArrayGradientOld
virtual const ArrayVariableGradient & coupledArrayGradientOld(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from previous time step of a coupled array variable.
Definition: Coupleable.C:1701
Coupleable::adCoupledNodalValue
const Moose::ADType< T >::type & adCoupledNodalValue(const std::string &var_name, unsigned int comp=0) const
Returns AD nodal values of a coupled variable.
Definition: Coupleable.C:2162
Coupleable::kokkosCoupledVectorTagGradientByName
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0)
Coupleable::coupledNodalDotOld
virtual const VariableValue & coupledNodalDotOld(const std::string &var_name, unsigned int comp=0) const
Nodal values of old time derivative of a coupled variable.
Definition: Coupleable.C:2025
Coupleable::genericZeroValue
const GenericVariableValue< is_ad > & genericZeroValue()
Returns zero value templated with automatic differentiation boolean.
Coupleable::_default_array_value
std::unordered_map< std::string, std::unique_ptr< ArrayVariableValue > > _default_array_value
Will hold the default value for optional array coupled variables.
Definition: Coupleable.h:1464
Coupleable::kokkosCoupledDotDu
Moose::Kokkos::Scalar< const Real > kokkosCoupledDotDu(const std::string &var_name, unsigned int comp=0)
Coupleable::kokkosCoupledVectorTagValueByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValueByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0)
VectorVariableGradient
OutputTools< RealVectorValue >::VariableGradient VectorVariableGradient
Definition: MooseTypes.h:333
Coupleable::_default_array_gradient
ArrayVariableGradient _default_array_gradient
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1538
Coupleable::kokkosCoupledVectorTagNodalValue
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValue(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0)
Coupleable::getADDefaultSecond
const ADVariableSecond & getADDefaultSecond() const
Helper method to return (and insert if necessary) the default second derivatives for Automatic Differ...
Definition: Coupleable.C:2416
Moose::Kokkos::VariableValue
The Kokkos wrapper classes for MOOSE-like variable value access.
Definition: KokkosVariableValue.h:120
Coupleable::_older_state_tags
const std::set< std::string > _older_state_tags
vector tag names for which we need to request older solution states from the system ...
Definition: Coupleable.h:1817
Coupleable::coupledCurlOlder
virtual const VectorVariableCurl & coupledCurlOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old curl from two time steps previous of a coupled variable.
Definition: Coupleable.C:1772
Coupleable::kokkosCoupledGradientOld
Moose::Kokkos::VariableGradient kokkosCoupledGradientOld(const std::string &var_name, unsigned int comp=0)
Coupleable::coupledDiv
virtual const VectorVariableDivergence & coupledDiv(const std::string &var_name, unsigned int comp=0) const
Returns divergence of a coupled variable.
Definition: Coupleable.C:1805
Coupleable::coupledGradientPreviousNL
virtual const VariableGradient & coupledGradientPreviousNL(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled variable for previous Newton iterate.
Definition: Coupleable.C:1591
Coupleable::_default_array_value_zero
ArrayVariableValue _default_array_value_zero
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1535
Coupleable::kokkosCoupledVectorTagNodalValueByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValueByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0)
Coupleable::_coupleable_max_qps
unsigned int _coupleable_max_qps
Maximum qps for any element in this system.
Definition: Coupleable.h:1799
ArrayVariableGradient
OutputTools< RealEigenVector >::VariableGradient ArrayVariableGradient
Definition: MooseTypes.h:350
Coupleable::addFEVariableCoupleableMatrixTag
void addFEVariableCoupleableMatrixTag(TagID tag)
Definition: Coupleable.h:115
Coupleable::adCoupledVectorValues
std::vector< const ADVectorVariableValue * > adCoupledVectorValues(const std::string &var_name) const
Returns the values for all of a coupled vector variable&#39;s components for use in Automatic Differentia...
Definition: Coupleable.C:2573
Coupleable::coupledVectorValues
std::vector< const VectorVariableValue * > coupledVectorValues(const std::string &var_name) const
Returns the values for all of a coupled vector variable&#39;s components.
Definition: Coupleable.C:2545
Coupleable::coupledDotDot
virtual const VariableValue & coupledDotDot(const std::string &var_name, unsigned int comp=0) const
Second time derivative of a coupled variable.
Definition: Coupleable.C:1195
Coupleable::kokkosCoupledVectorTagVariable
Moose::Kokkos::Variable kokkosCoupledVectorTagVariable(const std::string &var_name, const std::string &tag_name, unsigned int comp)
Coupleable::coupledArrayGradientDot
virtual const ArrayVariableGradient & coupledArrayGradientDot(const std::string &var_name, unsigned int comp=0) const
Retun a gradient of a coupled array variable&#39;s time derivative.
Definition: Coupleable.C:1727
Coupleable::coupledGenericGradients
std::vector< const GenericVariableGradient< is_ad > * > coupledGenericGradients(const std::string &var_name) const
Returns the gradients for all of a coupled variable&#39;s components for use in templated automatic diffe...
Coupleable::getCoupledVars
const std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > & getCoupledVars() const
Get the list of coupled variables.
Definition: Coupleable.h:72
Coupleable::getFEVariableCoupleableVectorTags
std::set< TagID > & getFEVariableCoupleableVectorTags()
Definition: Coupleable.h:117
Coupleable::coupledVectorDotOld
virtual const VectorVariableValue & coupledVectorDotOld(const std::string &var_name, unsigned int comp=0) const
Old time derivative of a coupled vector variable.
Definition: Coupleable.C:1316
Coupleable::adCoupledGradientDot
const ADVariableGradient & adCoupledGradientDot(const std::string &var_name, unsigned int comp=0) const
Returns gradient of a coupled variable&#39;s time derivative for use in Automatic Differentiation.
Definition: Coupleable.C:2239
Coupleable::adCoupledSecond
const ADVariableSecond & adCoupledSecond(const std::string &var_name, unsigned int comp=0) const
Returns second derivatives of a coupled variable for use in Automatic Differentiation.
Definition: Coupleable.C:2256
Coupleable::hasWritableCoupledVariables
bool hasWritableCoupledVariables() const
Checks whether the object has any writable coupled variables.
Definition: Coupleable.h:139
Coupleable::coupledVectorDotDotOld
virtual const VectorVariableValue & coupledVectorDotDotOld(const std::string &var_name, unsigned int comp=0) const
Old second time derivative of a coupled vector variable.
Definition: Coupleable.C:1332
Coupleable::adCoupledCurl
const ADVectorVariableCurl & adCoupledCurl(const std::string &var_name, unsigned int comp=0) const
Returns curl of a coupled variable for use in objects utilizing Automatic Differentiation.
Definition: Coupleable.C:1788
Coupleable::adCoupledVectorValue
const ADVectorVariableValue & adCoupledVectorValue(const std::string &var_name, unsigned int comp=0) const
Returns value of a coupled vector variable for use in Automatic Differentiation.
Definition: Coupleable.C:2337
Coupleable::coupledNodalValueOld
const T & coupledNodalValueOld(const std::string &var_name, unsigned int comp=0) const
Returns an old nodal value from previous time step of a coupled variable.
Definition: Coupleable.C:1939
Coupleable::_ad_default_gradient
MooseArray< ADRealVectorValue > _ad_default_gradient
This will always be zero because the default values for optionally coupled variables is always consta...
Definition: Coupleable.h:1480
Coupleable::coupledValuesOld
std::vector< const VariableValue * > coupledValuesOld(const std::string &var_name) const
Returns the old values for all of a coupled variable&#39;s components.
Definition: Coupleable.C:2719
Coupleable::coupledGradientOlder
virtual const VariableGradient & coupledGradientOlder(const std::string &var_name, unsigned int comp=0) const
Returns an old gradient from two time steps previous of a coupled variable.
Definition: Coupleable.C:1575
THREAD_ID
unsigned int THREAD_ID
Definition: MooseTypes.h:209
Coupleable::_new_to_deprecated_coupled_vars
const std::unordered_map< std::string, std::string > & _new_to_deprecated_coupled_vars
map from new to deprecated variable names
Definition: Coupleable.h:1438
Coupleable::coupledAllDofValues
std::vector< const VariableValue * > coupledAllDofValues(const std::string &var_name) const
Returns DoFs in the current solution vector of all of a coupled variable&#39;s components for the local e...
Definition: Coupleable.C:2070
Coupleable::getFieldVar
const MooseVariableFieldBase * getFieldVar(const std::string &var_name, unsigned int comp) const
Definition: Coupleable.C:312
Coupleable::coupledDivOld
virtual const VectorVariableDivergence & coupledDivOld(const std::string &var_name, unsigned int comp=0) const
Returns an old divergence from previous time step of a coupled variable.
Definition: Coupleable.C:1821
Generated on Tue Oct 7 2025 20:05:04 for https://mooseframework.inl.gov by   doxygen 1.8.14