VoceIsotropicHardening.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/VoceIsotropicHardening.h"
 
namespace neml2
{
register_NEML2_object(VoceIsotropicHardening);
 
OptionSet
VoceIsotropicHardening::expected_options()
{
  OptionSet options = IsotropicHardening::expected_options();
  options.doc() = "Voce isotropic hardening model, \\f$ h = R \\left[ 1 - \\exp(-d \\varepsilon_p) "
                  "\\right] \\f$, where \\f$ R \\f$ is the isotropic hardening upon saturation, "
                  "and \\f$ d \\f$ is the hardening rate.";
 
  options.set<CrossRef<Scalar>>("saturated_hardening");
  options.set("saturated_hardening").doc() = "Saturated isotropic hardening";
 
  options.set<CrossRef<Scalar>>("saturation_rate");
  options.set("saturation_rate").doc() = "Hardening saturation rate";
 
  return options;
}
 
VoceIsotropicHardening::VoceIsotropicHardening(const OptionSet & options)
  : IsotropicHardening(options),
    _R(declare_parameter<Scalar>("R", "saturated_hardening")),
    _d(declare_parameter<Scalar>("d", "saturation_rate"))
{
}
 
void
VoceIsotropicHardening::set_value(bool out, bool dout_din, bool d2out_din2)
{
  if (out)
    _h = _R * (-math::exp(-_d * _ep) + 1.0);
 
  if (dout_din)
    _h.d(_ep) = _R * _d * math::exp(-_d * _ep);
 
  if (d2out_din2)
    _h.d(_ep, _ep) = -_R * _d * _d * math::exp(-_d * _ep);
}
} // namespace neml2