MaterialProperty.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

#include <vector>
#include <memory>
#include <typeinfo>

#include "MooseArray.h"
#include "MooseTypes.h"
#include "DataIO.h"
#include "MooseError.h"
#include "UniqueStorage.h"
#include "MooseUtils.h"

#include "libmesh/libmesh_common.h"
#include "libmesh/tensor_value.h"
#include "libmesh/vector_value.h"
#include "libmesh/int_range.h"

#include "metaphysicl/raw_type.h"

class PropertyValue;
class Material;
class MaterialPropertyInterface;

class PropertyValue
{
public:
  typedef unsigned int id_type;

  PropertyValue(const id_type id) : _id(id) {}

  virtual ~PropertyValue(){};

  static constexpr id_type invalid_property_id = std::numeric_limits<id_type>::max() - 1;

  id_type id() const { return _id; }

  virtual const std::string & type() const = 0;

  virtual std::unique_ptr<PropertyValue> clone(const std::size_t) const = 0;

  virtual unsigned int size() const = 0;

  virtual void resize(const std::size_t size) = 0;

  virtual void swap(PropertyValue & rhs) = 0;

  virtual bool isAD() const = 0;

  virtual void
  qpCopy(const unsigned int to_qp, const PropertyValue & rhs, const unsigned int from_qp) = 0;

  // save/restore in a file
  virtual void store(std::ostream & stream) = 0;
  virtual void load(std::istream & stream) = 0;

  virtual const std::type_info & typeID() const = 0;

protected:
  const id_type _id;
};

template <typename T, bool is_ad>
class MaterialPropertyBase : public PropertyValue
{
public:
  typedef Moose::GenericType<T, is_ad> value_type;

  MaterialPropertyBase(const PropertyValue::id_type id) : PropertyValue(id) {}

  bool isAD() const override final { return is_ad; }

  const MooseArray<Moose::GenericType<T, is_ad>> & get() const { return _value; }

  MooseArray<Moose::GenericType<T, is_ad>> & set() { return _value; }

  virtual const std::string & type() const override final;

  virtual void resize(const std::size_t size) override final;

  virtual unsigned int size() const override final { return _value.size(); }

  Moose::GenericType<T, is_ad> & operator[](const unsigned int i) { return _value[i]; }

  const Moose::GenericType<T, is_ad> & operator[](const unsigned int i) const { return _value[i]; }

  virtual void qpCopy(const unsigned int to_qp,
                      const PropertyValue & rhs,
                      const unsigned int from_qp) override final;

  virtual void store(std::ostream & stream) override final;

  virtual void load(std::istream & stream) override final;

  virtual void swap(PropertyValue & rhs) override final;

  const std::type_info & typeID() const override final;

  virtual std::unique_ptr<PropertyValue> clone(const std::size_t size) const override final;

private:
  MaterialPropertyBase(const MaterialPropertyBase<T, is_ad> & /*src*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

  MaterialPropertyBase<T, is_ad> & operator=(const MaterialPropertyBase<T, is_ad> & /*rhs*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

protected:
  MooseArray<Moose::GenericType<T, is_ad>> _value;
};

template <typename T>
class MaterialProperty;
template <typename T>
class ADMaterialProperty;

// ------------------------------------------------------------
// Material::Property<> class inline methods

namespace moose
{
namespace internal
{
template <typename T1, typename T2>
void
rawValueEqualityHelper(T1 & out, const T2 & in)
{
  out = MetaPhysicL::raw_value(in);
}

template <typename T1, typename T2>
void
rawValueEqualityHelper(std::vector<T1> & out, const std::vector<T2> & in)
{
  out.resize(in.size());
  for (MooseIndex(in) i = 0; i < in.size(); ++i)
    rawValueEqualityHelper(out[i], in[i]);
}

template <typename T1, typename T2, std::size_t N>
void
rawValueEqualityHelper(std::array<T1, N> & out, const std::array<T2, N> & in)
{
  for (MooseIndex(in) i = 0; i < in.size(); ++i)
    rawValueEqualityHelper(out[i], in[i]);
}
}
}

template <typename T, bool is_ad>
inline const std::string &
MaterialPropertyBase<T, is_ad>::type() const
{
  static const std::string type_name = MooseUtils::prettyCppType<T>();
  return type_name;
}

template <typename T, bool is_ad>
inline void
MaterialPropertyBase<T, is_ad>::resize(const std::size_t size)
{
  _value.template resize</*value_initalize=*/true>(size);
}

template <typename T, bool is_ad>
inline void
MaterialPropertyBase<T, is_ad>::qpCopy(const unsigned int to_qp,
                                       const PropertyValue & rhs,
                                       const unsigned int from_qp)
{
  // If we're the same
  if (rhs.isAD() == is_ad)
    _value[to_qp] =
        libMesh::cast_ptr<const MaterialPropertyBase<T, is_ad> *>(&rhs)->_value[from_qp];
  else
    moose::internal::rawValueEqualityHelper(
        _value[to_qp],
        (*libMesh::cast_ptr<const MaterialPropertyBase<T, !is_ad> *>(&rhs))[from_qp]);
}

template <typename T, bool is_ad>
inline void
MaterialPropertyBase<T, is_ad>::store(std::ostream & stream)
{
  for (const auto i : index_range(_value))
    storeHelper(stream, _value[i], nullptr);
}

template <typename T, bool is_ad>
inline void
MaterialPropertyBase<T, is_ad>::load(std::istream & stream)
{
  for (const auto i : index_range(_value))
    loadHelper(stream, _value[i], nullptr);
}

template <typename T, bool is_ad>
inline void
MaterialPropertyBase<T, is_ad>::swap(PropertyValue & rhs)
{
  mooseAssert(this->id() == rhs.id(), "Inconsistent properties");
  mooseAssert(this->typeID() == rhs.typeID(), "Inconsistent types");

  // If we're the same
  if (rhs.isAD() == is_ad)
  {
    mooseAssert(dynamic_cast<decltype(this)>(&rhs), "Expected same type is not the same");
    this->_value.swap(libMesh::cast_ptr<decltype(this)>(&rhs)->_value);
    return;
  }

  // We may call this function when doing swap between MaterialData material properties (you can
  // think of these as the current element properties) and MaterialPropertyStorage material
  // properties (these are the stateful material properties that we store for *every* element). We
  // never store ADMaterialProperty in stateful storage (e.g. MaterialPropertyStorage) for memory
  // resource reasons; instead we keep a regular MaterialProperty version of it. Hence we do have a
  // need to exchange data between the AD and regular copies which we implement below. The below
  // is obviously not a swap, for which you cannot identify a giver and receiver. Instead the below
  // has a clear giver and receiver. The giver is the object passed in as the rhs. The receiver is
  // *this* object. This directionality, although not conceptually appropriate given the method
  // name, *is* appropriate to how this method is used in practice. See shallowCopyData and
  // shallowCopyDataBack in MaterialPropertyStorage.C

  auto * different_type_prop = dynamic_cast<MaterialPropertyBase<T, !is_ad> *>(&rhs);
  mooseAssert(different_type_prop,
              "Wrong material property type T in MaterialPropertyBase<T, is_ad>::swap");

  this->resize(different_type_prop->size());
  for (const auto qp : make_range(this->size()))
    moose::internal::rawValueEqualityHelper(this->_value[qp], (*different_type_prop)[qp]);
}

template <typename T, bool is_ad>
inline const std::type_info &
MaterialPropertyBase<T, is_ad>::typeID() const
{
  static const auto & info = typeid(T);
  return info;
}

template <typename T, bool is_ad>
std::unique_ptr<PropertyValue>
MaterialPropertyBase<T, is_ad>::clone(const std::size_t size) const
{
  auto prop = std::make_unique<MaterialProperty<T>>(this->id());
  if (size)
    prop->resize(size);
  return prop;
}

template <typename T>
class MaterialProperty : public MaterialPropertyBase<T, false>
{
public:
  MaterialProperty(const PropertyValue::id_type id = PropertyValue::invalid_property_id)
    : MaterialPropertyBase<T, false>(id)
  {
  }

private:
  MaterialProperty(const MaterialProperty<T> & /*src*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

  MaterialProperty<T> & operator=(const MaterialProperty<T> & /*rhs*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }
};

template <typename T>
class ADMaterialProperty : public MaterialPropertyBase<T, true>
{
public:
  ADMaterialProperty(const PropertyValue::id_type id = PropertyValue::invalid_property_id)
    : MaterialPropertyBase<T, true>(id)
  {
  }

  using typename MaterialPropertyBase<T, true>::value_type;

private:
  ADMaterialProperty(const ADMaterialProperty<T> & /*src*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }

  ADMaterialProperty<T> & operator=(const ADMaterialProperty<T> & /*rhs*/)
  {
    mooseError("Material properties must be assigned to references (missing '&')");
  }
};

class MaterialData;
class MaterialPropertyStorage;

class MaterialProperties : public UniqueStorage<PropertyValue>
{
public:
  class WriteKey
  {
    friend class MaterialData;
    friend class MaterialPropertyStorage;
    friend void dataLoad(std::istream &, MaterialPropertyStorage &, void *);

    WriteKey() {}
    WriteKey(const WriteKey &) {}
  };

  void resizeItems(const std::size_t n_qpoints, const WriteKey)
  {
    for (const auto i : index_range(*this))
      if (auto value = queryValue(i))
        value->resize(n_qpoints);
  }

  void resize(const std::size_t size, const WriteKey)
  {
    UniqueStorage<PropertyValue>::resize(size);
  }

  void setPointer(const std::size_t i, std::unique_ptr<PropertyValue> && ptr, const WriteKey)
  {
    return UniqueStorage<PropertyValue>::setPointer(i, std::move(ptr));
  }
};

template <typename T, bool is_ad>
struct GenericMaterialPropertyStruct
{
  typedef MaterialProperty<T> type;
};

template <typename T>
struct GenericMaterialPropertyStruct<T, true>
{
  typedef ADMaterialProperty<T> type;
};

template <typename T, bool is_ad>
using GenericMaterialProperty = typename GenericMaterialPropertyStruct<T, is_ad>::type;

class GenericOptionalMaterialPropertyBase
{
public:
  virtual ~GenericOptionalMaterialPropertyBase() {}
};

template <class M, typename T, bool is_ad>
class OptionalMaterialPropertyProxy;

template <typename T, bool is_ad>
class GenericOptionalMaterialProperty : public GenericOptionalMaterialPropertyBase
{
  typedef GenericMaterialProperty<T, is_ad> P;

public:
  GenericOptionalMaterialProperty(const P * pointer) : _pointer(pointer) {}

  GenericOptionalMaterialProperty(const GenericOptionalMaterialProperty<T, is_ad> &) = delete;
  GenericOptionalMaterialProperty &
  operator=(const GenericOptionalMaterialProperty<T, is_ad> &) = delete;

  const Moose::GenericType<T, is_ad> & operator[](const unsigned int i) const
  {
    // check if the optional property is valid in debug mode
    mooseAssert(
        _pointer,
        "Attempting to access an optional material property that was not provided by any material "
        "class. Make sure to check optional material properties before using them.");
    return (*_pointer)[i];
  }

  unsigned int size() const { return (*_pointer).size(); }

  operator bool() const { return _pointer; }

  const P * get() const { return _pointer; }

private:
  GenericOptionalMaterialProperty() : _pointer(nullptr) {}

  void set(const P * pointer) { _pointer = pointer; }
  const P * _pointer;

  friend class OptionalMaterialPropertyProxy<Material, T, is_ad>;
  friend class OptionalMaterialPropertyProxy<MaterialPropertyInterface, T, is_ad>;
};

void dataStore(std::ostream & stream, PropertyValue & p, void * context);
void dataLoad(std::istream & stream, PropertyValue & p, void * context);

void dataStore(std::ostream & stream, MaterialProperties & v, void * context);
void dataLoad(std::istream & stream, MaterialProperties & v, void * context);

template <typename T>
using OptionalMaterialProperty = GenericOptionalMaterialProperty<T, false>;
template <typename T>
using OptionalADMaterialProperty = GenericOptionalMaterialProperty<T, true>;