https://mooseframework.inl.gov
MaterialPropertyInterface.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_ENABLED
14 #endif
15 
16 // MOOSE includes
17 #include "MaterialProperty.h"
18 #include "MooseTypes.h"
19 #include "MaterialData.h"
20 #include "MathUtils.h"
21 #include "MooseObjectName.h"
22 #include "InputParameters.h"
23 
24 #include <unordered_map>
25 
26 #define usingMaterialPropertyInterfaceMembers \
27  using MaterialPropertyInterface::_material_data_type; \
28  using MaterialPropertyInterface::_material_data
29 
30 // Forward declarations
31 class MooseObject;
32 class FEProblemBase;
33 class SubProblem;
34 
43 template <class M>
45 {
46 public:
47  OptionalMaterialPropertyProxyBase(const std::string & name, const unsigned int state)
48  : _name(name), _state(state)
49  {
50  }
52  virtual void resolve(M & material) = 0;
53 
54 protected:
55  const std::string _name;
56  const unsigned int _state;
57 };
58 
70 {
71 public:
72  MaterialPropertyInterface(const MooseObject * moose_object,
73  const std::set<SubdomainID> & block_ids,
74  const std::set<BoundaryID> & boundary_ids);
75 
76 #ifdef MOOSE_KOKKOS_ENABLED
77 
81  const Moose::Kokkos::FunctorCopy & key);
82 #endif
83 
85 
91 
93 
102  template <typename T, bool is_ad>
104  const unsigned int state = 0)
105  {
106  return getGenericMaterialProperty<T, is_ad>(name, _material_data, state);
107  }
108  template <typename T>
109  const MaterialProperty<T> & getMaterialProperty(const std::string & name,
110  const unsigned int state = 0)
111  {
112  return getGenericMaterialProperty<T, false>(name, state);
113  }
114  template <typename T>
115  const ADMaterialProperty<T> & getADMaterialProperty(const std::string & name)
116  {
117  return getGenericMaterialProperty<T, true>(name, 0);
118  }
119  template <typename T>
120  const MaterialProperty<T> & getMaterialPropertyOld(const std::string & name)
121  {
122  return getMaterialProperty<T>(name, 1);
123  }
124  template <typename T>
125  const MaterialProperty<T> & getMaterialPropertyOlder(const std::string & name)
126  {
127  return getMaterialProperty<T>(name, 2);
128  }
130 
132 
139  template <typename T, bool is_ad>
141  getGenericMaterialPropertyByName(const MaterialPropertyName & name, const unsigned int state = 0)
142  {
143  return getGenericMaterialPropertyByName<T, is_ad>(name, _material_data, state);
144  }
145  template <typename T>
146  const MaterialProperty<T> & getMaterialPropertyByName(const MaterialPropertyName & name,
147  const unsigned int state = 0)
148  {
149  return getGenericMaterialPropertyByName<T, false>(name, state);
150  }
151  template <typename T>
152  const ADMaterialProperty<T> & getADMaterialPropertyByName(const MaterialPropertyName & name)
153  {
154  return getGenericMaterialPropertyByName<T, true>(name, 0);
155  }
156  template <typename T>
157  const MaterialProperty<T> & getMaterialPropertyOldByName(const MaterialPropertyName & name)
158  {
159  return getMaterialPropertyByName<T>(name, 1);
160  }
161  template <typename T>
162  const MaterialProperty<T> & getMaterialPropertyOlderByName(const MaterialPropertyName & name)
163  {
164  return getMaterialPropertyByName<T>(name, 2);
165  }
167 
168 #ifdef MOOSE_KOKKOS_SCOPE
169 
177  template <typename T, unsigned int dimension = 0, unsigned int state = 0>
179  getKokkosMaterialPropertyByName(const std::string & prop_name);
187  template <typename T, unsigned int dimension = 0>
189  getKokkosMaterialPropertyOldByName(const std::string & prop_name)
190  {
191  return getKokkosMaterialPropertyByName<T, dimension, 1>(prop_name);
192  }
200  template <typename T, unsigned int dimension = 0>
202  getKokkosMaterialPropertyOlderByName(const std::string & prop_name)
203  {
204  return getKokkosMaterialPropertyByName<T, dimension, 2>(prop_name);
205  }
214  template <typename T, unsigned int dimension = 0, unsigned int state = 0>
216  {
217  return getKokkosMaterialPropertyByName<T, dimension, state>(getMaterialPropertyName(name));
218  }
226  template <typename T, unsigned int dimension = 0>
228  getKokkosMaterialPropertyOld(const std::string & name)
229  {
230  return getKokkosMaterialPropertyByName<T, dimension, 1>(getMaterialPropertyName(name));
231  }
239  template <typename T, unsigned int dimension = 0>
241  getKokkosMaterialPropertyOlder(const std::string & name)
242  {
243  return getKokkosMaterialPropertyByName<T, dimension, 2>(getMaterialPropertyName(name));
244  }
245 #endif
246 
249  template <typename T, bool is_ad>
251  getGenericOptionalMaterialProperty(const std::string & name, const unsigned int state = 0);
252 
253  template <typename T>
255  const unsigned int state = 0)
256  {
257  return getGenericOptionalMaterialProperty<T, false>(name, state);
258  }
259  template <typename T>
261  {
262  return getGenericOptionalMaterialProperty<T, true>(name);
263  }
264 
265  template <typename T>
267  {
268  return getOptionalMaterialProperty<T>(name, 1);
269  }
270  template <typename T>
272  {
273  return getOptionalMaterialProperty<T>(name, 2);
274  }
276 
287  template <typename T>
288  std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
289  getBlockMaterialProperty(const MaterialPropertyName & name);
290 
295  template <typename T, bool is_ad>
297  getGenericZeroMaterialProperty(const std::string & name);
298  template <typename T, bool is_ad>
300  getGenericZeroMaterialPropertyByName(const std::string & prop_name);
301 
305  template <typename T, bool is_ad>
307 
309  template <typename T, typename... Ts>
311  {
312  return getGenericZeroMaterialProperty<T, false>(args...);
313  }
314 
320  std::set<SubdomainID> getMaterialPropertyBlocks(const std::string & name);
321 
327  std::vector<SubdomainName> getMaterialPropertyBlockNames(const std::string & name);
328 
334  std::set<BoundaryID> getMaterialPropertyBoundaryIDs(const std::string & name);
335 
341  std::vector<BoundaryName> getMaterialPropertyBoundaryNames(const std::string & name);
342 
347  void checkBlockAndBoundaryCompatibility(std::shared_ptr<MaterialBase> discrete);
348 
350 
358  MaterialBase & getMaterial(const std::string & name);
359  MaterialBase & getMaterialByName(const std::string & name, bool no_warn = false);
361 
363  std::unordered_map<SubdomainID, std::vector<MaterialBase *>>
364  buildRequiredMaterials(bool allow_stateful = true);
365 
367 
372  template <typename T>
373  bool hasMaterialProperty(const std::string & name);
374  template <typename T>
375  bool hasMaterialPropertyByName(const std::string & name);
376  template <typename T>
377  bool hasADMaterialProperty(const std::string & name);
378  template <typename T>
379  bool hasADMaterialPropertyByName(const std::string & name);
380 #ifdef MOOSE_KOKKOS_SCOPE
381  template <typename T, unsigned int dimension = 0>
382  bool hasKokkosMaterialProperty(const std::string & name);
383  template <typename T, unsigned int dimension = 0>
384  bool hasKokkosMaterialPropertyByName(const std::string & name);
385 #endif
386 
389  template <typename T, bool is_ad>
390  bool hasGenericMaterialProperty(const std::string & name)
391  {
392  if constexpr (is_ad)
393  return hasADMaterialProperty<T>(name);
394  else
395  return hasMaterialProperty<T>(name);
396  }
397  template <typename T, bool is_ad>
398  bool hasGenericMaterialPropertyByName(const std::string & name)
399  {
400  if constexpr (is_ad)
401  return hasADMaterialPropertyByName<T>(name);
402  else
403  return hasMaterialPropertyByName<T>(name);
404  }
406 
412  void statefulPropertiesAllowed(bool);
413 
418 
425  virtual const std::unordered_set<unsigned int> & getMatPropDependencies() const
426  {
428  }
429 
431  virtual void resolveOptionalProperties();
432 
436  template <typename T, bool is_ad>
438  const std::string & name, MaterialData & material_data, const unsigned int state = 0);
439 
445  template <typename T>
446  const MaterialProperty<T> & getMaterialProperty(const std::string & name,
447  MaterialData & material_data,
448  const unsigned int state = 0)
449  {
450  return getGenericMaterialProperty<T, false>(name, material_data, state);
451  }
452 
458  template <typename T>
459  const ADMaterialProperty<T> & getADMaterialProperty(const std::string & name,
460  MaterialData & material_data)
461  {
462  return getGenericMaterialProperty<T, true>(name, material_data, 0);
463  }
464 
469  template <typename T, bool is_ad>
471  const MaterialPropertyName & name, MaterialData & material_data, const unsigned int state);
472 
478  template <typename T, bool is_ad>
480  getPossiblyConstantGenericMaterialPropertyByName(const MaterialPropertyName & prop_name,
481  MaterialData & material_data,
482  const unsigned int state);
483 
489  template <typename T>
490  const MaterialProperty<T> & getMaterialPropertyByName(const MaterialPropertyName & name,
491  MaterialData & material_data,
492  const unsigned int state = 0)
493  {
494  return getGenericMaterialPropertyByName<T, false>(name, material_data, state);
495  }
496 
501  template <typename T>
502  const ADMaterialProperty<T> & getADMaterialPropertyByName(const MaterialPropertyName & name,
503  MaterialData & material_data)
504  {
505  return getGenericMaterialPropertyByName<T, true>(name, material_data, 0);
506  }
507 
511  template <typename T>
512  const MaterialProperty<T> & getMaterialPropertyOld(const std::string & name,
513  MaterialData & material_data)
514  {
515  return getMaterialProperty<T>(name, material_data, 1);
516  }
517 
522  template <typename T>
523  const MaterialProperty<T> & getMaterialPropertyOlder(const std::string & name,
524  MaterialData & material_data)
525  {
526  return getMaterialProperty<T>(name, material_data, 2);
527  }
528 
533  template <typename T>
534  const MaterialProperty<T> & getMaterialPropertyOldByName(const MaterialPropertyName & name,
535  MaterialData & material_data)
536  {
537  return getMaterialPropertyByName<T>(name, material_data, 1);
538  }
539 
544  template <typename T>
545  const MaterialProperty<T> & getMaterialPropertyOlderByName(const MaterialPropertyName & name,
546  MaterialData & material_data)
547  {
548  return getMaterialPropertyByName<T>(name, material_data, 2);
549  }
550 
551 private:
554 
555 protected:
558 
560  const std::string _mi_name;
561 
564 
567 
570 
573 
575  const bool _is_kokkos_object;
576 
579 
582 
588  virtual void checkMaterialProperty(const std::string & name, const unsigned int state);
589 
593  void markMatPropRequested(const std::string &);
594 
602  MaterialPropertyName getMaterialPropertyName(const std::string & name) const;
603 
611  template <typename T, bool is_ad>
614  defaultGenericMaterialProperty(const std::string & name);
615  template <typename T>
616  const MaterialProperty<T> * defaultMaterialProperty(const std::string & name)
617  {
618  return defaultGenericMaterialProperty<T, false>(name);
619  }
620  template <typename T>
621  const ADMaterialProperty<T> * defaultADMaterialProperty(const std::string & name)
622  {
623  return defaultGenericMaterialProperty<T, true>(name);
624  }
626 
630  void checkExecutionStage();
631 
637 
644 
646  std::vector<std::unique_ptr<PropertyValue>> _default_properties;
647 
649  std::unordered_set<unsigned int> _material_property_dependencies;
650 
651  const MaterialPropertyName _get_suffix;
652 
655 
657  static const std::string _interpolated_old;
658  static const std::string _interpolated_older;
660 
661 private:
665  Moose::MaterialDataType getMaterialDataType(const std::set<BoundaryID> & boundary_ids) const;
666 
667  /*
668  * A proxy method for _mi_feproblem.getMaxQps()
669  */
670  unsigned int getMaxQps() const;
671 
672  /*
673  * A proxy method for _mi_feproblem.addConsumedPropertyName()
674  */
675  void addConsumedPropertyName(const MooseObjectName & obj_name, const std::string & prop_name);
676 
679 
681  const std::set<SubdomainID> & _mi_block_ids;
682 
684  const std::set<BoundaryID> & _mi_boundary_ids;
685 
687  std::vector<std::unique_ptr<OptionalMaterialPropertyProxyBase<MaterialPropertyInterface>>>
689 };
690 
691 template <class M, typename T, bool is_ad>
693 {
694 public:
695  OptionalMaterialPropertyProxy(const std::string & name, const unsigned int state)
697  {
698  }
700  void resolve(M & mpi) override
701  {
702  if (mpi.template hasGenericMaterialProperty<T, is_ad>(this->_name))
703  {
704  if constexpr (is_ad)
705  if (this->_state > 0)
706  mooseError("Non-current (state > 0) material properties are not available as AD");
707 
708  _value.set(&mpi.template getGenericMaterialProperty<T, is_ad>(this->_name, this->_state));
709  }
710  }
711 
712 private:
714 };
715 
716 template <typename T, bool is_ad>
719 {
720  if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
721  {
722  std::istringstream ss(name);
723  Real real_value;
724 
725  // check if the string parsed cleanly into a Real number
726  if (ss >> real_value && ss.eof())
727  {
728  using prop_type = GenericMaterialProperty<T, is_ad>;
729 
730  const auto nqp = Moose::constMaxQpsPerElem;
731  auto & property =
732  _default_properties.emplace_back(std::make_unique<prop_type>(default_property_id));
733  auto & T_property = static_cast<prop_type &>(*property);
734 
735  T_property.resize(nqp);
736  for (const auto qp : make_range(nqp))
737  T_property[qp] = real_value;
738 
739  return &T_property;
740  }
741  }
742 
743  return nullptr;
744 }
745 
746 template <typename T>
747 std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
748 MaterialPropertyInterface::getBlockMaterialProperty(const MaterialPropertyName & name_in)
749 {
750  const auto name = _get_suffix.empty()
751  ? static_cast<const std::string &>(name_in)
752  : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
753 
754  if (_mi_block_ids.empty())
755  mooseError("getBlockMaterialProperty must be called by a block restrictable object");
756 
757  using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;
758 
759  if (!hasMaterialPropertyByName<T>(name))
760  return pair_type(nullptr, {});
761 
762  // Call first so that the ID gets registered
763  const auto & prop = _material_data.getProperty<T, false>(name, 0, _mi_moose_object);
765  auto prop_blocks_pair = pair_type(&prop, std::move(blocks));
766 
768 
769  // Update consumed properties in MaterialPropertyDebugOutput
771 
772  return prop_blocks_pair;
773 }
774 
775 template <typename T>
776 bool
778 {
779  // Check if the supplied parameter is a valid input parameter key
780  const auto prop_name = getMaterialPropertyName(name);
781  return hasMaterialPropertyByName<T>(prop_name);
782 }
783 
784 template <typename T>
785 bool
787 {
788  const auto name = _get_suffix.empty()
789  ? name_in
790  : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
791  return _material_data.haveProperty<T>(name);
792 }
793 
794 template <typename T, bool is_ad>
797 {
798  const auto prop_name = getMaterialPropertyName(name);
799  return getGenericZeroMaterialPropertyByName<T, is_ad>(prop_name);
800 }
801 
802 template <typename T, bool is_ad>
805 {
806  // if found return the requested property
807  if (hasGenericMaterialPropertyByName<T, is_ad>(prop_name))
808  return getGenericMaterialPropertyByName<T, is_ad>(prop_name);
809 
810  return getGenericZeroMaterialProperty<T, is_ad>();
811 }
812 
813 template <typename T, bool is_ad>
816 {
817  // static zero property storage
819 
820  // resize to accomodate maximum number of qpoints
821  // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
822  unsigned int nqp = getMaxQps();
823  if (nqp > zero.size())
824  zero.resize(nqp);
825 
826  // set values for all qpoints to zero
827  for (unsigned int qp = 0; qp < nqp; ++qp)
829 
830  return zero;
831 }
832 
833 template <typename T>
834 bool
836 {
837  // Check if the supplied parameter is a valid input parameter key
838  const auto prop_name = getMaterialPropertyName(name);
839  return hasADMaterialPropertyByName<T>(prop_name);
840 }
841 
842 template <typename T>
843 bool
845 {
846  const auto name = _get_suffix.empty()
847  ? name_in
848  : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
850 }
851 
852 template <typename T, bool is_ad>
855  const unsigned int state)
856 {
857  auto proxy = std::make_unique<OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>>(
858  name, state);
859  auto & optional_property = proxy->value();
860  _optional_property_proxies.push_back(std::move(proxy));
861  return optional_property;
862 }
863 
864 template <typename T, bool is_ad>
867  const MaterialPropertyName & prop_name, MaterialData & material_data, const unsigned int state)
868 {
869  // Check if it's just a constant
870  if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
871  {
873  return *default_property;
874  }
875 
876  if (state > 0 && !_stateful_allowed)
877  mooseError("Stateful material properties not allowed for this object."
878  " State ",
879  state,
880  " property for \"",
881  prop_name,
882  "\" was requested.");
883 
884  return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
885 }
886 
887 template <typename T, bool is_ad>
890  MaterialData & material_data,
891  const unsigned int state)
892 {
893  // Check if the supplied parameter is a valid input parameter key
894  const auto prop_name = getMaterialPropertyName(name);
895 
896  return getPossiblyConstantGenericMaterialPropertyByName<T, is_ad>(
897  prop_name, material_data, state);
898 }
899 
900 template <typename T, bool is_ad>
903  MaterialData & material_data,
904  const unsigned int state)
905 {
906  if (_is_kokkos_object)
907  mooseError("Attempted to retrieve a standard MOOSE material property from a Kokkos object.");
908 
910  {
911  if (state == 1)
912  return getGenericMaterialPropertyByName<T, is_ad>(
913  name_in + _interpolated_old, material_data, 0);
914  if (state == 2)
915  return getGenericMaterialPropertyByName<T, is_ad>(
916  name_in + _interpolated_older, material_data, 0);
917  }
918 
919  const auto name = _get_suffix.empty()
920  ? static_cast<const std::string &>(name_in)
921  : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
922 
924  checkMaterialProperty(name, state);
925 
926  // mark property as requested
928 
929  // Update the boolean flag.
931 
932  // Call first so that the ID gets registered
933  auto & prop = material_data.getProperty<T, is_ad>(name, state, _mi_moose_object);
934 
935  // Does the material data used here matter?
936  _material_property_dependencies.insert(material_data.getPropertyId(name));
937 
938  if (state == 0)
940 
941  return prop;
942 }
943 
944 #ifdef MOOSE_KOKKOS_SCOPE
945 template <typename T, unsigned int dimension>
946 bool
948 {
949  // Check if the supplied parameter is a valid input parameter key
950  const auto prop_name = getMaterialPropertyName(name);
951  return hasKokkosMaterialPropertyByName<T, dimension>(prop_name);
952 }
953 
954 template <typename T, unsigned int dimension>
955 bool
957 {
958  const auto name = _get_suffix.empty()
959  ? name_in
960  : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
961  return _material_data.haveKokkosProperty<T, dimension>(name);
962 }
963 
964 template <typename T, unsigned int dimension, unsigned int state>
967 {
968  if (!_is_kokkos_object)
969  mooseError("Attempted to retrieve a Kokkos material property from a standard MOOSE object.");
970 
971  if constexpr (std::is_same_v<T, Real>)
972  {
973  std::istringstream ss(prop_name);
974  Real value;
975 
976  // Check if the string parsed cleanly into a Real number
977  if (ss >> value && ss.eof())
979  }
980 
982  checkMaterialProperty(prop_name, state);
983 
984  // Mark property as requested
985  markMatPropRequested(prop_name);
986 
987  // Update the boolean flag
989 
990  // Call first so that the ID gets registered
991  auto prop = _material_data.getKokkosProperty<T, dimension, state>(prop_name);
992 
993  // Does the material data used here matter?
995 
996  if constexpr (state == 0)
998 
999  return prop;
1000 }
1001 #endif
virtual const std::unordered_set< unsigned int > & getMatPropDependencies() const
Retrieve the set of material properties that this object depends on.
std::string name(const ElemQuality q)
FEProblemBase & _mi_feproblem
Reference to the FEProblemBase class.
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosProperty(const std::string &prop_name)
Get a Kokkos material property.
Definition: MaterialData.h:455
const THREAD_ID _mi_tid
Current threaded it.
const OptionalMaterialProperty< T > & getOptionalMaterialProperty(const std::string &name, const unsigned int state=0)
const MaterialProperty< T > * defaultMaterialProperty(const std::string &name)
virtual void resolveOptionalProperties()
resolve all optional properties
static const std::string _interpolated_old
name suffixes for interpolated old and older properties
std::string join(Iterator begin, Iterator end, const std::string &delimiter)
Python-like join function for strings over an iterator range.
Definition: MooseUtils.h:142
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlderByName(const std::string &prop_name)
Get an older Kokkos material property by property name.
virtual void checkMaterialProperty(const std::string &name, const unsigned int state)
A helper method for checking material properties This method was required to avoid a compiler problem...
void mooseSetToZero(T &v)
Helper function templates to set a variable to zero.
Definition: MathUtils.h:372
const MooseObjectName _mi_moose_object_name
The "complete" name of the object that this interface belongs for material property output...
static constexpr PropertyValue::id_type default_property_id
The material property ID for a default (parsed from input) property.
const bool _is_kokkos_object
Whether the MOOSE object is a Kokkos object.
const std::set< SubdomainID > & _mi_block_ids
Storage for the block ids created by BlockRestrictable.
std::vector< BoundaryName > getMaterialPropertyBoundaryNames(const std::string &name)
Retrieve the boundary namess that the material property is defined.
bool haveProperty(const std::string &prop_name) const
Returns true if the regular material property exists - defined by any material.
Definition: MaterialData.h:93
virtual bool getMaterialPropertyCalled() const
Returns true if getMaterialProperty() has been called, false otherwise.
bool hasKokkosMaterialPropertyByName(const std::string &name)
const ADMaterialProperty< T > & getADMaterialProperty(const std::string &name)
char ** blocks
bool hasMaterialPropertyByName(const std::string &name)
MaterialPropertyInterface(const MooseObject *moose_object, const std::set< SubdomainID > &block_ids, const std::set< BoundaryID > &boundary_ids)
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
Definition: MooseError.h:323
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialPropertyByName(const std::string &prop_name)
const MaterialProperty< T > & getMaterialPropertyOlderByName(const MaterialPropertyName &name)
constexpr std::size_t constMaxQpsPerElem
This is used for places where we initialize some qp-sized data structures that would end up being siz...
Definition: MooseTypes.h:230
const MaterialProperty< T > & getMaterialPropertyByName(const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)
Retrieve the property named "name" without any deduction for the specified material_data.
static const std::string _interpolated_older
bool hasGenericMaterialPropertyByName(const std::string &name)
std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > getBlockMaterialProperty(const MaterialPropertyName &name)
Retrieve pointer to a material property with the mesh blocks where it is defined The name required by...
MaterialDataType
MaterialData types.
Definition: MooseTypes.h:692
std::vector< SubdomainName > getMaterialPropertyBlockNames(const std::string &name)
Retrieve the block names that the material property is defined.
std::vector< std::unique_ptr< PropertyValue > > _default_properties
Storage vector for default properties.
unsigned int getPropertyId(const std::string &prop_name) const
Wrapper for MaterialStorage::getPropertyId.
Definition: MaterialData.C:80
const MaterialProperty< T > & getMaterialPropertyOld(const std::string &name, MaterialData &material_data)
Retrieve the old property deduced from the name name for the specified material_data.
const bool _mi_boundary_restricted
BoundaryRestricted flag.
const GenericMaterialProperty< T, is_ad > & getGenericMaterialProperty(const std::string &name, const unsigned int state=0)
Retrieve reference to material property or one of it&#39;s old or older values.
std::set< BoundaryID > getMaterialPropertyBoundaryIDs(const std::string &name)
Retrieve the boundary ids that the material property is defined.
unsigned int id_type
The type for a material property ID.
const MaterialProperty< T > & getMaterialPropertyOldByName(const MaterialPropertyName &name)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
static InputParameters validParams()
SubProblem & _mi_subproblem
Reference to the subproblem.
const std::set< BoundaryID > & _mi_boundary_ids
Storage for the boundary ids created by BoundaryRestrictable.
const std::string _mi_name
The name of the object that this interface belongs to.
const Number zero
const MaterialProperty< T > & getMaterialPropertyOldByName(const MaterialPropertyName &name, MaterialData &material_data)
Retrieve the old property named name without any deduction for the specified material_data.
const ADMaterialProperty< T > & getADMaterialProperty(const std::string &name, MaterialData &material_data)
Retrieve the AD property named "name" for the specified material_data.
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOld(const std::string &name)
Get an old Kokkos material property.
MaterialPropertyName getMaterialPropertyName(const std::string &name) const
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
const MaterialProperty< T > & getMaterialPropertyOld(const std::string &name)
void markMatPropRequested(const std::string &)
A proxy method for _mi_feproblem.markMatPropRequested(name)
Helper class for deferred getting of material properties after the construction phase for materials...
MaterialData & _material_data
The material data class that stores properties.
bool hasADMaterialPropertyByName(const std::string &name)
const GenericOptionalMaterialProperty< T, is_ad > & value() const
std::set< SubdomainID > getMaterialPropertyBlocks(const std::string &name)
Retrieve the block ids that the material property is defined.
const MaterialProperty< T > & getMaterialPropertyOlder(const std::string &name)
virtual void resolve(M &material)=0
Wrapper around a material property pointer.
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:27
Moose::MaterialDataType getMaterialDataType(const std::set< BoundaryID > &boundary_ids) const
const GenericOptionalMaterialProperty< T, is_ad > & getGenericOptionalMaterialProperty(const std::string &name, const unsigned int state=0)
const ADMaterialProperty< T > & getADMaterialPropertyByName(const MaterialPropertyName &name)
const MaterialProperty< T > & getMaterialPropertyOlderByName(const MaterialPropertyName &name, MaterialData &material_data)
Retrieve the older property named name without any deduction for the specified material_data.
typename GenericMaterialPropertyStruct< T, is_ad >::type GenericMaterialProperty
const MaterialProperty< T > & getMaterialPropertyOlder(const std::string &name, MaterialData &material_data)
Retrieve the older property deduced from the name name for the specified material_data.
const GenericMaterialProperty< T, is_ad > & getGenericMaterialPropertyByName(const MaterialPropertyName &name, const unsigned int state=0)
Retrieve reference to material property or its old or older value The name required by this method is...
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOldByName(const std::string &prop_name)
Get an old Kokkos material property by property name.
const MaterialPropertyName _get_suffix
const GenericMaterialProperty< T, is_ad > & getGenericZeroMaterialProperty()
Return a constant zero anonymous material property.
const MaterialProperty< T > & getZeroMaterialProperty(Ts... args)
for backwards compatibility
const InputParameters & _mi_params
Parameters of the object with this interface.
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOlder(const std::string &name)
const ADMaterialProperty< T > & getADMaterialPropertyByName(const MaterialPropertyName &name, MaterialData &material_data)
Retrieve the AD property named "name" without any deduction for the specified material_data.
bool hasKokkosMaterialProperty(const std::string &name)
const GenericMaterialProperty< T, is_ad > * defaultGenericMaterialProperty(const std::string &name)
bool hasMaterialProperty(const std::string &name)
Check if the material property exists.
static constexpr PropertyValue::id_type zero_property_id
The material property ID for a zero property.
MaterialBase & getMaterialByName(const std::string &name, bool no_warn=false)
void statefulPropertiesAllowed(bool)
Derived classes can declare whether or not they work with stateful material properties.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
bool haveADProperty(const std::string &prop_name) const
Returns true if the AD material property exists - defined by any material.
Definition: MaterialData.h:100
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:78
const OptionalADMaterialProperty< T > & getOptionalADMaterialProperty(const std::string &name)
An interface for accessing Materials.
const MaterialProperty< T > & getMaterialProperty(const std::string &name, MaterialData &material_data, const unsigned int state=0)
Retrieve the property named "name" for the specified material_data.
GenericMaterialProperty< T, is_ad > & getProperty(const std::string &prop_name, const unsigned int state, const MooseObject &requestor)
Retrieves a material property.
Definition: MaterialData.h:127
bool haveKokkosProperty(const std::string &prop_name) const
Get whether a Kokkos material property exists.
Definition: MaterialData.h:444
IntRange< T > make_range(T beg, T end)
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyByName(const std::string &prop_name)
Get a Kokkos material property by property name for any state.
const bool _use_interpolated_state
Use the interpolated state set up through the ProjectedStatefulMaterialStorageAction.
void addConsumedPropertyName(const MooseObjectName &obj_name, const std::string &prop_name)
GenericOptionalMaterialProperty< T, is_ad > _value
static constexpr id_type invalid_property_id
The material property ID for an invalid property We only have this because there are a few cases wher...
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialPropertyOlder(const std::string &name)
Get an older Kokkos material property.
Proxy for accessing MaterialPropertyStorage.
Definition: MaterialData.h:37
const GenericMaterialProperty< T, is_ad > & getPossiblyConstantGenericMaterialPropertyByName(const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)
Retrieve the generic property named "prop_name" without any deduction for the specified material_data...
std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > > _optional_property_proxies
optional material properties
void checkBlockAndBoundaryCompatibility(std::shared_ptr< MaterialBase > discrete)
Check if block and boundary restrictions of a given material are compatible with the current material...
bool _get_material_property_called
Initialized to false.
Moose::Kokkos::MaterialProperty< T, dimension > getKokkosMaterialProperty(const std::string &name)
Get a Kokkos material property for any state.
OptionalMaterialPropertyProxyBase(const std::string &name, const unsigned int state)
void checkExecutionStage()
Check and throw an error if the execution has progressed past the construction stage.
const Moose::MaterialDataType _material_data_type
The type of data.
bool _stateful_allowed
True by default.
The Kokkos material property class.
A class for storing the names of MooseObject by tag and object name.
MaterialBase & getMaterial(const std::string &name)
Return a MaterialBase reference - usable for computing directly.
const MooseObject & _mi_moose_object
The MooseObject creating the MaterialPropertyInterface.
const ADMaterialProperty< T > * defaultADMaterialProperty(const std::string &name)
const MaterialProperty< T > & getMaterialPropertyByName(const MaterialPropertyName &name, const unsigned int state=0)
bool hasGenericMaterialProperty(const std::string &name)
generic hasMaterialProperty helper
MaterialBases compute MaterialProperties.
Definition: MaterialBase.h:62
bool hasADMaterialProperty(const std::string &name)
std::unordered_set< unsigned int > _material_property_dependencies
The set of material properties (as given by their IDs) that this object depends on.
const OptionalMaterialProperty< T > & getOptionalMaterialPropertyOld(const std::string &name)
const MaterialProperty< T > & getMaterialProperty(const std::string &name, const unsigned int state=0)
unsigned int THREAD_ID
Definition: MooseTypes.h:209
std::unordered_map< SubdomainID, std::vector< MaterialBase * > > buildRequiredMaterials(bool allow_stateful=true)
get a map of MaterialBase pointers for all material objects that this object depends on for each bloc...
OptionalMaterialPropertyProxy(const std::string &name, const unsigned int state)