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/ConstantParameter.h"
      26              : #include "neml2/tensors/tensors.h"
      27              : 
      28              : namespace neml2
      29              : {
      30              : template <typename T>
      31              : OptionSet
      32           44 : ConstantParameter<T>::expected_options()
      33              : {
      34           44 :   OptionSet options = Model::expected_options();
      35           44 :   options.doc() = "A parameter that is just a constant value, generally used to refer to a "
      36              :                   "parameter in more than one downstream object.";
      37              : 
      38           88 :   options.set_parameter<TensorName<T>>("value");
      39           44 :   options.set("value").doc() = "The constant value of the parameter";
      40           44 :   return options;
      41            0 : }
      42              : 
      43              : template <typename T>
      44            5 : ConstantParameter<T>::ConstantParameter(const OptionSet & options)
      45              :   : Model(options),
      46           15 :     _value(this->template declare_parameter<T>("value", "value", /*allow_nonlinear=*/true)),
      47           10 :     _p(this->template declare_output_variable<T>(VariableName(PARAMETERS, name())))
      48              : {
      49            5 : }
      50              : 
      51              : template <typename T>
      52              : void
      53            4 : ConstantParameter<T>::set_value(bool out, bool dout_din, bool d2out_din2)
      54              : {
      55            4 :   if (out)
      56            2 :     this->_p = _value;
      57              : 
      58            4 :   if (dout_din)
      59            6 :     if (const auto value = this->nl_param("value"))
      60            0 :       this->_p.d(*value) = T::identity_map(value->options());
      61              : 
      62              :   // This is zero
      63              :   (void)d2out_din2;
      64            4 : }
      65              : 
      66              : #define REGISTER_CONSTANTPARAMETER(T)                                                              \
      67              :   using T##ConstantParameter = ConstantParameter<T>;                                               \
      68              :   register_NEML2_object(T##ConstantParameter);                                                     \
      69              :   template class ConstantParameter<T>
      70              : FOR_ALL_PRIMITIVETENSOR(REGISTER_CONSTANTPARAMETER);
      71              : } // namespace neml2