MaterialPropertyInterface.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "MaterialProperty.h"
#include "MooseTypes.h"
#include "MaterialData.h"
#include "MathUtils.h"
#include "MooseObjectName.h"
#include "InputParameters.h"

#include <unordered_map>

#define usingMaterialPropertyInterfaceMembers                                                      \
  using MaterialPropertyInterface::_material_data_type;                                            \
  using MaterialPropertyInterface::_material_data

// Forward declarations
class MooseObject;
class FEProblemBase;
class SubProblem;

template <class M>
class OptionalMaterialPropertyProxyBase
{
public:
  OptionalMaterialPropertyProxyBase(const std::string & name, const unsigned int state)
    : _name(name), _state(state)
  {
  }
  virtual ~OptionalMaterialPropertyProxyBase() {}
  virtual void resolve(M & material) = 0;

protected:
  const std::string _name;
  const unsigned int _state;
};

class MaterialPropertyInterface
{
public:
  MaterialPropertyInterface(const MooseObject * moose_object,
                            const std::set<SubdomainID> & block_ids,
                            const std::set<BoundaryID> & boundary_ids);

  static InputParameters validParams();

  static constexpr PropertyValue::id_type default_property_id =
      PropertyValue::invalid_property_id - 1;
  static constexpr PropertyValue::id_type zero_property_id = PropertyValue::invalid_property_id - 2;


  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> & getGenericMaterialProperty(const std::string & name,
                                                                       const unsigned int state = 0)
  {
    return getGenericMaterialProperty<T, is_ad>(name, _material_data, state);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialProperty(const std::string & name,
                                                  const unsigned int state = 0)
  {
    return getGenericMaterialProperty<T, false>(name, state);
  }
  template <typename T>
  const ADMaterialProperty<T> & getADMaterialProperty(const std::string & name)
  {
    return getGenericMaterialProperty<T, true>(name, 0);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOld(const std::string & name)
  {
    return getMaterialProperty<T>(name, 1);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlder(const std::string & name)
  {
    return getMaterialProperty<T>(name, 2);
  }


  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> &
  getGenericMaterialPropertyByName(const MaterialPropertyName & name, const unsigned int state = 0)
  {
    return getGenericMaterialPropertyByName<T, is_ad>(name, _material_data, state);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyByName(const MaterialPropertyName & name,
                                                        const unsigned int state = 0)
  {
    return getGenericMaterialPropertyByName<T, false>(name, state);
  }
  template <typename T>
  const ADMaterialProperty<T> & getADMaterialPropertyByName(const MaterialPropertyName & name)
  {
    return getGenericMaterialPropertyByName<T, true>(name, 0);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOldByName(const MaterialPropertyName & name)
  {
    return getMaterialPropertyByName<T>(name, 1);
  }
  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlderByName(const MaterialPropertyName & name)
  {
    return getMaterialPropertyByName<T>(name, 2);
  }

  template <typename T, bool is_ad>
  const GenericOptionalMaterialProperty<T, is_ad> &
  getGenericOptionalMaterialProperty(const std::string & name, const unsigned int state = 0);

  template <typename T>
  const OptionalMaterialProperty<T> & getOptionalMaterialProperty(const std::string & name,
                                                                  const unsigned int state = 0)
  {
    return getGenericOptionalMaterialProperty<T, false>(name, state);
  }
  template <typename T>
  const OptionalADMaterialProperty<T> & getOptionalADMaterialProperty(const std::string & name)
  {
    return getGenericOptionalMaterialProperty<T, true>(name);
  }

  template <typename T>
  const OptionalMaterialProperty<T> & getOptionalMaterialPropertyOld(const std::string & name)
  {
    return getOptionalMaterialProperty<T>(name, 1);
  }
  template <typename T>
  const OptionalMaterialProperty<T> & getOptionalMaterialPropertyOlder(const std::string & name)
  {
    return getOptionalMaterialProperty<T>(name, 2);
  }

  template <typename T>
  std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
  getBlockMaterialProperty(const MaterialPropertyName & name);

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> &
  getGenericZeroMaterialProperty(const std::string & name);
  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> &
  getGenericZeroMaterialPropertyByName(const std::string & prop_name);

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> & getGenericZeroMaterialProperty();

  template <typename T, typename... Ts>
  const MaterialProperty<T> & getZeroMaterialProperty(Ts... args)
  {
    return getGenericZeroMaterialProperty<T, false>(args...);
  }

  std::set<SubdomainID> getMaterialPropertyBlocks(const std::string & name);

  std::vector<SubdomainName> getMaterialPropertyBlockNames(const std::string & name);

  std::set<BoundaryID> getMaterialPropertyBoundaryIDs(const std::string & name);

  std::vector<BoundaryName> getMaterialPropertyBoundaryNames(const std::string & name);

  void checkBlockAndBoundaryCompatibility(std::shared_ptr<MaterialBase> discrete);


  MaterialBase & getMaterial(const std::string & name);
  MaterialBase & getMaterialByName(const std::string & name, bool no_warn = false);

  std::unordered_map<SubdomainID, std::vector<MaterialBase *>>
  buildRequiredMaterials(bool allow_stateful = true);


  template <typename T>
  bool hasMaterialProperty(const std::string & name);
  template <typename T>
  bool hasMaterialPropertyByName(const std::string & name);
  template <typename T>
  bool hasADMaterialProperty(const std::string & name);
  template <typename T>
  bool hasADMaterialPropertyByName(const std::string & name);

  template <typename T, bool is_ad>
  bool hasGenericMaterialProperty(const std::string & name)
  {
    if constexpr (is_ad)
      return hasADMaterialProperty<T>(name);
    else
      return hasMaterialProperty<T>(name);
  }
  template <typename T, bool is_ad>
  bool hasGenericMaterialPropertyByName(const std::string & name)
  {
    if constexpr (is_ad)
      return hasADMaterialPropertyByName<T>(name);
    else
      return hasMaterialPropertyByName<T>(name);
  }

  void statefulPropertiesAllowed(bool);

  bool getMaterialPropertyCalled() const { return _get_material_property_called; }

  virtual const std::unordered_set<unsigned int> & getMatPropDependencies() const
  {
    return _material_property_dependencies;
  }

  virtual void resolveOptionalProperties();

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> & getGenericMaterialProperty(
      const std::string & name, MaterialData & material_data, const unsigned int state = 0);

  template <typename T>
  const MaterialProperty<T> & getMaterialProperty(const std::string & name,
                                                  MaterialData & material_data,
                                                  const unsigned int state = 0)
  {
    return getGenericMaterialProperty<T, false>(name, material_data, state);
  }

  template <typename T>
  const ADMaterialProperty<T> & getADMaterialProperty(const std::string & name,
                                                      MaterialData & material_data)
  {
    return getGenericMaterialProperty<T, true>(name, material_data, 0);
  }

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> & getGenericMaterialPropertyByName(
      const MaterialPropertyName & name, MaterialData & material_data, const unsigned int state);

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> &
  getPossiblyConstantGenericMaterialPropertyByName(const MaterialPropertyName & prop_name,
                                                   MaterialData & material_data,
                                                   const unsigned int state);

  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyByName(const MaterialPropertyName & name,
                                                        MaterialData & material_data,
                                                        const unsigned int state = 0)
  {
    return getGenericMaterialPropertyByName<T, false>(name, material_data, state);
  }

  template <typename T>
  const ADMaterialProperty<T> & getADMaterialPropertyByName(const MaterialPropertyName & name,
                                                            MaterialData & material_data)
  {
    return getGenericMaterialPropertyByName<T, true>(name, material_data, 0);
  }

  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOld(const std::string & name,
                                                     MaterialData & material_data)
  {
    return getMaterialProperty<T>(name, material_data, 1);
  }

  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlder(const std::string & name,
                                                       MaterialData & material_data)
  {
    return getMaterialProperty<T>(name, material_data, 2);
  }

  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOldByName(const MaterialPropertyName & name,
                                                           MaterialData & material_data)
  {
    return getMaterialPropertyByName<T>(name, material_data, 1);
  }

  template <typename T>
  const MaterialProperty<T> & getMaterialPropertyOlderByName(const MaterialPropertyName & name,
                                                             MaterialData & material_data)
  {
    return getMaterialPropertyByName<T>(name, material_data, 2);
  }

private:
  const MooseObject & _mi_moose_object;

protected:
  const InputParameters & _mi_params;

  const std::string _mi_name;

  const MooseObjectName _mi_moose_object_name;

  FEProblemBase & _mi_feproblem;

  SubProblem & _mi_subproblem;

  const THREAD_ID _mi_tid;

  const Moose::MaterialDataType _material_data_type;

  MaterialData & _material_data;

  virtual void checkMaterialProperty(const std::string & name, const unsigned int state);

  void markMatPropRequested(const std::string &);

  MaterialPropertyName getMaterialPropertyName(const std::string & name) const;

  template <typename T, bool is_ad>
  const GenericMaterialProperty<T, is_ad> *
  defaultGenericMaterialProperty(const std::string & name);
  template <typename T>
  const MaterialProperty<T> * defaultMaterialProperty(const std::string & name)
  {
    return defaultGenericMaterialProperty<T, false>(name);
  }
  template <typename T>
  const ADMaterialProperty<T> * defaultADMaterialProperty(const std::string & name)
  {
    return defaultGenericMaterialProperty<T, true>(name);
  }

  void checkExecutionStage();

  bool _stateful_allowed;

  bool _get_material_property_called;

  std::vector<std::unique_ptr<PropertyValue>> _default_properties;

  std::unordered_set<unsigned int> _material_property_dependencies;

  const MaterialPropertyName _get_suffix;

  const bool _use_interpolated_state;

  static const std::string _interpolated_old;
  static const std::string _interpolated_older;

private:
  Moose::MaterialDataType getMaterialDataType(const std::set<BoundaryID> & boundary_ids) const;

  /*
   * A proxy method for _mi_feproblem.getMaxQps()
   */
  unsigned int getMaxQps() const;

  /*
   * A proxy method for _mi_feproblem.addConsumedPropertyName()
   */
  void addConsumedPropertyName(const MooseObjectName & obj_name, const std::string & prop_name);

  const bool _mi_boundary_restricted;

  const std::set<SubdomainID> & _mi_block_ids;

  const std::set<BoundaryID> & _mi_boundary_ids;

  std::vector<std::unique_ptr<OptionalMaterialPropertyProxyBase<MaterialPropertyInterface>>>
      _optional_property_proxies;
};

template <class M, typename T, bool is_ad>
class OptionalMaterialPropertyProxy : public OptionalMaterialPropertyProxyBase<M>
{
public:
  OptionalMaterialPropertyProxy(const std::string & name, const unsigned int state)
    : OptionalMaterialPropertyProxyBase<M>(name, state)
  {
  }
  const GenericOptionalMaterialProperty<T, is_ad> & value() const { return _value; }
  void resolve(M & mpi) override
  {
    if (mpi.template hasGenericMaterialProperty<T, is_ad>(this->_name))
    {
      if constexpr (is_ad)
        if (this->_state > 0)
          mooseError("Non-current (state > 0) material properties are not available as AD");

      _value.set(&mpi.template getGenericMaterialProperty<T, is_ad>(this->_name, this->_state));
    }
  }

private:
  GenericOptionalMaterialProperty<T, is_ad> _value;
};

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> *
MaterialPropertyInterface::defaultGenericMaterialProperty(const std::string & name)
{
  if constexpr (std::is_same_v<T, Real> || std::is_same_v<T, RealVectorValue>)
  {
    std::istringstream ss(name);
    Real real_value;

    // check if the string parsed cleanly into a Real number
    if (ss >> real_value && ss.eof())
    {
      using prop_type = GenericMaterialProperty<T, is_ad>;

      const auto nqp = Moose::constMaxQpsPerElem;
      auto & property =
          _default_properties.emplace_back(std::make_unique<prop_type>(default_property_id));
      auto & T_property = static_cast<prop_type &>(*property);

      T_property.resize(nqp);
      for (const auto qp : make_range(nqp))
        T_property[qp] = real_value;

      return &T_property;
    }
  }

  return nullptr;
}

template <typename T>
std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>
MaterialPropertyInterface::getBlockMaterialProperty(const MaterialPropertyName & name_in)
{
  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  if (_mi_block_ids.empty())
    mooseError("getBlockMaterialProperty must be called by a block restrictable object");

  using pair_type = std::pair<const MaterialProperty<T> *, std::set<SubdomainID>>;

  if (!hasMaterialPropertyByName<T>(name))
    return pair_type(nullptr, {});

  // Call first so that the ID gets registered
  const auto & prop = _material_data.getProperty<T, false>(name, 0, _mi_moose_object);
  auto blocks = getMaterialPropertyBlocks(name);
  auto prop_blocks_pair = pair_type(&prop, std::move(blocks));

  _material_property_dependencies.insert(_material_data.getPropertyId(name));

  // Update consumed properties in MaterialPropertyDebugOutput
  addConsumedPropertyName(_mi_moose_object_name, name);

  return prop_blocks_pair;
}

template <typename T>
bool
MaterialPropertyInterface::hasMaterialProperty(const std::string & name)
{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasMaterialPropertyByName<T>(prop_name);
}

template <typename T>
bool
MaterialPropertyInterface::hasMaterialPropertyByName(const std::string & name_in)
{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveProperty<T>(name);
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericZeroMaterialProperty(const std::string & name)
{
  const auto prop_name = getMaterialPropertyName(name);
  return getGenericZeroMaterialPropertyByName<T, is_ad>(prop_name);
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericZeroMaterialPropertyByName(const std::string & prop_name)
{
  // if found return the requested property
  if (hasGenericMaterialPropertyByName<T, is_ad>(prop_name))
    return getGenericMaterialPropertyByName<T, is_ad>(prop_name);

  return getGenericZeroMaterialProperty<T, is_ad>();
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericZeroMaterialProperty()
{
  // static zero property storage
  static GenericMaterialProperty<T, is_ad> zero(zero_property_id);

  // resize to accomodate maximum number of qpoints
  // (in multiapp scenarios getMaxQps can return different values in each app; we need the max)
  unsigned int nqp = getMaxQps();
  if (nqp > zero.size())
    zero.resize(nqp);

  // set values for all qpoints to zero
  for (unsigned int qp = 0; qp < nqp; ++qp)
    MathUtils::mooseSetToZero(zero[qp]);

  return zero;
}

template <typename T>
bool
MaterialPropertyInterface::hasADMaterialProperty(const std::string & name)
{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);
  return hasADMaterialPropertyByName<T>(prop_name);
}

template <typename T>
bool
MaterialPropertyInterface::hasADMaterialPropertyByName(const std::string & name_in)
{
  const auto name = _get_suffix.empty()
                        ? name_in
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");
  return _material_data.haveADProperty<T>(name);
}

template <typename T, bool is_ad>
const GenericOptionalMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericOptionalMaterialProperty(const std::string & name,
                                                              const unsigned int state)
{
  auto proxy = std::make_unique<OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>>(
      name, state);
  auto & optional_property = proxy->value();
  _optional_property_proxies.push_back(std::move(proxy));
  return optional_property;
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getPossiblyConstantGenericMaterialPropertyByName(
    const MaterialPropertyName & prop_name, MaterialData & material_data, const unsigned int state)
{
  // Check if it's just a constant
  if (const auto * default_property = defaultGenericMaterialProperty<T, is_ad>(prop_name))
    return *default_property;

  if (state > 0 && !_stateful_allowed)
    mooseError("Stateful material properties not allowed for this object."
               " State ",
               state,
               " property for \"",
               prop_name,
               "\" was requested.");

  return this->getGenericMaterialPropertyByName<T, is_ad>(prop_name, material_data, state);
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericMaterialProperty(const std::string & name,
                                                      MaterialData & material_data,
                                                      const unsigned int state)
{
  // Check if the supplied parameter is a valid input parameter key
  const auto prop_name = getMaterialPropertyName(name);

  return getPossiblyConstantGenericMaterialPropertyByName<T, is_ad>(
      prop_name, material_data, state);
}

template <typename T, bool is_ad>
const GenericMaterialProperty<T, is_ad> &
MaterialPropertyInterface::getGenericMaterialPropertyByName(const MaterialPropertyName & name_in,
                                                            MaterialData & material_data,
                                                            const unsigned int state)
{
  if (_use_interpolated_state)
  {
    if (state == 1)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_old, material_data, 0);
    if (state == 2)
      return getGenericMaterialPropertyByName<T, is_ad>(
          name_in + _interpolated_older, material_data, 0);
  }

  const auto name = _get_suffix.empty()
                        ? static_cast<const std::string &>(name_in)
                        : MooseUtils::join(std::vector<std::string>({name_in, _get_suffix}), "_");

  checkExecutionStage();
  checkMaterialProperty(name, state);

  // mark property as requested
  markMatPropRequested(name);

  // Update the boolean flag.
  _get_material_property_called = true;

  // Call first so that the ID gets registered
  auto & prop = material_data.getProperty<T, is_ad>(name, state, _mi_moose_object);

  // Does the material data used here matter?
  _material_property_dependencies.insert(material_data.getPropertyId(name));

  if (state == 0)
    addConsumedPropertyName(_mi_moose_object_name, name);

  return prop;
}