BufferStore.h

// Copyright 2023, 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/base/NEML2Object.h"
#include "neml2/base/OptionSet.h"
#include "neml2/base/Storage.h"
#include "neml2/tensors/TensorValue.h"
 
namespace neml2
{
class BufferStore
{
public:
  BufferStore(const OptionSet & options, NEML2Object * object);
 
  const Storage<std::string, TensorValueBase> & named_buffers() const
  {
    return const_cast<BufferStore *>(this)->named_buffers();
  }
  Storage<std::string, TensorValueBase> & named_buffers();
 
  template <typename T,
            typename = typename std::enable_if_t<std::is_base_of_v<BatchTensorBase<T>, T>>>
  T & get_buffer(const std::string & name);
 
protected:
  virtual void send_buffers_to(const torch::TensorOptions & options);
 
  template <typename T,
            typename = typename std::enable_if_t<std::is_base_of_v<BatchTensorBase<T>, T>>>
  const T & declare_buffer(const std::string & name, const T & rawval);
 
  template <typename T,
            typename = typename std::enable_if_t<std::is_base_of_v<BatchTensorBase<T>, T>>>
  const T & declare_buffer(const std::string & name, const std::string & input_option_name);
 
private:
  NEML2Object * _object;
 
  const OptionSet _options;
 
  Storage<std::string, TensorValueBase> _buffer_values;
};
 
template <typename T, typename>
T &
BufferStore::get_buffer(const std::string & name)
{
  neml_assert(_object->host() == _object, "This method should only be called on the host model.");
 
  auto base_ptr = _buffer_values.query_value(name);
  neml_assert(base_ptr, "Buffer named ", name, " does not exist.");
  auto ptr = dynamic_cast<TensorValue<T> *>(base_ptr);
  neml_assert_dbg(ptr, "Internal error: Failed to cast buffer to a concrete type.");
  return ptr->value();
}
 
template <typename T, typename>
const T &
BufferStore::declare_buffer(const std::string & name, const T & rawval)
{
  if (_object->host() != _object)
    return _object->host<BufferStore>()->declare_buffer(_object->name() + "." + name, rawval);
 
  // If the buffer already exists, return its reference
  if (_buffer_values.has_key(name))
    return get_buffer<T>(name);
 
  auto val = std::make_unique<TensorValue<T>>(rawval);
  auto base_ptr = _buffer_values.set_pointer(name, std::move(val));
  auto ptr = dynamic_cast<TensorValue<T> *>(base_ptr);
  neml_assert(ptr, "Internal error: Failed to cast buffer to a concrete type.");
  return ptr->value();
}
 
template <typename T, typename>
const T &
BufferStore::declare_buffer(const std::string & name, const std::string & input_option_name)
{
  if (_options.contains<T>(input_option_name))
    return declare_buffer(name, _options.get<T>(input_option_name));
  else if (_options.contains<CrossRef<T>>(input_option_name))
    return declare_buffer(name, T(_options.get<CrossRef<T>>(input_option_name)));
 
  throw NEMLException(
      "Trying to register buffer named " + name + " from input option named " + input_option_name +
      " of type " + utils::demangle(typeid(T).name()) +
      ". Make sure you provided the correct buffer name, option name, and buffer type. Note that "
      "the buffer type can either be a plain type, a cross-reference, or an interpolator.");
}
 
} // namespace neml2