Interpolation.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/models/NonlinearParameter.h"
 
namespace neml2
{
template <typename T>
class Interpolation : public NonlinearParameter<T>
{
public:
  static OptionSet expected_options();
 
  Interpolation(const OptionSet & options);
 
protected:
  const Scalar & _X;
 
  const T & _Y;
 
  const Variable<Scalar> & _x;
};
 
template <typename T>
OptionSet
Interpolation<T>::expected_options()
{
  // This is the only way of getting tensor type in a static method like this...
  // Trim 6 chars to remove 'neml2::'
  auto tensor_type = utils::demangle(typeid(T).name()).substr(7);
 
  OptionSet options = NonlinearParameter<T>::expected_options();
  options.doc() = "Interpolate a " + tensor_type +
                  " as a function of the given argument. See neml2::Interpolation for rules on "
                  "shapes of the interpolant and the argument.";
 
  options.set_input("argument");
  options.set("argument").doc() = "Argument used to query the interpolant";
 
  options.set<CrossRef<Scalar>>("abscissa");
  options.set("abscissa").doc() = "Scalar defining the abscissa values of the interpolant";
 
  options.set<CrossRef<T>>("ordinate");
  options.set("ordinate").doc() = tensor_type + " defining the ordinate values of the interpolant";
 
  return options;
}
 
template <typename T>
Interpolation<T>::Interpolation(const OptionSet & options)
  : NonlinearParameter<T>(options),
    _X(this->template declare_parameter<Scalar>("X", "abscissa")),
    _Y(this->template declare_parameter<T>("Y", "ordinate")),
    _x(this->template declare_input_variable<Scalar>("argument"))
{
}
} // namespace neml2