symmetrization.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 <array>
 
#include "neml2/misc/types.h"
#include "neml2/misc/defaults.h"
#include "neml2/misc/errors.h"
 
namespace neml2
{
class Tensor;
 
constexpr std::array<std::array<Size, 3>, 3> mandel_reverse_index{
    std::array<Size, 3>{0, 5, 4}, std::array<Size, 3>{5, 1, 3}, std::array<Size, 3>{4, 3, 2}};
constexpr std::array<std::array<Size, 2>, 6> mandel_index{std::array<Size, 2>{0, 0},
                                                          std::array<Size, 2>{1, 1},
                                                          std::array<Size, 2>{2, 2},
                                                          std::array<Size, 2>{1, 2},
                                                          std::array<Size, 2>{0, 2},
                                                          std::array<Size, 2>{0, 1}};
 
constexpr std::array<std::array<Size, 3>, 3> skew_reverse_index{
    std::array<Size, 3>{0, 2, 1}, std::array<Size, 3>{2, 0, 0}, std::array<Size, 3>{1, 0, 0}};
constexpr std::array<std::array<double, 3>, 3> skew_factor{std::array<double, 3>{0.0, -1.0, 1.0},
                                                           std::array<double, 3>{1.0, 0.0, -1.0},
                                                           std::array<double, 3>{-1.0, 1.0, 0.0}};
 
inline constexpr double
mandel_factor(Size i)
{
  if (i < 0 || i >= 6)
    throw NEMLException("Mandel factor index out of range: " + std::to_string(i));
  return i < 3 ? 1.0 : sqrt2;
}
 
Tensor full_to_mandel(const Tensor & full, Size dim = 0);
 
Tensor mandel_to_full(const Tensor & mandel, Size dim = 0);
 
Tensor full_to_skew(const Tensor & full, Size dim = 0);
 
Tensor skew_to_full(const Tensor & skew, Size dim = 0);
 
namespace details
{
Tensor
full_to_reduced(const Tensor & full, const Tensor & rmap, const Tensor & rfactors, Size dim = 0);
 
Tensor
reduced_to_full(const Tensor & reduced, const Tensor & rmap, const Tensor & rfactors, Size dim = 0);
 
const Tensor & full_to_mandel_map(const TensorOptions & opt = default_integer_tensor_options());
const Tensor & mandel_to_full_map(const TensorOptions & opt = default_integer_tensor_options());
 
const Tensor & full_to_mandel_factor(const TensorOptions & opt = default_tensor_options());
const Tensor & mandel_to_full_factor(const TensorOptions & opt = default_tensor_options());
 
const Tensor & full_to_skew_map(const TensorOptions & opt = default_integer_tensor_options());
const Tensor & skew_to_full_map(const TensorOptions & opt = default_integer_tensor_options());
 
const Tensor & full_to_skew_factor(const TensorOptions & opt = default_tensor_options());
const Tensor & skew_to_full_factor(const TensorOptions & opt = default_tensor_options());
} // namespace details
} // namespace neml2