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/KinematicHardeningStaticRecovery.h"
      26              : #include "neml2/tensors/SR2.h"
      27              : #include "neml2/tensors/SSR4.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : OptionSet
      32            2 : KinematicHardeningStaticRecovery::expected_options()
      33              : {
      34            2 :   OptionSet options = Model::expected_options();
      35            2 :   options.doc() += "This object defines kinematic hardening static recovery on a backstress term.";
      36              : 
      37            6 :   options.set_input("back_stress") = VariableName(STATE, "internal", "X");
      38            4 :   options.set("back_stress").doc() = "Back stress";
      39              : 
      40            4 :   options.set_output("back_stress_rate");
      41            4 :   options.set("back_stress_rate").doc() =
      42            2 :       "Back stress rate, defaults to back_stress + _recovery_rate";
      43              : 
      44            2 :   return options;
      45            0 : }
      46              : 
      47            1 : KinematicHardeningStaticRecovery::KinematicHardeningStaticRecovery(const OptionSet & options)
      48              :   : Model(options),
      49            1 :     _X(declare_input_variable<SR2>("back_stress")),
      50            4 :     _X_dot(declare_output_variable<SR2>(options.get<VariableName>("back_stress_rate").empty()
      51            4 :                                             ? _X.name().with_suffix("_recovery_rate")
      52            1 :                                             : options.get<VariableName>("back_stress_rate")))
      53              : {
      54            1 : }
      55              : 
      56              : } // namespace neml2