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  using Coupleable::coupled; \
31  using Coupleable::isCoupled; \
32  using Coupleable::coupledComponents
33 
34 // Forward declarations
35 class MooseVariableScalar;
36 class MooseObject;
37 
38 namespace libMesh
39 {
40 template <typename T>
41 class DenseVector;
42 }
43 
44 template <typename>
45 class MooseVariableField;
46 typedef MooseVariableField<Real> MooseWritableVariable;
47 
52 class Coupleable
53 {
54 public:
61  Coupleable(const MooseObject * moose_object, bool nodal, bool is_fv = false);
62 
63 #ifdef MOOSE_KOKKOS_ENABLED
64 
67  Coupleable(const Coupleable & object, const Moose::Kokkos::FunctorCopy & key);
68 #endif
69 
74  const std::unordered_map<std::string, std::vector<MooseVariableFieldBase *>> &
75  getCoupledVars() const
76  {
77  return _coupled_vars;
78  }
79 
84  const std::vector<MooseVariableFieldBase *> & getCoupledMooseVars() const
85  {
86  return _coupled_moose_vars;
87  }
88 
93  const std::vector<MooseVariable *> & getCoupledStandardMooseVars() const
94  {
95  return _coupled_standard_moose_vars;
96  }
97 
102  const std::vector<VectorMooseVariable *> & getCoupledVectorMooseVars() const
103  {
104  return _coupled_vector_moose_vars;
105  }
106 
111  const std::vector<ArrayMooseVariable *> & getCoupledArrayMooseVars() const
112  {
113  return _coupled_array_moose_vars;
114  }
115 
116  void addFEVariableCoupleableVectorTag(TagID tag) { _fe_coupleable_vector_tags.insert(tag); }
117 
118  void addFEVariableCoupleableMatrixTag(TagID tag) { _fe_coupleable_matrix_tags.insert(tag); }
119 
120  std::set<TagID> & getFEVariableCoupleableVectorTags() { return _fe_coupleable_vector_tags; }
121 
122  std::set<TagID> & getFEVariableCoupleableMatrixTags() { return _fe_coupleable_matrix_tags; }
123 
124  const std::set<TagID> & getFEVariableCoupleableVectorTags() const
125  {
126  return _fe_coupleable_vector_tags;
127  }
128 
129  const std::set<TagID> & getFEVariableCoupleableMatrixTags() const
130  {
131  return _fe_coupleable_matrix_tags;
132  }
133 
137  auto & getWritableCoupledVariables() const { return _writable_coupled_variables[_c_tid]; }
138 
142  bool hasWritableCoupledVariables() const { return !getWritableCoupledVariables().empty(); }
143 
144 protected:
149  virtual void coupledCallback(const std::string & /*var_name*/, bool /*is_old*/) const {}
150 
157  virtual bool isCoupled(const std::string & var_name, unsigned int i = 0) const;
158 
164  virtual bool isCoupledConstant(const std::string & var_name) const;
165 
171  unsigned int coupledComponents(const std::string & var_name) const;
172 
179  VariableName coupledName(const std::string & var_name, unsigned int comp = 0) const;
180 
186  std::vector<VariableName> coupledNames(const std::string & var_name) const;
187 
195  virtual unsigned int coupled(const std::string & var_name, unsigned int comp = 0) const;
196 
202  std::vector<unsigned int> coupledIndices(const std::string & var_name) const;
203 
211  virtual const VariableValue & coupledValue(const std::string & var_name,
212  unsigned int comp = 0) const;
213 
219  std::vector<const VariableValue *> coupledValues(const std::string & var_name) const;
220 
226  std::vector<const VectorVariableValue *> coupledVectorValues(const std::string & var_name) const;
227 
234  template <bool is_ad>
235  const GenericVariableValue<is_ad> & coupledGenericValue(const std::string & var_name,
236  unsigned int comp = 0) const;
237 
245  template <bool is_ad>
246  const GenericVectorVariableValue<is_ad> & coupledGenericVectorValue(const std::string & var_name,
247  unsigned int comp = 0) const;
248 
255  template <bool is_ad>
256  std::vector<const GenericVariableValue<is_ad> *>
257  coupledGenericValues(const std::string & var_name) const;
258 
265  template <bool is_ad>
266  const GenericVariableValue<is_ad> & coupledGenericDofValue(const std::string & var_name,
267  unsigned int comp = 0) const;
268 
276  template <bool is_ad>
277  const GenericVariableValue<is_ad> & coupledGenericDot(const std::string & var_name,
278  unsigned int comp = 0) const;
279 
287  template <bool is_ad>
288  const GenericVariableValue<is_ad> & coupledGenericDotDot(const std::string & var_name,
289  unsigned int comp = 0) const;
290 
297  virtual const VariableValue & coupledValueLower(const std::string & var_name,
298  unsigned int comp = 0) const;
299 
306  const ADVariableValue & adCoupledValue(const std::string & var_name, unsigned int comp = 0) const;
307 
314  std::vector<const ADVariableValue *> adCoupledValues(const std::string & var_name) const;
315 
322  const ADVariableValue & adCoupledLowerValue(const std::string & var_name,
323  unsigned int comp = 0) const;
324 
332  const ADVectorVariableValue & adCoupledVectorValue(const std::string & var_name,
333  unsigned int comp = 0) const;
334 
341  std::vector<const ADVectorVariableValue *>
342  adCoupledVectorValues(const std::string & var_name) const;
343 
352  virtual const VariableValue &
353  coupledVectorTagValue(const std::string & var_names, TagID tag, unsigned int index = 0) const;
354 
355  virtual const VariableValue & coupledVectorTagValue(const std::string & var_names,
356  const std::string & tag_name,
357  unsigned int index = 0) const;
358 
365  std::vector<const VariableValue *> coupledVectorTagValues(const std::string & var_names,
366  TagID tag) const;
367 
368  std::vector<const VariableValue *> coupledVectorTagValues(const std::string & var_names,
369  const std::string & tag_name) const;
370 
379  virtual const ArrayVariableValue & coupledVectorTagArrayValue(const std::string & var_names,
380  TagID tag,
381  unsigned int index = 0) const;
382 
383  virtual const ArrayVariableValue & coupledVectorTagArrayValue(const std::string & var_names,
384  const std::string & tag_name,
385  unsigned int index = 0) const;
386 
393  std::vector<const ArrayVariableValue *> coupledVectorTagArrayValues(const std::string & var_names,
394  TagID tag) const;
395 
396  std::vector<const ArrayVariableValue *>
397  coupledVectorTagArrayValues(const std::string & var_names, const std::string & tag_name) const;
398 
407  virtual const VariableGradient &
408  coupledVectorTagGradient(const std::string & var_names, TagID tag, unsigned int index = 0) const;
409 
410  virtual const VariableGradient & coupledVectorTagGradient(const std::string & var_names,
411  const std::string & tag_name,
412  unsigned int index = 0) const;
413 
420  std::vector<const VariableGradient *> coupledVectorTagGradients(const std::string & var_names,
421  TagID tag) const;
422 
423  std::vector<const VariableGradient *>
424  coupledVectorTagGradients(const std::string & var_names, const std::string & tag_name) const;
425 
435  virtual const ArrayVariableGradient & coupledVectorTagArrayGradient(const std::string & var_names,
436  TagID tag,
437  unsigned int index = 0) const;
438 
439  virtual const ArrayVariableGradient & coupledVectorTagArrayGradient(const std::string & var_names,
440  const std::string & tag_name,
441  unsigned int index = 0) const;
442 
449  std::vector<const ArrayVariableGradient *>
450  coupledVectorTagArrayGradients(const std::string & var_names, TagID tag) const;
451 
452  std::vector<const ArrayVariableGradient *>
453  coupledVectorTagArrayGradients(const std::string & var_names, const std::string & tag_name) const;
454 
462  virtual const VariableValue &
463  coupledVectorTagDofValue(const std::string & var_name, TagID tag, unsigned int index = 0) const;
464 
465  virtual const VariableValue & coupledVectorTagDofValue(const std::string & var_names,
466  const std::string & tag_name,
467  unsigned int index = 0) const;
468 
475  const ArrayVariableValue & coupledVectorTagArrayDofValue(const std::string & var_name,
476  const std::string & tag_name,
477  unsigned int comp = 0) const;
478 
485  std::vector<const VariableValue *> coupledVectorTagDofValues(const std::string & var_names,
486  TagID tag) const;
487 
488  std::vector<const VariableValue *> coupledVectorTagDofValues(const std::string & var_names,
489  const std::string & tag_name) const;
490 
499  virtual const VariableValue &
500  coupledMatrixTagValue(const std::string & var_names, TagID tag, unsigned int index = 0) const;
501 
502  virtual const VariableValue & coupledMatrixTagValue(const std::string & var_names,
503  const std::string & tag_name,
504  unsigned int index = 0) const;
505 
512  std::vector<const VariableValue *> coupledMatrixTagValues(const std::string & var_names,
513  TagID tag) const;
514 
515  std::vector<const VariableValue *> coupledMatrixTagValues(const std::string & var_names,
516  const std::string & tag_name) const;
517 
525  virtual const VectorVariableValue & coupledVectorValue(const std::string & var_name,
526  unsigned int comp = 0) const;
527 
535  virtual const ArrayVariableValue & coupledArrayValue(const std::string & var_name,
536  unsigned int comp = 0) const;
537 
543  std::vector<const ArrayVariableValue *> coupledArrayValues(const std::string & var_name) const;
544 
557  MooseWritableVariable & writableVariable(const std::string & var_name, unsigned int comp = 0);
558 
568  virtual VariableValue & writableCoupledValue(const std::string & var_name, unsigned int comp = 0);
569 
573  void checkWritableVar(MooseWritableVariable * var);
574 
582  virtual const VariableValue & coupledValueOld(const std::string & var_name,
583  unsigned int comp = 0) const;
584 
590  std::vector<const VariableValue *> coupledValuesOld(const std::string & var_name) const;
591 
597  std::vector<const VectorVariableValue *>
598  coupledVectorValuesOld(const std::string & var_name) const;
599 
607  virtual const VariableValue & coupledValueOlder(const std::string & var_name,
608  unsigned int comp = 0) const;
609 
615  std::vector<const VariableValue *> coupledValuesOlder(const std::string & var_name) const;
616 
623  virtual const VariableValue & coupledValuePreviousNL(const std::string & var_name,
624  unsigned int comp = 0) const;
625 
633  virtual const VectorVariableValue & coupledVectorValueOld(const std::string & var_name,
634  unsigned int comp = 0) const;
635 
643  virtual const VectorVariableValue & coupledVectorValueOlder(const std::string & var_name,
644  unsigned int comp = 0) const;
645 
653  virtual const ArrayVariableValue & coupledArrayValueOld(const std::string & var_name,
654  unsigned int comp = 0) const;
655 
663  virtual const ArrayVariableValue & coupledArrayValueOlder(const std::string & var_name,
664  unsigned int comp = 0) const;
665 
673  virtual const VariableGradient & coupledGradient(const std::string & var_name,
674  unsigned int comp = 0) const;
675 
681  std::vector<const VariableGradient *> coupledGradients(const std::string & var_name) const;
682 
690  const ADVariableGradient & adCoupledGradient(const std::string & var_name,
691  unsigned int comp = 0) const;
692 
700  const ADVariableGradient & adCoupledGradientDot(const std::string & var_name,
701  unsigned int comp = 0) const;
702 
709  std::vector<const ADVariableGradient *> adCoupledGradients(const std::string & var_name) const;
710 
718  template <bool is_ad>
719  const GenericVariableGradient<is_ad> & coupledGenericGradient(const std::string & var_name,
720  unsigned int comp = 0) const;
721 
728  template <bool is_ad>
729  std::vector<const GenericVariableGradient<is_ad> *>
730  coupledGenericGradients(const std::string & var_name) const;
731 
739  const ADVectorVariableGradient & adCoupledVectorGradient(const std::string & var_name,
740  unsigned int comp = 0) const;
741 
748  const ADVariableSecond & adCoupledSecond(const std::string & var_name,
749  unsigned int comp = 0) const;
750 
758  const ADVectorVariableSecond & adCoupledVectorSecond(const std::string & var_name,
759  unsigned int comp = 0) const;
760 
768  virtual const VariableGradient & coupledGradientOld(const std::string & var_name,
769  unsigned int comp = 0) const;
770 
776  std::vector<const VariableGradient *> coupledGradientsOld(const std::string & var_name) const;
777 
785  virtual const VariableGradient & coupledGradientOlder(const std::string & var_name,
786  unsigned int comp = 0) const;
787 
794  virtual const VariableGradient & coupledGradientPreviousNL(const std::string & var_name,
795  unsigned int comp = 0) const;
796 
804  virtual const VariableGradient & coupledGradientDot(const std::string & var_name,
805  unsigned int comp = 0) const;
806 
814  virtual const VariableGradient & coupledGradientDotDot(const std::string & var_name,
815  unsigned int comp = 0) const;
816 
824  virtual const VectorVariableGradient & coupledVectorGradient(const std::string & var_name,
825  unsigned int comp = 0) const;
826 
834  virtual const VectorVariableGradient & coupledVectorGradientOld(const std::string & var_name,
835  unsigned int comp = 0) const;
836 
844  virtual const VectorVariableGradient & coupledVectorGradientOlder(const std::string & var_name,
845  unsigned int comp = 0) const;
846 
854  virtual const ArrayVariableGradient & coupledArrayGradient(const std::string & var_name,
855  unsigned int comp = 0) const;
856 
864  virtual const ArrayVariableGradient & coupledArrayGradientOld(const std::string & var_name,
865  unsigned int comp = 0) const;
866 
874  virtual const ArrayVariableGradient & coupledArrayGradientOlder(const std::string & var_name,
875  unsigned int comp = 0) const;
876 
884  virtual const ArrayVariableGradient & coupledArrayGradientDot(const std::string & var_name,
885  unsigned int comp = 0) const;
886 
894  virtual const VectorVariableCurl & coupledCurl(const std::string & var_name,
895  unsigned int comp = 0) const;
896 
904  virtual const VectorVariableCurl & coupledCurlOld(const std::string & var_name,
905  unsigned int comp = 0) const;
906 
914  virtual const VectorVariableCurl & coupledCurlOlder(const std::string & var_name,
915  unsigned int comp = 0) const;
916 
924  const ADVectorVariableCurl & adCoupledCurl(const std::string & var_name,
925  unsigned int comp = 0) const;
926 
935  virtual const VectorVariableDivergence & coupledDiv(const std::string & var_name,
936  unsigned int comp = 0) const;
937 
946  virtual const VectorVariableDivergence & coupledDivOld(const std::string & var_name,
947  unsigned int comp = 0) const;
948 
957  virtual const VectorVariableDivergence & coupledDivOlder(const std::string & var_name,
958  unsigned int comp = 0) const;
959 
967  virtual const VariableSecond & coupledSecond(const std::string & var_name,
968  unsigned int comp = 0) const;
969 
978  virtual const VariableSecond & coupledSecondOld(const std::string & var_name,
979  unsigned int comp = 0) const;
980 
989  virtual const VariableSecond & coupledSecondOlder(const std::string & var_name,
990  unsigned int comp = 0) const;
991 
998  virtual const VariableSecond & coupledSecondPreviousNL(const std::string & var_name,
999  unsigned int comp = 0) const;
1000 
1007  virtual const VariableValue & coupledDot(const std::string & var_name,
1008  unsigned int comp = 0) const;
1009 
1015  std::vector<const VariableValue *> coupledDots(const std::string & var_name) const;
1016 
1024  virtual const VariableValue & coupledDotDot(const std::string & var_name,
1025  unsigned int comp = 0) const;
1026 
1033  virtual const VariableValue & coupledDotOld(const std::string & var_name,
1034  unsigned int comp = 0) const;
1035 
1043  virtual const VariableValue & coupledDotDotOld(const std::string & var_name,
1044  unsigned int comp = 0) const;
1045 
1053  const ADVariableValue & adCoupledDot(const std::string & var_name, unsigned int comp = 0) const;
1054 
1060  std::vector<const ADVariableValue *> adCoupledDots(const std::string & var_name) const;
1061 
1069  const ADVariableValue & adCoupledDotDot(const std::string & var_name,
1070  unsigned int comp = 0) const;
1071 
1080  const ADVectorVariableValue & adCoupledVectorDot(const std::string & var_name,
1081  unsigned int comp = 0) const;
1082 
1090  virtual const VectorVariableValue & coupledVectorDot(const std::string & var_name,
1091  unsigned int comp = 0) const;
1092 
1100  virtual const VectorVariableValue & coupledVectorDotDot(const std::string & var_name,
1101  unsigned int comp = 0) const;
1102 
1110  virtual const VectorVariableValue & coupledVectorDotOld(const std::string & var_name,
1111  unsigned int comp = 0) const;
1112 
1120  virtual const VectorVariableValue & coupledVectorDotDotOld(const std::string & var_name,
1121  unsigned int comp = 0) const;
1122 
1130  virtual const VariableValue & coupledVectorDotDu(const std::string & var_name,
1131  unsigned int comp = 0) const;
1132 
1140  virtual const VariableValue & coupledVectorDotDotDu(const std::string & var_name,
1141  unsigned int comp = 0) const;
1142 
1150  virtual const ArrayVariableValue & coupledArrayDot(const std::string & var_name,
1151  unsigned int comp = 0) const;
1152 
1160  virtual const ArrayVariableValue & coupledArrayDotDot(const std::string & var_name,
1161  unsigned int comp = 0) const;
1162 
1170  virtual const ArrayVariableValue & coupledArrayDotOld(const std::string & var_name,
1171  unsigned int comp = 0) const;
1172 
1180  virtual const ArrayVariableValue & coupledArrayDotDotOld(const std::string & var_name,
1181  unsigned int comp = 0) const;
1182 
1190  virtual const VariableValue & coupledDotDu(const std::string & var_name,
1191  unsigned int comp = 0) const;
1192 
1200  virtual const VariableValue & coupledDotDotDu(const std::string & var_name,
1201  unsigned int comp = 0) const;
1202 
1210  const VariableValue & coupledArrayDotDu(const std::string & var_name,
1211  unsigned int comp = 0) const;
1212 
1219  template <typename T>
1220  const T & coupledNodalValue(const std::string & var_name, unsigned int comp = 0) const;
1221 
1228  template <typename T>
1229  const typename Moose::ADType<T>::type & adCoupledNodalValue(const std::string & var_name,
1230  unsigned int comp = 0) const;
1231 
1238  template <typename T>
1239  const T & coupledNodalValueOld(const std::string & var_name, unsigned int comp = 0) const;
1240 
1247  template <typename T>
1248  const T & coupledNodalValueOlder(const std::string & var_name, unsigned int comp = 0) const;
1249 
1256  template <typename T>
1257  const T & coupledNodalValuePreviousNL(const std::string & var_name, unsigned int comp = 0) const;
1258 
1266  template <typename T>
1267  const T & coupledNodalDot(const std::string & var_name, unsigned int comp = 0) const;
1268 
1276  virtual const VariableValue & coupledNodalDotDot(const std::string & var_name,
1277  unsigned int comp = 0) const;
1278 
1286  virtual const VariableValue & coupledNodalDotOld(const std::string & var_name,
1287  unsigned int comp = 0) const;
1288 
1296  virtual const VariableValue & coupledNodalDotDotOld(const std::string & var_name,
1297  unsigned int comp = 0) const;
1298  // coupled-dof-values-begin
1305  virtual const VariableValue & coupledDofValues(const std::string & var_name,
1306  unsigned int comp = 0) const;
1307 
1314  std::vector<const VariableValue *> coupledAllDofValues(const std::string & var_name) const;
1315 
1322  virtual const VariableValue & coupledDofValuesOld(const std::string & var_name,
1323  unsigned int comp = 0) const;
1324 
1331  std::vector<const VariableValue *> coupledAllDofValuesOld(const std::string & var_name) const;
1332 
1339  virtual const VariableValue & coupledDofValuesOlder(const std::string & var_name,
1340  unsigned int comp = 0) const;
1341 
1348  std::vector<const VariableValue *> coupledAllDofValuesOlder(const std::string & var_name) const;
1349 
1356  virtual const ArrayVariableValue & coupledArrayDofValues(const std::string & var_name,
1357  unsigned int comp = 0) const;
1358  // coupled-dof-values-end
1359 
1366  virtual const ADVariableValue & adCoupledDofValues(const std::string & var_name,
1367  unsigned int comp = 0) const;
1368 
1373  const ADVariableValue & adZeroValue() const;
1374 
1379  const ADVariableGradient & adZeroGradient() const;
1380 
1384  const ADVariableSecond & adZeroSecond() const;
1385 
1390  template <bool is_ad>
1391  const GenericVariableValue<is_ad> & genericZeroValue();
1392 
1397  template <bool is_ad>
1398  const GenericVariableGradient<is_ad> & genericZeroGradient();
1399 
1404  template <bool is_ad>
1405  const GenericVariableSecond<is_ad> & genericZeroSecond();
1406 
1407 protected:
1408  // Reference to the interface's input parameters
1409  const InputParameters & _c_parameters;
1410 
1412  const std::string & _c_name;
1414  const std::string & _c_type;
1415 
1416  // Reference to FEProblemBase
1417  FEProblemBase & _c_fe_problem;
1418 
1420  const SystemBase * const _c_sys;
1421 
1423  std::unordered_map<std::string, std::vector<MooseVariableFieldBase *>> _coupled_vars;
1424 
1426  std::vector<MooseVariableFieldBase *> _coupled_moose_vars;
1427 
1429  std::vector<MooseVariable *> _coupled_standard_moose_vars;
1430 
1432  std::vector<VectorMooseVariable *> _coupled_vector_moose_vars;
1433 
1435  std::vector<ArrayMooseVariable *> _coupled_array_moose_vars;
1436 
1438  std::vector<MooseVariableField<Real> *> _coupled_fv_moose_vars;
1439 
1441  const std::unordered_map<std::string, std::string> & _new_to_deprecated_coupled_vars;
1442 
1444  bool _c_nodal;
1445 
1447  bool _c_is_implicit;
1448 
1449  // Argument to allow element-to-nodal coupling
1450  const bool _c_allow_element_to_nodal_coupling;
1451 
1453  THREAD_ID _c_tid;
1454 
1456  mutable std::unordered_map<std::string, std::vector<std::unique_ptr<VariableValue>>>
1457  _default_value;
1458 
1460  mutable std::unordered_map<std::string, std::unique_ptr<MooseArray<ADReal>>> _ad_default_value;
1461 
1463  mutable std::unordered_map<std::string, std::unique_ptr<VectorVariableValue>>
1464  _default_vector_value;
1465 
1467  mutable std::unordered_map<std::string, std::unique_ptr<ArrayVariableValue>> _default_array_value;
1468 
1470  mutable std::unordered_map<std::string, std::unique_ptr<MooseArray<ADRealVectorValue>>>
1471  _ad_default_vector_value;
1472 
1477  mutable VariableValue _default_value_zero;
1478 
1480  mutable VariableGradient _default_gradient;
1481 
1483  mutable MooseArray<ADRealVectorValue> _ad_default_gradient;
1484 
1486  mutable MooseArray<ADRealTensorValue> _ad_default_vector_gradient;
1487 
1489  mutable VariableSecond _default_second;
1490 
1492  mutable MooseArray<ADRealTensorValue> _ad_default_second;
1493 
1495  mutable MooseArray<ADRealVectorValue> _ad_default_curl;
1496 
1498  const VariableValue & _zero;
1499  const VariablePhiValue & _phi_zero;
1500  const MooseArray<ADReal> & _ad_zero;
1501 
1503  const VariableGradient & _grad_zero;
1504  const MooseArray<ADRealVectorValue> & _ad_grad_zero;
1505 
1507  const VariablePhiGradient & _grad_phi_zero;
1508 
1510  const VariableSecond & _second_zero;
1511  const MooseArray<ADRealTensorValue> & _ad_second_zero;
1513  const VariablePhiSecond & _second_phi_zero;
1515  const VectorVariableValue & _vector_zero;
1517  const VectorVariableCurl & _vector_curl_zero;
1518 
1523  mutable VectorVariableValue _default_vector_value_zero;
1524 
1526  mutable VectorVariableGradient _default_vector_gradient;
1527 
1529  mutable VectorVariableCurl _default_vector_curl;
1530 
1532  mutable VectorVariableDivergence _default_div;
1533 
1538  ArrayVariableValue _default_array_value_zero;
1539 
1541  ArrayVariableGradient _default_array_gradient;
1542 
1548  bool
1549  checkVar(const std::string & var_name, unsigned int comp = 0, unsigned int comp_bound = 0) const;
1550 
1551 private:
1555  template <typename T>
1556  const typename OutputTools<T>::VariableValue &
1557  vectorTagValueHelper(const std::string & var_names, TagID tag, unsigned int index = 0) const;
1558 
1562  template <typename T>
1563  const typename OutputTools<T>::VariableValue & vectorTagValueHelper(const std::string & var_names,
1564  const std::string & tag_name,
1565  unsigned int index = 0) const;
1566 
1570  template <typename T>
1571  const typename OutputTools<T>::VariableValue &
1572  vectorTagDofValueHelper(const std::string & var_name, TagID tag, unsigned int comp = 0) const;
1573 
1577  template <typename T>
1578  const typename OutputTools<T>::VariableValue & vectorTagDofValueHelper(
1579  const std::string & var_name, const std::string & tag_name, unsigned int comp = 0) const;
1580 
1586  template <typename T>
1587  void
1588  requestStates(const std::string & var_name, const TagName & tag_name, const unsigned int comp);
1589 
1590  enum class FuncAge
1591  {
1592  Curr,
1593  Old,
1594  Older,
1595  };
1596 
1597  enum class VarType
1598  {
1599  Ignore,
1600  Gradient,
1601  Second,
1602  GradientDot,
1603  Dot,
1604  };
1605 
1606  void checkFuncType(const std::string var_name, VarType t, FuncAge age) const;
1607 
1608 protected:
1617  const MooseVariableFieldBase * getFEVar(const std::string & var_name, unsigned int comp) const;
1618 
1619  /*
1620  * Extract pointer to a base coupled field variable. Could be either a finite volume or finite
1621  * element variable
1622  * @param var_name Name of parameter desired
1623  * @param comp Component number of multiple coupled variables
1624  * @return Pointer to the desired variable
1625  */
1626  const MooseVariableFieldBase * getFieldVar(const std::string & var_name, unsigned int comp) const;
1627 
1628  /*
1629  * Extract pointer to a base coupled field variable. Could be either a finite volume or finite
1630  * element variable
1631  * @param var_name Name of variable desired
1632  * @param comp Component number of multiple coupled variables
1633  * @return Pointer to the desired variable
1634  */
1635  MooseVariableFieldBase * getFieldVar(const std::string & var_name, unsigned int comp);
1636 
1640  template <typename T>
1641  const T * getVarHelper(const std::string & var_name, unsigned int comp) const;
1642 
1646  template <typename T>
1647  T * getVarHelper(const std::string & var_name, unsigned int comp);
1648 
1655  MooseVariable * getVar(const std::string & var_name, unsigned int comp);
1656 
1663  VectorMooseVariable * getVectorVar(const std::string & var_name, unsigned int comp);
1664 
1671  ArrayMooseVariable * getArrayVar(const std::string & var_name, unsigned int comp);
1672 
1679  const MooseVariable * getVar(const std::string & var_name, unsigned int comp) const;
1680 
1687  const VectorMooseVariable * getVectorVar(const std::string & var_name, unsigned int comp) const;
1688 
1695  const ArrayMooseVariable * getArrayVar(const std::string & var_name, unsigned int comp) const;
1696 
1703  void validateExecutionerType(const std::string & name, const std::string & fn_name) const;
1704 
1705  template <typename T, typename Func>
1706  std::vector<T> coupledVectorHelper(const std::string & var_name, const Func & func) const
1707  {
1708  const auto components = coupledComponents(var_name);
1709  std::vector<T> vals(components);
1710  for (MooseIndex(components) comp = 0; comp < components; ++comp)
1711  vals[comp] = func(comp);
1712  return vals;
1713  }
1714 
1716  bool _coupleable_neighbor;
1717 
1718 public:
1725  const ADVariableValue * getADDefaultValue(const std::string & var_name) const;
1726 
1733  const ADVectorVariableValue * getADDefaultVectorValue(const std::string & var_name) const;
1734 
1741  const ADVariableGradient & getADDefaultGradient() const;
1742 
1749  const ADVectorVariableGradient & getADDefaultVectorGradient() const;
1750 
1757  const ADVariableSecond & getADDefaultSecond() const;
1758 
1765  const ADVectorVariableCurl & getADDefaultCurl() const;
1766 
1767 private:
1774  const VariableValue * getDefaultValue(const std::string & var_name, unsigned int comp) const;
1775 
1782  const VectorVariableValue * getDefaultVectorValue(const std::string & var_name) const;
1783 
1790  const ArrayVariableValue * getDefaultArrayValue(const std::string & var_name) const;
1791 
1795  template <typename T>
1796  const T & getDefaultNodalValue(const std::string & var_name, unsigned int comp = 0) const;
1797 
1798  template <typename T>
1799  const Moose::Functor<T> & getDefaultFunctor(const std::string & var_name) const;
1800 
1802  unsigned int _coupleable_max_qps;
1803 
1805  std::unordered_map<std::string, std::vector<unsigned int>> _optional_var_index;
1806 
1808  std::unordered_map<std::string, std::vector<MooseVariableScalar *>> _c_coupled_scalar_vars;
1809 
1810  std::set<TagID> _fe_coupleable_vector_tags;
1811 
1812  std::set<TagID> _fe_coupleable_matrix_tags;
1813 
1815  const bool _is_fv;
1816 
1817  const MooseObject * const _obj;
1818 
1820  const std::set<std::string> _older_state_tags = {Moose::OLD_SOLUTION_TAG,
1821  Moose::OLDER_SOLUTION_TAG};
1822 
1824  std::vector<std::set<MooseWritableVariable *>> _writable_coupled_variables;
1825 
1829 private:
1830  const Real _kokkos_default_value_zero = 0;
1831 
1832 #ifdef MOOSE_KOKKOS_SCOPE
1833  Moose::Kokkos::Variable kokkosCoupledVectorTagVariable(const std::string & var_name,
1834  const std::string & tag_name,
1835  unsigned int comp) const;
1836  Moose::Kokkos::Variable kokkosCoupledVectorTagVariables(const std::string & var_name,
1837  const std::string & tag_name) const;
1838  Moose::Kokkos::Variable kokkosZeroVariable() const;
1839 
1840 public:
1841  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValueByName(const std::string & var_name,
1842  const std::string & tag_name,
1843  unsigned int comp = 0) const;
1844  Moose::Kokkos::VariableValue
1845  kokkosCoupledVectorTagValuesByName(const std::string & var_name,
1846  const std::string & tag_name) const;
1847  Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientByName(const std::string & var_name,
1848  const std::string & tag_name,
1849  unsigned int comp = 0) const;
1850  Moose::Kokkos::VariableGradient
1851  kokkosCoupledVectorTagGradientsByName(const std::string & var_name,
1852  const std::string & tag_name) const;
1853  Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValueByName(const std::string & var_name,
1854  const std::string & tag_name,
1855  unsigned int comp = 0) const;
1856  Moose::Kokkos::VariableValue
1857  kokkosCoupledVectorTagNodalValuesByName(const std::string & var_name,
1858  const std::string & tag_name) const;
1859  Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValueByName(const std::string & var_name,
1860  const std::string & tag_name,
1861  unsigned int comp = 0) const;
1862  Moose::Kokkos::VariableValue
1863  kokkosCoupledVectorTagDofValuesByName(const std::string & var_name,
1864  const std::string & tag_name) const;
1865 
1866  Moose::Kokkos::VariableValue kokkosCoupledVectorTagValue(const std::string & var_name,
1867  const std::string & tag_param_name,
1868  unsigned int comp = 0) const;
1869  Moose::Kokkos::VariableValue
1870  kokkosCoupledVectorTagValues(const std::string & var_name,
1871  const std::string & tag_param_name) const;
1872  Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradient(const std::string & var_name,
1873  const std::string & tag_param_name,
1874  unsigned int comp = 0) const;
1875  Moose::Kokkos::VariableGradient
1876  kokkosCoupledVectorTagGradients(const std::string & var_name,
1877  const std::string & tag_param_name) const;
1878  Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValue(const std::string & var_name,
1879  const std::string & tag_param_name,
1880  unsigned int comp = 0) const;
1881  Moose::Kokkos::VariableValue
1882  kokkosCoupledVectorTagNodalValues(const std::string & var_name,
1883  const std::string & tag_param_name) const;
1884  Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValue(const std::string & var_name,
1885  const std::string & tag_param_name,
1886  unsigned int comp = 0) const;
1887  Moose::Kokkos::VariableValue
1888  kokkosCoupledVectorTagDofValues(const std::string & var_name,
1889  const std::string & tag_param_name) const;
1890 
1891  Moose::Kokkos::VariableValue kokkosCoupledValue(const std::string & var_name,
1892  unsigned int comp = 0) const;
1893  Moose::Kokkos::VariableValue kokkosCoupledValues(const std::string & var_name) const;
1894  Moose::Kokkos::VariableGradient kokkosCoupledGradient(const std::string & var_name,
1895  unsigned int comp = 0) const;
1896  Moose::Kokkos::VariableGradient kokkosCoupledGradients(const std::string & var_name) const;
1897  Moose::Kokkos::VariableValue kokkosCoupledNodalValue(const std::string & var_name,
1898  unsigned int comp = 0) const;
1899  Moose::Kokkos::VariableValue kokkosCoupledNodalValues(const std::string & var_name) const;
1900  Moose::Kokkos::VariableValue kokkosCoupledDofValue(const std::string & var_name,
1901  unsigned int comp = 0) const;
1902  Moose::Kokkos::VariableValue kokkosCoupledDofValues(const std::string & var_name) const;
1903 
1904  Moose::Kokkos::VariableValue kokkosCoupledValueOld(const std::string & var_name,
1905  unsigned int comp = 0) const;
1906  Moose::Kokkos::VariableValue kokkosCoupledValuesOld(const std::string & var_name) const;
1907  Moose::Kokkos::VariableGradient kokkosCoupledGradientOld(const std::string & var_name,
1908  unsigned int comp = 0) const;
1909  Moose::Kokkos::VariableGradient kokkosCoupledGradientsOld(const std::string & var_name) const;
1910  Moose::Kokkos::VariableValue kokkosCoupledNodalValueOld(const std::string & var_name,
1911  unsigned int comp = 0) const;
1912  Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOld(const std::string & var_name) const;
1913  Moose::Kokkos::VariableValue kokkosCoupledDofValueOld(const std::string & var_name,
1914  unsigned int comp = 0) const;
1915  Moose::Kokkos::VariableValue kokkosCoupledDofValuesOld(const std::string & var_name) const;
1916 
1917  Moose::Kokkos::VariableValue kokkosCoupledValueOlder(const std::string & var_name,
1918  unsigned int comp = 0) const;
1919  Moose::Kokkos::VariableValue kokkosCoupledValuesOlder(const std::string & var_name) const;
1920  Moose::Kokkos::VariableGradient kokkosCoupledGradientOlder(const std::string & var_name,
1921  unsigned int comp = 0) const;
1922  Moose::Kokkos::VariableGradient kokkosCoupledGradientsOlder(const std::string & var_name) const;
1923  Moose::Kokkos::VariableValue kokkosCoupledNodalValueOlder(const std::string & var_name,
1924  unsigned int comp = 0) const;
1925  Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOlder(const std::string & var_name) const;
1926  Moose::Kokkos::VariableValue kokkosCoupledDofValueOlder(const std::string & var_name,
1927  unsigned int comp = 0) const;
1928  Moose::Kokkos::VariableValue kokkosCoupledDofValuesOlder(const std::string & var_name) const;
1929 
1930  Moose::Kokkos::VariableValue kokkosCoupledDot(const std::string & var_name,
1931  unsigned int comp = 0) const;
1932  Moose::Kokkos::VariableValue kokkosCoupledDots(const std::string & var_name) const;
1933  Moose::Kokkos::VariableValue kokkosCoupledNodalDot(const std::string & var_name,
1934  unsigned int comp = 0) const;
1935  Moose::Kokkos::VariableValue kokkosCoupledNodalDots(const std::string & var_name) const;
1936 
1937  Moose::Kokkos::Scalar<const Real> kokkosCoupledDotDu(const std::string & var_name,
1938  unsigned int comp = 0) const;
1939 
1940  Moose::Kokkos::VariableValue kokkosZeroValue() const;
1941  Moose::Kokkos::VariableGradient kokkosZeroGradient() const;
1942  Moose::Kokkos::VariableValue kokkosZeroNodalValue() const;
1943 #endif
1944 };
1945 
1946 template <typename T>
1947 T *
1948 Coupleable::getVarHelper(const std::string & var_name_in, unsigned int comp)
1949 {
1950  const auto var_name = _c_parameters.checkForRename(var_name_in);
1951  auto name_to_use = var_name;
1952 
1953  // First check for supplied name
1954  if (!checkVar(var_name, comp, 0))
1955  {
1956  // See if there is an associated deprecated name that the user may have used instead
1957  auto it = _new_to_deprecated_coupled_vars.find(var_name);
1958  if (it == _new_to_deprecated_coupled_vars.end())
1959  return nullptr;
1960  else
1961  {
1962  auto deprecated_name = it->second;
1963  if (checkVar(deprecated_name, comp, 0))
1964  name_to_use = deprecated_name;
1965  else
1966  return nullptr;
1967  }
1968  }
1969 
1970  auto coupled_vars_it = _coupled_vars.find(name_to_use);
1971 
1972  mooseAssert(coupled_vars_it != _coupled_vars.end(),
1973  "Trying to get a coupled var " << name_to_use << " that doesn't exist");
1974 
1975  if (auto coupled_var = dynamic_cast<T *>(coupled_vars_it->second[comp]))
1976  return coupled_var;
1977  else
1978  {
1979  for (auto & var : _coupled_standard_moose_vars)
1980  if (var->name() == name_to_use)
1981  mooseError("The named variable is a standard variable, try a "
1982  "'coupled[Value/Gradient/Dot/etc]...' function instead");
1983  for (auto & var : _coupled_vector_moose_vars)
1984  if (var->name() == name_to_use)
1985  mooseError("The named variable is a vector variable, try a "
1986  "'coupledVector[Value/Gradient/Dot/etc]...' function instead");
1987  for (auto & var : _coupled_array_moose_vars)
1988  if (var->name() == name_to_use)
1989  mooseError("The named variable is an array variable, try a "
1990  "'coupledArray[Value/Gradient/Dot/etc]...' function instead");
1991  for (auto & var : _coupled_fv_moose_vars)
1992  if (var->name() == name_to_use)
1993  mooseError("The named variable is a finite volume variable, which the coupled[...] routine "
1994  "used does not support. Try using the functor system routines instead.");
1995  mooseError(
1996  "Variable '", name_to_use, "' is of a different C++ type than you tried to fetch it as.");
1997  }
1998 }
1999 
2000 template <typename T>
2001 const T *
2002 Coupleable::getVarHelper(const std::string & var_name, unsigned int comp) const
2003 {
2004  return const_cast<Coupleable *>(this)->getVarHelper<T>(var_name, comp);
2005 }
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:344
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::kokkosCoupledDot
Moose::Kokkos::VariableValue kokkosCoupledDot(const std::string &var_name, unsigned int comp=0) const
VectorVariableDivergence
OutputTools< RealVectorValue >::VariableDivergence VectorVariableDivergence
Definition: MooseTypes.h:364
Coupleable::kokkosCoupledNodalValues
Moose::Kokkos::VariableValue kokkosCoupledNodalValues(const std::string &var_name) const
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:111
Coupleable::kokkosCoupledVectorTagDofValueByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValueByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Coupleable::_c_nodal
bool _c_nodal
True if we provide coupling to nodal values.
Definition: Coupleable.h:1444
Coupleable::checkFuncType
void checkFuncType(const std::string var_name, VarType t, FuncAge age) const
Definition: Coupleable.C:222
Coupleable::kokkosZeroVariable
Moose::Kokkos::Variable kokkosZeroVariable() const
Coupleable::getCoupledVectorMooseVars
const std::vector< VectorMooseVariable * > & getCoupledVectorMooseVars() const
Get the list of vector coupled variables.
Definition: Coupleable.h:102
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:1529
GenericVectorVariableValue
Moose::GenericType< VectorVariableValue, is_ad > GenericVectorVariableValue
Definition: MooseTypes.h:709
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:1498
Coupleable::_grad_phi_zero
const VariablePhiGradient & _grad_phi_zero
Zero gradient of trial function.
Definition: Coupleable.h:1507
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:1513
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:1471
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::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::kokkosCoupledValuesOlder
Moose::Kokkos::VariableValue kokkosCoupledValuesOlder(const std::string &var_name) const
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::kokkosCoupledVectorTagVariable
Moose::Kokkos::Variable kokkosCoupledVectorTagVariable(const std::string &var_name, const std::string &tag_name, unsigned int comp) const
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:238
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
Coupleable::kokkosCoupledNodalValueOld
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOld(const std::string &var_name, unsigned int comp=0) const
MooseWritableVariable
MooseVariableField< Real > MooseWritableVariable
Definition: Coupleable.h:45
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:1515
Coupleable::_grad_zero
const VariableGradient & _grad_zero
Zero gradient of a variable.
Definition: Coupleable.h:1503
Coupleable::_coupled_vars
std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > > _coupled_vars
Coupled vars whose values we provide.
Definition: Coupleable.h:1423
Coupleable::_fe_coupleable_matrix_tags
std::set< TagID > _fe_coupleable_matrix_tags
Definition: Coupleable.h:1812
Coupleable::_ad_grad_zero
const MooseArray< ADRealVectorValue > & _ad_grad_zero
Definition: Coupleable.h:1504
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:1815
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::kokkosCoupledVectorTagNodalValueByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValueByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
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:1435
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:1510
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:1706
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:360
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:1532
Coupleable::_c_allow_element_to_nodal_coupling
const bool _c_allow_element_to_nodal_coupling
Definition: Coupleable.h:1450
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::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:1810
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:1495
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::kokkosCoupledVectorTagGradients
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradients(const std::string &var_name, const std::string &tag_param_name) const
Coupleable::_c_tid
THREAD_ID _c_tid
Thread ID of the thread using this object.
Definition: Coupleable.h:1453
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::kokkosCoupledGradient
Moose::Kokkos::VariableGradient kokkosCoupledGradient(const std::string &var_name, unsigned int comp=0) const
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::kokkosCoupledVectorTagVariables
Moose::Kokkos::Variable kokkosCoupledVectorTagVariables(const std::string &var_name, const std::string &tag_name) const
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:1824
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:348
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:1808
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:1477
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::genericZeroGradient
const GenericVariableGradient< is_ad > & genericZeroGradient()
Returns zero gradient templated with automatic differentiation boolean.
Coupleable::kokkosCoupledDofValue
Moose::Kokkos::VariableValue kokkosCoupledDofValue(const std::string &var_name, unsigned int comp=0) const
VectorVariableCurl
OutputTools< RealVectorValue >::VariableCurl VectorVariableCurl
Definition: MooseTypes.h:363
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::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::kokkosZeroGradient
Moose::Kokkos::VariableGradient kokkosZeroGradient() const
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...
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:149
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::kokkosCoupledDotDu
Moose::Kokkos::Scalar< const Real > kokkosCoupledDotDu(const std::string &var_name, unsigned int comp=0) const
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:1464
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
Coupleable::kokkosCoupledVectorTagGradientsByName
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientsByName(const std::string &var_name, const std::string &tag_name) const
FEProblemBase
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Definition: FEProblemBase.h:150
Coupleable::kokkosCoupledVectorTagNodalValue
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValue(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
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::kokkosCoupledNodalDot
Moose::Kokkos::VariableValue kokkosCoupledNodalDot(const std::string &var_name, unsigned int comp=0) const
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:2002
VariablePhiSecond
OutputTools< Real >::VariablePhiSecond VariablePhiSecond
Definition: MooseTypes.h:350
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::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:1429
Coupleable::getCoupledStandardMooseVars
const std::vector< MooseVariable * > & getCoupledStandardMooseVars() const
Get the list of standard coupled variables.
Definition: Coupleable.h:93
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:1420
Coupleable::_c_fe_problem
FEProblemBase & _c_fe_problem
Definition: Coupleable.h:1417
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::kokkosZeroNodalValue
Moose::Kokkos::VariableValue kokkosZeroNodalValue() const
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:1447
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::kokkosCoupledValue
Moose::Kokkos::VariableValue kokkosCoupledValue(const std::string &var_name, unsigned int comp=0) const
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:1432
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::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:1830
ArrayVariableValue
OutputTools< RealEigenVector >::VariableValue ArrayVariableValue
Definition: MooseTypes.h:377
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:116
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:707
Coupleable::getWritableCoupledVariables
auto & getWritableCoupledVariables() const
returns a reference to the set of writable coupled variables
Definition: Coupleable.h:137
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:28
GenericVariableGradient
Moose::GenericType< VariableGradient, is_ad > GenericVariableGradient
Definition: MooseTypes.h:711
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::kokkosCoupledValues
Moose::Kokkos::VariableValue kokkosCoupledValues(const std::string &var_name) const
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:1480
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:1489
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:1460
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::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::kokkosCoupledGradients
Moose::Kokkos::VariableGradient kokkosCoupledGradients(const std::string &var_name) const
Coupleable::kokkosCoupledVectorTagNodalValues
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValues(const std::string &var_name, const std::string &tag_param_name) const
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::kokkosCoupledDofValues
Moose::Kokkos::VariableValue kokkosCoupledDofValues(const std::string &var_name) const
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::_c_name
const std::string & _c_name
The name of the object this interface is part of.
Definition: Coupleable.h:1412
Coupleable::kokkosCoupledNodalValueOlder
Moose::Kokkos::VariableValue kokkosCoupledNodalValueOlder(const std::string &var_name, unsigned int comp=0) const
Coupleable::kokkosCoupledDofValuesOlder
Moose::Kokkos::VariableValue kokkosCoupledDofValuesOlder(const std::string &var_name) const
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::kokkosZeroValue
Moose::Kokkos::VariableValue kokkosZeroValue() const
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::kokkosCoupledVectorTagValueByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValueByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
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::kokkosCoupledDofValueOlder
Moose::Kokkos::VariableValue kokkosCoupledDofValueOlder(const std::string &var_name, unsigned int comp=0) const
Coupleable::kokkosCoupledNodalValuesOlder
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOlder(const std::string &var_name) const
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::kokkosCoupledNodalValuesOld
Moose::Kokkos::VariableValue kokkosCoupledNodalValuesOld(const std::string &var_name) const
Coupleable::getFEVariableCoupleableMatrixTags
const std::set< TagID > & getFEVariableCoupleableMatrixTags() const
Definition: Coupleable.h:129
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::kokkosCoupledVectorTagValue
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValue(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Coupleable::_vector_curl_zero
const VectorVariableCurl & _vector_curl_zero
Zero value of the curl of a vector variable.
Definition: Coupleable.h:1517
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::kokkosCoupledDofValueOld
Moose::Kokkos::VariableValue kokkosCoupledDofValueOld(const std::string &var_name, unsigned int comp=0) const
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::kokkosCoupledVectorTagGradient
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradient(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Coupleable::kokkosCoupledVectorTagDofValuesByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValuesByName(const std::string &var_name, const std::string &tag_name) const
Coupleable::getCoupledMooseVars
const std::vector< MooseVariableFieldBase * > & getCoupledMooseVars() const
Get the list of all coupled variables.
Definition: Coupleable.h:84
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::_obj
const MooseObject *const _obj
Definition: Coupleable.h:1817
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:1526
Coupleable::kokkosCoupledVectorTagDofValue
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValue(const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const
Coupleable::_coupled_moose_vars
std::vector< MooseVariableFieldBase * > _coupled_moose_vars
Vector of all coupled variables.
Definition: Coupleable.h:1426
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:343
Coupleable::getFEVariableCoupleableMatrixTags
std::set< TagID > & getFEVariableCoupleableMatrixTags()
Definition: Coupleable.h:122
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:349
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:1716
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:52
Coupleable::_coupled_fv_moose_vars
std::vector< MooseVariableField< Real > * > _coupled_fv_moose_vars
Vector of all finite volume coupled variables.
Definition: Coupleable.h:1438
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:1414
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:1511
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:1523
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::kokkosCoupledGradientsOld
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOld(const std::string &var_name) const
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:1486
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:124
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:1492
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:1499
Coupleable::getArrayVar
ArrayMooseVariable * getArrayVar(const std::string &var_name, unsigned int comp)
Extract pointer to a coupled array variable.
Definition: Coupleable.C:336
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
Coupleable::kokkosCoupledNodalValue
Moose::Kokkos::VariableValue kokkosCoupledNodalValue(const std::string &var_name, unsigned int comp=0) const
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::kokkosCoupledDots
Moose::Kokkos::VariableValue kokkosCoupledDots(const std::string &var_name) const
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:1805
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:1457
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:713
Coupleable::_c_parameters
const InputParameters & _c_parameters
Definition: Coupleable.h:1409
Coupleable::kokkosCoupledVectorTagDofValues
Moose::Kokkos::VariableValue kokkosCoupledVectorTagDofValues(const std::string &var_name, const std::string &tag_param_name) const
VariableSecond
OutputTools< Real >::VariableSecond VariableSecond
Definition: MooseTypes.h:345
Coupleable::kokkosCoupledGradientsOlder
Moose::Kokkos::VariableGradient kokkosCoupledGradientsOlder(const std::string &var_name) const
Coupleable::_ad_zero
const MooseArray< ADReal > & _ad_zero
Definition: Coupleable.h:1500
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::kokkosCoupledValuesOld
Moose::Kokkos::VariableValue kokkosCoupledValuesOld(const std::string &var_name) const
Coupleable::kokkosCoupledValueOlder
Moose::Kokkos::VariableValue kokkosCoupledValueOlder(const std::string &var_name, unsigned int comp=0) const
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::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:1467
VectorVariableGradient
OutputTools< RealVectorValue >::VariableGradient VectorVariableGradient
Definition: MooseTypes.h:361
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:1541
Coupleable::kokkosCoupledGradientOld
Moose::Kokkos::VariableGradient kokkosCoupledGradientOld(const std::string &var_name, unsigned int comp=0) const
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:1820
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::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::kokkosCoupledVectorTagNodalValuesByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagNodalValuesByName(const std::string &var_name, const std::string &tag_name) const
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:1538
Coupleable::kokkosCoupledDofValuesOld
Moose::Kokkos::VariableValue kokkosCoupledDofValuesOld(const std::string &var_name) const
Coupleable::_coupleable_max_qps
unsigned int _coupleable_max_qps
Maximum qps for any element in this system.
Definition: Coupleable.h:1802
ArrayVariableGradient
OutputTools< RealEigenVector >::VariableGradient ArrayVariableGradient
Definition: MooseTypes.h:379
Coupleable::addFEVariableCoupleableMatrixTag
void addFEVariableCoupleableMatrixTag(TagID tag)
Definition: Coupleable.h:118
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::kokkosCoupledGradientOlder
Moose::Kokkos::VariableGradient kokkosCoupledGradientOlder(const std::string &var_name, unsigned int comp=0) const
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::kokkosCoupledVectorTagGradientByName
Moose::Kokkos::VariableGradient kokkosCoupledVectorTagGradientByName(const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const
Coupleable::kokkosCoupledVectorTagValuesByName
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValuesByName(const std::string &var_name, const std::string &tag_name) const
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::kokkosCoupledVectorTagValues
Moose::Kokkos::VariableValue kokkosCoupledVectorTagValues(const std::string &var_name, const std::string &tag_param_name) const
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:75
Coupleable::getFEVariableCoupleableVectorTags
std::set< TagID > & getFEVariableCoupleableVectorTags()
Definition: Coupleable.h:120
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:142
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:1483
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:237
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:1441
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::kokkosCoupledNodalDots
Moose::Kokkos::VariableValue kokkosCoupledNodalDots(const std::string &var_name) const
Coupleable::kokkosCoupledValueOld
Moose::Kokkos::VariableValue kokkosCoupledValueOld(const std::string &var_name, unsigned int comp=0) const
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 Wed Nov 19 2025 20:05:37 for https://mooseframework.inl.gov by   doxygen 1.8.14