12 #ifdef MOOSE_KOKKOS_ENABLED 24 #include <unordered_map> 26 #define usingMaterialPropertyInterfaceMembers \ 27 using MaterialPropertyInterface::_material_data_type; \ 28 using MaterialPropertyInterface::_material_data 52 virtual void resolve(M & material) = 0;
73 const std::set<SubdomainID> & block_ids,
74 const std::set<BoundaryID> & boundary_ids);
76 #ifdef MOOSE_KOKKOS_ENABLED 102 template <
typename T,
bool is_ad>
104 const unsigned int state = 0)
108 template <
typename T>
110 const unsigned int state = 0)
112 return getGenericMaterialProperty<T, false>(
name, state);
114 template <
typename T>
117 return getGenericMaterialProperty<T, true>(
name, 0);
119 template <
typename T>
122 return getMaterialProperty<T>(
name, 1);
124 template <
typename T>
127 return getMaterialProperty<T>(
name, 2);
139 template <
typename T,
bool is_ad>
145 template <
typename T>
147 const unsigned int state = 0)
149 return getGenericMaterialPropertyByName<T, false>(
name, state);
151 template <
typename T>
154 return getGenericMaterialPropertyByName<T, true>(
name, 0);
156 template <
typename T>
159 return getMaterialPropertyByName<T>(
name, 1);
161 template <
typename T>
164 return getMaterialPropertyByName<T>(
name, 2);
168 #ifdef MOOSE_KOKKOS_SCOPE 177 template <
typename T,
unsigned int dimension = 0,
unsigned int state = 0>
187 template <
typename T,
unsigned int dimension = 0>
191 return getKokkosMaterialPropertyByName<T, dimension, 1>(prop_name);
200 template <
typename T,
unsigned int dimension = 0>
204 return getKokkosMaterialPropertyByName<T, dimension, 2>(prop_name);
214 template <
typename T,
unsigned int dimension = 0,
unsigned int state = 0>
226 template <
typename T,
unsigned int dimension = 0>
239 template <
typename T,
unsigned int dimension = 0>
249 template <
typename T,
bool is_ad>
253 template <
typename T>
255 const unsigned int state = 0)
257 return getGenericOptionalMaterialProperty<T, false>(
name, state);
259 template <
typename T>
262 return getGenericOptionalMaterialProperty<T, true>(
name);
265 template <
typename T>
268 return getOptionalMaterialProperty<T>(
name, 1);
270 template <
typename T>
273 return getOptionalMaterialProperty<T>(
name, 2);
287 template <
typename T>
288 std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
295 template <
typename T,
bool is_ad>
298 template <
typename T,
bool is_ad>
305 template <
typename T,
bool is_ad>
309 template <
typename T,
typename... Ts>
312 return getGenericZeroMaterialProperty<T, false>(args...);
363 std::unordered_map<SubdomainID, std::vector<MaterialBase *>>
372 template <
typename T>
374 template <
typename T>
376 template <
typename T>
378 template <
typename T>
380 #ifdef MOOSE_KOKKOS_SCOPE 381 template <
typename T,
unsigned int dimension = 0>
383 template <
typename T,
unsigned int dimension = 0>
389 template <
typename T,
bool is_ad>
393 return hasADMaterialProperty<T>(
name);
395 return hasMaterialProperty<T>(
name);
397 template <
typename T,
bool is_ad>
401 return hasADMaterialPropertyByName<T>(
name);
403 return hasMaterialPropertyByName<T>(
name);
436 template <
typename T,
bool is_ad>
438 const std::string & name,
MaterialData & material_data,
const unsigned int state = 0);
445 template <
typename T>
448 const unsigned int state = 0)
450 return getGenericMaterialProperty<T, false>(
name, material_data, state);
458 template <
typename T>
462 return getGenericMaterialProperty<T, true>(
name, material_data, 0);
469 template <
typename T,
bool is_ad>
471 const MaterialPropertyName & name,
MaterialData & material_data,
const unsigned int state);
478 template <
typename T,
bool is_ad>
482 const unsigned int state);
489 template <
typename T>
492 const unsigned int state = 0)
494 return getGenericMaterialPropertyByName<T, false>(
name, material_data, state);
501 template <
typename T>
505 return getGenericMaterialPropertyByName<T, true>(
name, material_data, 0);
511 template <
typename T>
515 return getMaterialProperty<T>(
name, material_data, 1);
522 template <
typename T>
526 return getMaterialProperty<T>(
name, material_data, 2);
533 template <
typename T>
537 return getMaterialPropertyByName<T>(
name, material_data, 1);
544 template <
typename T>
548 return getMaterialPropertyByName<T>(
name, material_data, 2);
611 template <
typename T,
bool is_ad>
615 template <
typename T>
618 return defaultGenericMaterialProperty<T, false>(
name);
620 template <
typename T>
623 return defaultGenericMaterialProperty<T, true>(
name);
687 std::vector<std::unique_ptr<OptionalMaterialPropertyProxyBase<MaterialPropertyInterface>>>
691 template <
class M,
typename T,
bool is_ad>
702 if (mpi.template hasGenericMaterialProperty<T, is_ad>(this->_name))
706 mooseError(
"Non-current (state > 0) material properties are not available as AD");
708 _value.set(&mpi.template getGenericMaterialProperty<T, is_ad>(this->_name, this->_state));
716 template <
typename T,
bool is_ad>
720 if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
722 std::istringstream ss(
name);
726 if (ss >> real_value && ss.eof())
733 auto & T_property =
static_cast<prop_type &
>(*property);
735 T_property.resize(nqp);
737 T_property[qp] = real_value;
746 template <
typename T>
747 std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
751 ?
static_cast<const std::string &
>(name_in)
755 mooseError(
"getBlockMaterialProperty must be called by a block restrictable object");
757 using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;
759 if (!hasMaterialPropertyByName<T>(
name))
760 return pair_type(
nullptr, {});
765 auto prop_blocks_pair = pair_type(&prop, std::move(
blocks));
772 return prop_blocks_pair;
775 template <
typename T>
781 return hasMaterialPropertyByName<T>(prop_name);
784 template <
typename T>
794 template <
typename T,
bool is_ad>
799 return getGenericZeroMaterialPropertyByName<T, is_ad>(prop_name);
802 template <
typename T,
bool is_ad>
807 if (hasGenericMaterialPropertyByName<T, is_ad>(prop_name))
808 return getGenericMaterialPropertyByName<T, is_ad>(prop_name);
810 return getGenericZeroMaterialProperty<T, is_ad>();
813 template <
typename T,
bool is_ad>
823 if (nqp >
zero.size())
827 for (
unsigned int qp = 0; qp < nqp; ++qp)
833 template <
typename T>
839 return hasADMaterialPropertyByName<T>(prop_name);
842 template <
typename T>
852 template <
typename T,
bool is_ad>
855 const unsigned int state)
857 auto proxy = std::make_unique<OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>>(
859 auto & optional_property = proxy->value();
861 return optional_property;
864 template <
typename T,
bool is_ad>
867 const MaterialPropertyName & prop_name,
MaterialData & material_data,
const unsigned int state)
870 if (
const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
873 return *default_property;
877 mooseError(
"Stateful material properties not allowed for this object." 882 "\" was requested.");
884 return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
887 template <
typename T,
bool is_ad>
891 const unsigned int state)
896 return getPossiblyConstantGenericMaterialPropertyByName<T, is_ad>(
897 prop_name, material_data, state);
900 template <
typename T,
bool is_ad>
904 const unsigned int state)
907 mooseError(
"Attempted to retrieve a standard MOOSE material property from a Kokkos object.");
912 return getGenericMaterialPropertyByName<T, is_ad>(
915 return getGenericMaterialPropertyByName<T, is_ad>(
920 ?
static_cast<const std::string &
>(name_in)
944 #ifdef MOOSE_KOKKOS_SCOPE 945 template <
typename T,
unsigned int dimension>
951 return hasKokkosMaterialPropertyByName<T, dimension>(prop_name);
954 template <
typename T,
unsigned int dimension>
964 template <
typename T,
unsigned int dimension,
unsigned int state>
969 mooseError(
"Attempted to retrieve a Kokkos material property from a standard MOOSE object.");
971 if constexpr (std::is_same_v<T, Real>)
973 std::istringstream ss(prop_name);
977 if (ss >>
value && ss.eof())
996 if constexpr (state == 0)
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.
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.
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.
const MooseObjectName _mi_moose_object_name
The "complete" name of the object that this interface belongs for material property output...
unsigned int getMaxQps() const
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.
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)
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...
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...
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.
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.
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.
virtual ~OptionalMaterialPropertyProxyBase()
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'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)
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 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.
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.
Generic class for solving transient nonlinear problems.
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.
bool haveKokkosProperty(const std::string &prop_name) const
Get whether a Kokkos material property exists.
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.
void resolve(M &mpi) override
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.
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.
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)
const unsigned int _state
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)