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/InputParameter.h"
      26              : #include "neml2/misc/assertions.h"
      27              : #include "neml2/tensors/tensors.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : template <typename T>
      32              : OptionSet
      33          101 : InputParameter<T>::expected_options()
      34              : {
      35          101 :   OptionSet options = Model::expected_options();
      36          101 :   options.doc() =
      37              :       "A parameter that is defined through an input variable. This object is not intended "
      38              :       "to be used directly in the input file.";
      39              : 
      40          202 :   options.set<bool>("define_second_derivatives") = true;
      41              : 
      42          202 :   options.set_input("from");
      43          202 :   options.set("from").doc() = "The input variable that defines this parameter";
      44              : 
      45          202 :   options.set_output("to");
      46          101 :   options.set("to").doc() = "The name of the parameter, default to 'parameters/object_name'";
      47              : 
      48          101 :   return options;
      49            0 : }
      50              : 
      51              : template <typename T>
      52           59 : InputParameter<T>::InputParameter(const OptionSet & options)
      53              :   : Model(options),
      54           59 :     _input_var(this->template declare_input_variable<T>("from")),
      55           59 :     _p(options.get("to").user_specified()
      56           59 :            ? this->template declare_output_variable<T>("to")
      57          118 :            : this->template declare_output_variable<T>(VariableName(PARAMETERS, this->name())))
      58              : {
      59           59 : }
      60              : 
      61              : template <typename T>
      62              : void
      63          133 : InputParameter<T>::set_value(bool out, bool dout_din, bool /*d2out_din2*/)
      64              : {
      65          133 :   if (out)
      66          133 :     this->_p = _input_var.value();
      67              : 
      68          133 :   if (dout_din)
      69           74 :     if (_input_var.is_dependent())
      70           74 :       this->_p.d(_input_var) = T::identity_map(_input_var.options());
      71          133 : }
      72              : 
      73              : #define REGISTER(T)                                                                                \
      74              :   using T##InputParameter = InputParameter<T>;                                                     \
      75              :   register_NEML2_object(T##InputParameter);                                                        \
      76              :   template class InputParameter<T>
      77              : FOR_ALL_PRIMITIVETENSOR(REGISTER);
      78              : } // namespace neml2