Line data    Source code

       1              : // Copyright 2024, UChicago Argonne, LLC
       2              : // All Rights Reserved
       3              : // Software Name: NEML2 -- the New Engineering material Model Library, version 2
       4              : // By: Argonne National Laboratory
       5              : // OPEN SOURCE LICENSE (MIT)
       6              : //
       7              : // Permission is hereby granted, free of charge, to any person obtaining a copy
       8              : // of this software and associated documentation files (the "Software"), to deal
       9              : // in the Software without restriction, including without limitation the rights
      10              : // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
      11              : // copies of the Software, and to permit persons to whom the Software is
      12              : // furnished to do so, subject to the following conditions:
      13              : //
      14              : // The above copyright notice and this permission notice shall be included in
      15              : // all copies or substantial portions of the Software.
      16              : //
      17              : // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
      18              : // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
      19              : // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
      20              : // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
      21              : // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
      22              : // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
      23              : // THE SOFTWARE.
      24              : 
      25              : #include "neml2/models/solid_mechanics/crystal_plasticity/SingleSlipStrengthMap.h"
      26              : #include "neml2/tensors/Scalar.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : register_NEML2_object(SingleSlipStrengthMap);
      31              : 
      32              : OptionSet
      33            2 : SingleSlipStrengthMap::expected_options()
      34              : {
      35            2 :   OptionSet options = SlipStrengthMap::expected_options();
      36              : 
      37            2 :   options.doc() =
      38              :       "Calculates the slip system strength for all slip systems as \\f$ \\hat{\\tau}_i = "
      39              :       "\\bar{\\tau} + \\tau_0 \\f$ where \\f$ \\hat{\\tau}_i \\f$ is the strength for slip system "
      40              :       "i, \\f$ \\bar{\\tau} \\f$ is an evolving slip system strength (one value of all systems), "
      41            2 :       "defined by another object, and \\f$ \\tau_0 \\f$ is a constant strength.";
      42              : 
      43            6 :   options.set_input("slip_hardening") = VariableName(STATE, "internal", "slip_hardening");
      44            4 :   options.set("slip_hardening").doc() = "The name of the evovling, scalar strength";
      45              : 
      46            4 :   options.set_parameter<TensorName<Scalar>>("constant_strength");
      47            2 :   options.set("constant_strength").doc() = "The constant slip system strength";
      48              : 
      49            2 :   return options;
      50            0 : }
      51              : 
      52            2 : SingleSlipStrengthMap::SingleSlipStrengthMap(const OptionSet & options)
      53              :   : SlipStrengthMap(options),
      54            2 :     _tau_bar(declare_input_variable<Scalar>("slip_hardening")),
      55           10 :     _tau_const(declare_parameter<Scalar>("constant_strength", "constant_strength"))
      56              : {
      57            2 : }
      58              : 
      59              : void
      60            4 : SingleSlipStrengthMap::set_value(bool out, bool dout_din, bool /*d2out_din2*/)
      61              : {
      62            4 :   if (out)
      63            3 :     _tau = (_tau_bar + _tau_const).batch_unsqueeze(-1).batch_expand(_crystal_geometry.nslip(), -1);
      64              : 
      65            4 :   if (dout_din)
      66            2 :     if (_tau_bar.is_dependent())
      67            2 :       _tau.d(_tau_bar) = Tensor::ones(_crystal_geometry.nslip(), _tau_bar.options());
      68            4 : }
      69              : } // namespace neml2