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/Interpolation.h"
      26              : #include "neml2/misc/string_utils.h"
      27              : #include "neml2/tensors/tensors.h"
      28              : 
      29              : namespace neml2
      30              : {
      31              : template <typename T>
      32              : OptionSet
      33            6 : Interpolation<T>::expected_options()
      34              : {
      35              :   // This is the only way of getting tensor type in a static method like this...
      36              :   // Trim 6 chars to remove 'neml2::'
      37            6 :   auto tensor_type = utils::demangle(typeid(T).name()).substr(7);
      38              : 
      39            6 :   OptionSet options = Model::expected_options();
      40            6 :   options.doc() = "Interpolate a " + tensor_type +
      41              :                   " as a function of the given argument. See neml2::Interpolation for rules on "
      42              :                   "shapes of the interpolant and the argument.";
      43              : 
      44           12 :   options.set_input("argument");
      45           12 :   options.set("argument").doc() = "Argument used to query the interpolant";
      46              : 
      47           12 :   options.set<TensorName<Scalar>>("abscissa");
      48           12 :   options.set("abscissa").doc() = "Scalar defining the abscissa values of the interpolant";
      49              : 
      50            6 :   options.set<TensorName<T>>("ordinate");
      51           18 :   options.set("ordinate").doc() = tensor_type + " defining the ordinate values of the interpolant";
      52              : 
      53           12 :   return options;
      54            6 : }
      55              : 
      56              : template <typename T>
      57           10 : Interpolation<T>::Interpolation(const OptionSet & options)
      58              :   : Model(options),
      59           30 :     _X(this->template declare_parameter<Scalar>("X", "abscissa")),
      60           40 :     _Y(this->template declare_parameter<T>("Y", "ordinate")),
      61           10 :     _x(this->template declare_input_variable<Scalar>("argument")),
      62           20 :     _p(this->template declare_output_variable<T>(VariableName(PARAMETERS, name())))
      63              : {
      64           10 : }
      65              : 
      66              : #define INSTANTIATE(T) template class Interpolation<T>
      67              : FOR_ALL_PRIMITIVETENSOR(INSTANTIATE);
      68              : } // namespace neml2