R2Base.h

// Copyright 2023, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/tensors/FixedDimTensor.h"
 
namespace neml2
{
class Scalar;
class Vec;
class SR2;
class R3;
class R4;
class Rot;
class WR2;
class R2;
 
template <class>
class VecBase;
 
template <class Derived>
class R2Base : public FixedDimTensor<Derived, 3, 3>
{
public:
  using FixedDimTensor<Derived, 3, 3>::FixedDimTensor;
 
  explicit operator SR2() const;
 
  [[nodiscard]] static Derived
  fill(const Real & a, const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived fill(const Scalar & a);
  [[nodiscard]] static Derived
  fill(const Real & a11,
       const Real & a22,
       const Real & a33,
       const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived fill(const Scalar & a11, const Scalar & a22, const Scalar & a33);
  [[nodiscard]] static Derived
  fill(const Real & a11,
       const Real & a22,
       const Real & a33,
       const Real & a23,
       const Real & a13,
       const Real & a12,
       const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived fill(const Scalar & a11,
                                    const Scalar & a22,
                                    const Scalar & a33,
                                    const Scalar & a23,
                                    const Scalar & a13,
                                    const Scalar & a12);
  [[nodiscard]] static Derived
  fill(const Real & a11,
       const Real & a12,
       const Real & a13,
       const Real & a21,
       const Real & a22,
       const Real & a23,
       const Real & a31,
       const Real & a32,
       const Real & a33,
       const torch::TensorOptions & options = default_tensor_options());
  [[nodiscard]] static Derived fill(const Scalar & a11,
                                    const Scalar & a12,
                                    const Scalar & a13,
                                    const Scalar & a21,
                                    const Scalar & a22,
                                    const Scalar & a23,
                                    const Scalar & a31,
                                    const Scalar & a32,
                                    const Scalar & a33);
  [[nodiscard]] static Derived skew(const Vec & v);
  [[nodiscard]] static Derived
  identity(const torch::TensorOptions & options = default_tensor_options());
 
  Derived rotate(const Rot & r) const;
 
  Derived rotate(const R2 & R) const;
 
  R3 drotate(const Rot & r) const;
 
  R4 drotate(const R2 & R) const;
 
  Scalar operator()(TorchSize i, TorchSize j) const;
 
  Derived inverse() const;
 
  Derived transpose() const;
};
 
// TODO: Fix the return type
template <class Derived1,
          class Derived2,
          typename = typename std::enable_if_t<std::is_base_of_v<R2Base<Derived1>, Derived1>>,
          typename = typename std::enable_if_t<std::is_base_of_v<VecBase<Derived2>, Derived2>>>
Vec operator*(const Derived1 & A, const Derived2 & b);
 
// TODO: Fix the return type
template <class Derived1,
          class Derived2,
          typename = typename std::enable_if_t<std::is_base_of_v<R2Base<Derived1>, Derived1>>,
          typename = typename std::enable_if_t<std::is_base_of_v<R2Base<Derived2>, Derived2>>>
R2 operator*(const Derived1 & A, const Derived2 & B);
 
} // namespace neml2