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/elasticity/Elasticity.h"
      26              : 
      27              : namespace neml2
      28              : {
      29              : OptionSet
      30            4 : Elasticity::expected_options()
      31              : {
      32            4 :   OptionSet options = Model::expected_options();
      33            4 :   options.doc() = "Relate elastic strain to stress";
      34              : 
      35           12 :   options.set_input("strain") = VariableName(STATE, "internal", "Ee");
      36            4 :   options.set("strain").doc() = "Elastic strain";
      37              : 
      38           12 :   options.set_output("stress") = VariableName(STATE, "S");
      39            8 :   options.set("stress").doc() = "Stress";
      40              : 
      41            8 :   options.set<bool>("compliance") = false;
      42           12 :   options.set("compliance").doc() =
      43              :       "Whether the model defines the compliance relationship, i.e., mapping from stress to elastic "
      44            4 :       "strain. When set to false (default), the model maps elastic strain to stress.";
      45              : 
      46            8 :   options.set<bool>("rate_form") = false;
      47            8 :   options.set("rate_form").doc() =
      48              :       "Whether the model defines the stress-strain relationship in rate form. When set to true, "
      49            4 :       "the model maps elastic strain *rate* to stress *rate*.";
      50              : 
      51            4 :   return options;
      52            0 : }
      53              : 
      54           26 : Elasticity::Elasticity(const OptionSet & options)
      55              :   : Model(options),
      56           52 :     _compliance(options.get<bool>("compliance")),
      57           52 :     _rate_form(options.get<bool>("rate_form")),
      58          104 :     _strain(options.get<VariableName>("strain").with_suffix(_rate_form ? "_rate" : "")),
      59           78 :     _stress(options.get<VariableName>("stress").with_suffix(_rate_form ? "_rate" : "")),
      60           26 :     _from(declare_input_variable<SR2>(_compliance ? _stress : _strain)),
      61           52 :     _to(declare_output_variable<SR2>(_compliance ? _strain : _stress))
      62              : {
      63           26 : }
      64              : } // namespace neml2