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/ParameterToState.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           44 : ParameterToState<T>::expected_options()
      34              : {
      35           44 :   OptionSet options = Model::expected_options();
      36           44 :   options.doc() = "Convert the parameter to state variable.";
      37              : 
      38           88 :   options.set<bool>("define_second_derivatives") = true;
      39              : 
      40           88 :   options.set_parameter<TensorName<T>>("from");
      41           88 :   options.set("from").doc() = "The input parameter";
      42              : 
      43           88 :   options.set_output("to");
      44           44 :   options.set("to").doc() = "The name of the variables, default to 'state/object_name'";
      45              : 
      46           44 :   return options;
      47            0 : }
      48              : 
      49              : template <typename T>
      50            1 : ParameterToState<T>::ParameterToState(const OptionSet & options)
      51              :   : Model(options),
      52            4 :     _input_param(this->template declare_parameter<T>("param", "from")),
      53            1 :     _state(options.get("to").user_specified()
      54            1 :                ? this->template declare_output_variable<T>("to")
      55            2 :                : this->template declare_output_variable<T>(VariableName(STATE, this->name())))
      56              : {
      57            1 : }
      58              : 
      59              : template <typename T>
      60              : void
      61            2 : ParameterToState<T>::set_value(bool out, bool /*dout_din*/, bool /*d2out_din2*/)
      62              : {
      63            2 :   if (out)
      64              :   {
      65            2 :     this->_state = _input_param;
      66              :   }
      67            2 : }
      68              : 
      69              : #define REGISTER(T)                                                                                \
      70              :   using T##ParameterToState = ParameterToState<T>;                                                 \
      71              :   register_NEML2_object(T##ParameterToState);                                                      \
      72              :   template class ParameterToState<T>
      73              : FOR_ALL_PRIMITIVETENSOR(REGISTER);
      74              : } // namespace neml2