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/SlipRule.h"
      26              : #include "neml2/models/crystallography/CrystalGeometry.h"
      27              : 
      28              : #include "neml2/tensors/Scalar.h"
      29              : #include "neml2/tensors/list_tensors.h"
      30              : 
      31              : namespace neml2
      32              : {
      33              : OptionSet
      34            2 : SlipRule::expected_options()
      35              : {
      36            2 :   OptionSet options = Model::expected_options();
      37              : 
      38            2 :   options.doc() = "Parent class for all slip rules, which define the slip rate in terms of the "
      39            2 :                   "resolved shear and the slip system strength";
      40              : 
      41            6 :   options.set_output("slip_rates") = VariableName(STATE, "internal", "slip_rates");
      42            2 :   options.set("slip_rates").doc() = "Name of the slip rate tensor";
      43              : 
      44            6 :   options.set_input("resolved_shears") = VariableName(STATE, "internal", "resolved_shears");
      45            2 :   options.set("resolved_shears").doc() = "Name of the resolved shear tensor";
      46              : 
      47            6 :   options.set_input("slip_strengths") = VariableName(STATE, "internal", "slip_strengths");
      48            4 :   options.set("slip_strengths").doc() = "Name of the tensor containing the slip system strengths";
      49              : 
      50            4 :   options.set<std::string>("crystal_geometry_name") = "crystal_geometry";
      51            4 :   options.set("crystal_geometry_name").doc() =
      52            2 :       "Name of the Data object containing the crystallographic information";
      53              : 
      54            2 :   return options;
      55            0 : }
      56              : 
      57            3 : SlipRule::SlipRule(const OptionSet & options)
      58              :   : Model(options),
      59            3 :     _crystal_geometry(register_data<crystallography::CrystalGeometry>(
      60            6 :         options.get<std::string>("crystal_geometry_name"))),
      61            3 :     _g(declare_output_variable<Scalar>("slip_rates", _crystal_geometry.nslip())),
      62            3 :     _rss(declare_input_variable<Scalar>("resolved_shears", _crystal_geometry.nslip())),
      63            6 :     _tau(declare_input_variable<Scalar>("slip_strengths", _crystal_geometry.nslip()))
      64              : {
      65            3 : }
      66              : } // namespace neml2