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/SingleSlipHardeningRule.h"
      26              : 
      27              : #include "neml2/tensors/Scalar.h"
      28              : #include "neml2/tensors/list_tensors.h"
      29              : 
      30              : namespace neml2
      31              : {
      32              : OptionSet
      33            4 : SingleSlipHardeningRule::expected_options()
      34              : {
      35            4 :   OptionSet options = Model::expected_options();
      36              : 
      37            4 :   options.doc() =
      38            4 :       "Parent class of slip hardening rules where all slip systems share the same strength.";
      39              : 
      40            8 :   options.set_output("slip_hardening_rate") =
      41           12 :       VariableName(STATE, "internal", "slip_hardening_rate");
      42            8 :   options.set("slip_hardening_rate").doc() =
      43            4 :       "Name of tensor to output the slip system hardening rates into";
      44              : 
      45           12 :   options.set_input("slip_hardening") = VariableName(STATE, "internal", "slip_hardening");
      46            4 :   options.set("slip_hardening").doc() = "Name of current values of slip hardening";
      47              : 
      48           12 :   options.set_input("sum_slip_rates") = VariableName(STATE, "internal", "sum_slip_rates");
      49            4 :   options.set("sum_slip_rates").doc() = "Name of tensor containing the sum of the slip rates";
      50              : 
      51            4 :   return options;
      52            0 : }
      53              : 
      54            3 : SingleSlipHardeningRule::SingleSlipHardeningRule(const OptionSet & options)
      55              :   : Model(options),
      56            3 :     _tau_dot(declare_output_variable<Scalar>("slip_hardening_rate")),
      57            3 :     _tau(declare_input_variable<Scalar>("slip_hardening")),
      58            6 :     _gamma_dot_sum(declare_input_variable<Scalar>("sum_slip_rates"))
      59              : {
      60            3 : }
      61              : } // namespace neml2