feresulttypes.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021-2024 The Ikarus Developers mueller@ibb.uni-stuttgart.de
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#pragma once
 
#include <type_traits>
 
#include <Eigen/Core>
 
#include <ikarus/utils/tensorutils.hh>
 
namespace Ikarus {
namespace Impl {
 
  template <bool strainlike = false>
  struct VectorizeWithVoigt
  {
    template <typename Derived>
    static auto transform(const Eigen::DenseBase<Derived>& mat) {
      return toVoigt(mat.derived(), strainlike);
    }
  };
 
  struct VectorizeGeneric
  {
    template <typename Derived>
    static auto transform(const Eigen::DenseBase<Derived>& mat) {
      return mat.derived().reshaped().eval();
    }
  };
 
  template <bool strainlike = false>
  struct MatricizeWithVoigt
  {
    template <typename Derived, int RowsAtCompileTime, int ColsAtCompileTime>
    static auto transform(const Eigen::DenseBase<Derived>& vec, int rows = RowsAtCompileTime,
                          int cols = ColsAtCompileTime) {
      assert(rows == RowsAtCompileTime && cols == ColsAtCompileTime &&
             "Only the fixed size values work for voigt matrices and vectors");
      static_assert(RowsAtCompileTime != Eigen::Dynamic and ColsAtCompileTime != Eigen::Dynamic,
                    "Voigt notation only available for fixed size vectors and matrices");
      return fromVoigt(vec.derived(), strainlike);
    }
  };
 
  struct MatricizeGeneric
  {
    template <typename Derived, int RowsAtCompileTime, int ColsAtCompileTime>
    static auto transform(const Eigen::DenseBase<Derived>& vec, int rows = RowsAtCompileTime,
                          int cols = ColsAtCompileTime) {
      return vec.derived().reshaped(Eigen::fix<RowsAtCompileTime>(rows), Eigen::fix<ColsAtCompileTime>(cols)).eval();
    }
  };
 
} // namespace Impl
 
namespace ResultTypes {
#define REGISTER_RESULTTYPE_IMPL(resultTypeName, rowsExpr, colsExpr, MaxRowsExpr, MaxColsExpr, VectorizeStruct, \
                                 MatricizeStruct)                                                               \
  template <typename ScalarType, int gridDim, int worldDim>                                                     \
  struct resultTypeName                                                                                         \
  {                                                                                                             \
    friend std::string toString(resultTypeName) { return #resultTypeName; }                                     \
                                                                                                                \
    using type       = Eigen::Matrix<ScalarType, rowsExpr, colsExpr, 0, MaxRowsExpr, MaxColsExpr>;              \
    using Vectorizer = VectorizeStruct;                                                                         \
    using Matricizer = MatricizeStruct;                                                                         \
                                                                                                                \
    template <typename ScalarType_, int gridDim_, int worldDim_>                                                \
    using Rebind = resultTypeName<ScalarType_, gridDim_, worldDim_>;                                            \
  }
 
#define REGISTER_SIMPLE_SYMMETRIC_RESULTTYPE(resultTypeName, rowsExpr, colsExpr, strainlike) \
  REGISTER_RESULTTYPE_IMPL(resultTypeName, rowsExpr, colsExpr, rowsExpr, colsExpr,           \
                           Ikarus::Impl::VectorizeWithVoigt<strainlike>, Ikarus::Impl::MatricizeWithVoigt<strainlike>)
 
#define REGISTER_RESULTTYPE(resultTypeName, rowsExpr, colsExpr)                                \
  REGISTER_RESULTTYPE_IMPL(resultTypeName, rowsExpr, colsExpr, Ikarus::Impl::VectorizeGeneric, \
                           Ikarus::Impl::MatricizeGeneric)
#define REGISTER_RESERVED_RESULTTYPE(resultTypeName, rowsExpr, colsExpr, MaxRowsExpr, MaxColsExpr) \
  REGISTER_RESULTTYPE_IMPL(resultTypeName, rowsExpr, colsExpr, MaxRowsExpr, MaxColsExpr,           \
                           Ikarus::Impl::VectorizeGeneric, Ikarus::Impl::MatricizeGeneric)
#define REGISTER_SIMPLE_RESULTTYPE(resultTypeName, rowsExpr, colsExpr) \
  REGISTER_RESERVED_RESULTTYPE(resultTypeName, rowsExpr, colsExpr, rowsExpr, colsExpr)
 
 
  REGISTER_SIMPLE_SYMMETRIC_RESULTTYPE(linearStress, worldDim, worldDim, false);
  REGISTER_SIMPLE_SYMMETRIC_RESULTTYPE(PK2Stress, worldDim, worldDim, false);
  REGISTER_SIMPLE_SYMMETRIC_RESULTTYPE(cauchyStress, worldDim, worldDim, false);
 
  REGISTER_SIMPLE_RESULTTYPE(director, worldDim, 1);
  REGISTER_SIMPLE_RESULTTYPE(magnetization, worldDim, 1);
  REGISTER_SIMPLE_RESULTTYPE(gradientNormOfMagnetization, 1, 1);
  REGISTER_SIMPLE_RESULTTYPE(vectorPotential, worldDim, 1);
  REGISTER_SIMPLE_RESULTTYPE(divergenceOfVectorPotential, 1, 1);
 
  REGISTER_SIMPLE_RESULTTYPE(BField, worldDim, 1);
  REGISTER_SIMPLE_RESULTTYPE(HField, worldDim, 1);
 
  REGISTER_SIMPLE_RESULTTYPE(customType, Eigen::Dynamic, Eigen::Dynamic);
} // namespace ResultTypes
 
enum class ResultShape
{
  Vector,
  Matrix
};
 
template <typename RT, ResultShape storedResultShape = ResultShape::Vector>
struct ResultWrapper : RT
{
private:
  using ResultTypeValueType                       = typename RT::type;
  static constexpr Eigen::Index rowsAtCompileTime = ResultTypeValueType::RowsAtCompileTime;
  static constexpr Eigen::Index colsAtCompileTime = ResultTypeValueType::ColsAtCompileTime;
  static constexpr bool storedValueIsVector       = storedResultShape == ResultShape::Vector;
 
public:
  using VecType = std::invoke_result_t<decltype(&RT::Vectorizer::template transform<ResultTypeValueType>),
                                       const ResultTypeValueType&>;
  using MatType =
      std::invoke_result_t<decltype(&RT::Matricizer::template transform<VecType, rowsAtCompileTime, colsAtCompileTime>),
                           const VecType&, int, int>;
  using StoredType = std::conditional_t<storedValueIsVector, VecType, MatType>;
  using ResultType = RT;
 
  auto asVec() const {
    if constexpr (storedValueIsVector)
      return value_;
    else
      return RT::Vectorizer::transform(value_);
  }
 
  auto asMat(Eigen::Index rows = rowsAtCompileTime, Eigen::Index cols = colsAtCompileTime) const {
    if constexpr (storedValueIsVector) {
      if constexpr (rowsAtCompileTime == Eigen::Dynamic)
        assert(rows != rowsAtCompileTime &&
               "For dynamic size result types you have to pass rows by hand, since it is not clear how the result "
               "should be reshaped");
      if constexpr (colsAtCompileTime == Eigen::Dynamic)
        assert(cols != colsAtCompileTime &&
               "For dynamic size result types you have to pass cols by hand, since it is not clear how the result "
               "should be reshaped");
      return RT::Matricizer::template transform<VecType, rowsAtCompileTime, colsAtCompileTime>(value_, rows, cols);
    } else
      return value_;
  }
  explicit ResultWrapper() = default;
  explicit ResultWrapper(StoredType&& value) { this->value_ = std::move(value); }
  explicit ResultWrapper(const StoredType& value) { this->value_ = value; }
  ResultWrapper& operator=(const StoredType& value) {
    this->value_ = value;
    return *this;
  }
  ResultWrapper& operator=(StoredType&& value) {
    this->value_ = std::move(value);
    return *this;
  }
 
private:
  StoredType value_{};
};
 
namespace Impl {
  template <template <typename, int, int> class RT>
  using DummyRT = RT<double, 1, 1>;
}
 
template <template <typename, int, int> class RT>
auto makeRT() {
  return Impl::DummyRT<RT>{};
}
 
template <template <typename, int, int> class RT>
auto toString() {
  return toString(Impl::DummyRT<RT>{});
}
 
template <template <typename, int, int> class RT1, template <typename, int, int> class RT2>
constexpr bool isSameResultType = std::is_same_v<Impl::DummyRT<RT1>, Impl::DummyRT<RT2>>;
 
} // namespace Ikarus