NEML2Utils.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 <string>

#ifdef NEML2_ENABLED

#include "neml2/tensors/tensors.h"
#include "neml2/base/Factory.h"
#include "neml2/models/Model.h"
#include "RankTwoTensor.h"
#include "RankFourTensor.h"
#include "SymmetricRankTwoTensor.h"
#include "SymmetricRankFourTensor.h"
#include "MaterialProperty.h"

#endif

class MooseObject;
class Action;
class SubProblem;

namespace NEML2Utils
{
#ifdef NEML2_ENABLED

enum class MOOSEIOType
{
  // unbatched
  TIME,
  SCALAR,
  // batched
  FUNCTION,
  VARIABLE,
  MATERIAL
};

std::string stringify(MOOSEIOType type);

std::shared_ptr<neml2::Model>
getModel(neml2::Factory & factory, const std::string & name, neml2::Dtype dtype = neml2::kFloat64);

template <typename T>
struct Layout
{
};
template <>
struct Layout<Real>
{
  static constexpr std::array<neml2::Size, 0> shape{};
  static constexpr std::array<neml2::Size, 1> strides{1};
};
template <>
struct Layout<RealVectorValue>
{
  static constexpr std::array<neml2::Size, 1> shape{3};
  static constexpr std::array<neml2::Size, 2> strides{3, 1};
};
template <>
struct Layout<RankTwoTensor>
{
  static constexpr std::array<neml2::Size, 2> shape{3, 3};
  static constexpr std::array<neml2::Size, 3> strides{9, 3, 1};
};
template <>
struct Layout<SymmetricRankTwoTensor>
{
  static constexpr std::array<neml2::Size, 1> shape{6};
  static constexpr std::array<neml2::Size, 2> strides{6, 1};
};
template <>
struct Layout<RankFourTensor>
{
  static constexpr std::array<neml2::Size, 4> shape{3, 3, 3, 3};
  static constexpr std::array<neml2::Size, 5> strides{81, 27, 9, 3, 1};
};
template <>
struct Layout<SymmetricRankFourTensor>
{
  static constexpr std::array<neml2::Size, 2> shape{6, 6};
  static constexpr std::array<neml2::Size, 3> strides{36, 6, 1};
};

template <typename T>
neml2::Tensor
fromBlob(const std::vector<T> & data)
{
  // The const_cast is fine because torch works with non-const ptr so that it can optionally handle
  // deallocation. But we are not going to let torch do that.
  const auto torch_tensor = at::from_blob(const_cast<T *>(data.data()),
                                          neml2::utils::add_shapes(data.size(), Layout<T>::shape),
                                          at::TensorOptions().dtype(neml2::kFloat64));
  return neml2::Tensor(torch_tensor, 1);
}

template <typename T>
void
copyTensorToMOOSEData(const at::Tensor & src, T & dest)
{
  if (src.dtype() != neml2::kFloat64)
    mooseError(
        "Cannot copy at::Tensor with dtype ", src.dtype(), " into ", demangle(typeid(T).name()));
  if (src.numel() != Layout<T>::strides[0])
    mooseError("Cannot copy at::Tensor with shape ",
               src.sizes(),
               " into ",
               demangle(typeid(T).name()),
               " with different number of elements.");
  auto dest_tensor = at::from_blob(reinterpret_cast<Real *>(&dest),
                                   Layout<T>::shape,
                                   at::TensorOptions().dtype(neml2::kFloat64));
  dest_tensor.copy_(src.reshape(Layout<T>::shape));
}

static std::string NEML2_help_message = R""""(
==============================================================================
To debug NEML2 related issues:
1. Build and run MOOSE in dbg mode.
2. Re-run the simulation using the dbg executable, and often times
   NEML2 will provide a more helpful error message.
3. If the error message is not helpful, or if there is still no error message,
   run the simulation through a debugger: See
   https://mooseframework.inl.gov/application_development/debugging.html
4. If the issue is due to a NEML2 bug, feel free to report it at
   https://github.com/applied-material-modeling/neml2/issues
==============================================================================
)"""";

#endif // NEML2_ENABLED

bool shouldCompute(const SubProblem &);

std::string docstring(const std::string & desc);

void assertNEML2Enabled();

} // namespace NEML2Utils