SSR4.h

// Copyright 2024, 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/PrimitiveTensor.h"
 
namespace neml2
{
class Scalar;
class SR2;
class R4;
class SSFR5;
class Rot;
class SSSSR8;
 
class SSR4 : public PrimitiveTensor<SSR4, 6, 6>
{
public:
  using PrimitiveTensor<SSR4, 6, 6>::PrimitiveTensor;
 
  SSR4(const R4 & T);
 
  [[nodiscard]] static SSR4
  identity(const torch::TensorOptions & options = default_tensor_options());
  static SSR4 identity_sym(const torch::TensorOptions & options = default_tensor_options());
  static SSR4 identity_vol(const torch::TensorOptions & options = default_tensor_options());
  static SSR4 identity_dev(const torch::TensorOptions & options = default_tensor_options());
 
  static SSR4 identity_C1(const torch::TensorOptions & options = default_tensor_options());
  static SSR4 identity_C2(const torch::TensorOptions & options = default_tensor_options());
  static SSR4 identity_C3(const torch::TensorOptions & options = default_tensor_options());
 
  static SSR4 isotropic_E_nu(const Scalar & E, const Scalar & nu);
  static SSR4 isotropic_E_nu(const Real & E,
                             const Real & nu,
                             const torch::TensorOptions & options = default_tensor_options());
 
  static SSR4 fill_C1_C2_C3(const Scalar & C1, const Scalar & C2, const Scalar & C3);
  static SSR4 fill_C1_C2_C3(const Real & C1,
                            const Real & C2,
                            const Real & C3,
                            const torch::TensorOptions & options = default_tensor_options());
 
  [[nodiscard]] static SSSSR8
  identity_map(const torch::TensorOptions & options = default_tensor_options());
 
  SSR4 rotate(const Rot & r) const;
 
  SSFR5 drotate(const Rot & r) const;
 
  SSSSR8 drotate_self(const Rot & r) const;
 
  Scalar operator()(Size i, Size j, Size k, Size l) const;
 
  SSR4 inverse() const;
 
  SSSSR8 dinverse() const;
 
  SSR4 transpose_minor() const;
 
  SSR4 transpose_major() const;
};
 
SR2 operator*(const SSR4 & a, const SR2 & b);
SR2 operator*(const SR2 & a, const SSR4 & b);
SSR4 operator*(const SSR4 & a, const SSR4 & b);
} // namespace neml2