VoceSingleSlipHardeningRule.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/VoceSingleSlipHardeningRule.h"
 
namespace neml2
{
register_NEML2_object(VoceSingleSlipHardeningRule);
 
OptionSet
VoceSingleSlipHardeningRule::expected_options()
{
  OptionSet options = SingleSlipHardeningRule::expected_options();
  options.doc() = "Voce hardening for a SingleSlipStrength type model defined by \\f$ \\dot{\\tau} "
                  "= \\theta_0 \\left( 1 - \\frac{\\tau}{\\tau_f} \\right) "
                  "\\sum_{i=1}^{n_{slip}} \\left| \\dot{\\gamma}_i \\right| \\f$ where \\f$ "
                  "\\theta_0 \\f$ is the initial rate of work hardening, \\f$ \\tau_f \\f$ is the "
                  "saturated, maximum value of the slip system strength, and \\f$ \\dot{\\gamma}_i "
                  "\\f$ is the slip rate on each system.";
 
  options.set<CrossRef<Scalar>>("initial_slope");
  options.set("initial_slope").doc() = "The initial rate of hardening";
  options.set<CrossRef<Scalar>>("saturated_hardening");
  options.set("saturated_hardening").doc() =
      "The final, saturated value of the slip system strength";
  return options;
}
 
VoceSingleSlipHardeningRule::VoceSingleSlipHardeningRule(const OptionSet & options)
  : SingleSlipHardeningRule(options),
    _theta_0(declare_parameter<Scalar>("initial_slope", "initial_slope")),
    _tau_f(declare_parameter<Scalar>("saturated_hardening", "saturated_hardening"))
{
}
 
void
VoceSingleSlipHardeningRule::set_value(bool out, bool dout_din, bool d2out_din2)
{
  neml_assert_dbg(!d2out_din2, "Second derivative not implemented.");
 
  if (out)
    _tau_dot = _theta_0 * (1 - _tau / _tau_f) * _gamma_dot_sum;
 
  if (dout_din)
  {
    _tau_dot.d(_tau) = -_theta_0 / _tau_f * _gamma_dot_sum;
    _tau_dot.d(_gamma_dot_sum) = _theta_0 * (1 - _tau / _tau_f);
  }
}
} // namespace neml2