PlasticVorticity.cxx

// 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.
 
#include "neml2/models/solid_mechanics/crystal_plasticity/PlasticVorticity.h"
#include "neml2/models/crystallography/CrystalGeometry.h"
 
#include "neml2/tensors/tensors.h"
#include "neml2/tensors/list_tensors.h"
 
namespace neml2
{
register_NEML2_object(PlasticVorticity);
 
OptionSet
PlasticVorticity::expected_options()
{
  OptionSet options = Model::expected_options();
 
  options.doc() = "Caclulates the plastic vorcitity as \\f$ w^p = \\sum_{i=1}^{n_{slip}} "
                  "\\dot{\\gamma}_i Q \\operatorname{skew}{\\left(d_i \\otimes n_i \\right)} Q^T "
                  "\\f$ with \\f$ d^p \\f$ the plastic deformation rate, \\f$ \\dot{\\gamma}_i "
                  "\\f$ the slip rate on the ith slip system, \\f$Q \\f$ the orientation, \\f$ d_i "
                  "\\f$ the slip system direction, and \\f$ n_i \\f$ the slip system normal.";
 
  options.set<VariableName>("plastic_vorticity") =
      VariableName("state", "internal", "plastic_vorticity");
  options.set("plastic_vorticity").doc() = "The name of the plastic vorticity tensor";
 
  options.set<VariableName>("orientation") = VariableName("state", "orientation_matrix");
  options.set("orientation").doc() = "The name of the orientation matrix tensor";
 
  options.set<VariableName>("slip_rates") = VariableName("state", "internal", "slip_rates");
  options.set("slip_rates").doc() = "The name of the tensor containg the current slip rates";
 
  options.set<std::string>("crystal_geometry_name") = "crystal_geometry";
  options.set("crystal_geometry_name").doc() =
      "The name of the Data object containing the crystallographic information for the material";
 
  return options;
}
 
PlasticVorticity::PlasticVorticity(const OptionSet & options)
  : Model(options),
    _crystal_geometry(register_data<crystallography::CrystalGeometry>(
        options.get<std::string>("crystal_geometry_name"))),
    _Wp(declare_output_variable<WR2>("plastic_vorticity")),
    _R(declare_input_variable<R2>("orientation")),
    _gamma_dot(declare_input_variable_list<Scalar>(_crystal_geometry.nslip(), "slip_rates"))
{
}
 
void
PlasticVorticity::set_value(bool out, bool dout_din, bool d2out_din2)
{
  neml_assert_dbg(!d2out_din2, "Second derivative not implemented.");
 
  const auto Wp_crystal = (Scalar(_gamma_dot.value()) * _crystal_geometry.W()).list_sum();
 
  if (out)
    _Wp = Wp_crystal.rotate(R2(_R));
 
  if (dout_din)
  {
    _Wp.d(_gamma_dot) =
        BatchTensor(_crystal_geometry.W().rotate(R2(_R).batch_unsqueeze(-1)), batch_dim())
            .base_transpose(-1, -2);
    _Wp.d(_R) = Wp_crystal.drotate(R2(_R));
  }
}
} // namespace neml2