Factory.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/Registry.h"
#include "neml2/base/NEML2Object.h"
#include "neml2/misc/error.h"
#include "neml2/base/OptionCollection.h"
 
namespace neml2
{
class Factory
{
public:
  static std::vector<std::string> pipeline;
 
  static Factory & get();
 
  template <class T>
  static std::shared_ptr<T> get_object_ptr(const std::string & section,
                                           const std::string & name,
                                           const OptionSet & additional_options = OptionSet(),
                                           bool force_create = false);
 
  template <class T>
  static T & get_object(const std::string & section,
                        const std::string & name,
                        const OptionSet & additional_options = OptionSet(),
                        bool force_create = false);
 
  static void load(const OptionCollection & all_options);
 
  static void clear();
 
  static void print(std::ostream & os = std::cout);
 
protected:
  void create_object(const std::string & section, const OptionSet & options);
 
private:
  OptionCollection _all_options;
 
  // Manufactured objects. The key of the outer map is the section name, and the key of the inner
  // map is the object name.
  std::map<std::string, std::map<std::string, std::vector<std::shared_ptr<NEML2Object>>>> _objects;
};
 
template <class T>
inline std::shared_ptr<T>
Factory::get_object_ptr(const std::string & section,
                        const std::string & name,
                        const OptionSet & additional_options,
                        bool force_create)
{
  auto & factory = Factory::get();
 
  // Easy if it already exists
  if (!force_create)
    if (factory._objects.count(section) && factory._objects.at(section).count(name))
    {
      const auto & neml2_obj = factory._objects[section][name].back();
 
      // Error on option clash (these errors should only be developer-facing)
      for (const auto & [key, value] : additional_options)
      {
        neml_assert_dbg(neml2_obj->input_options().contains(key),
                        "While retrieving object named '",
                        name,
                        "' under section ",
                        section,
                        ", additional option '",
                        key,
                        "'");
        neml_assert_dbg(neml2_obj->input_options().get(key) == *value,
                        "While retrieving object named '",
                        name,
                        "' under section ",
                        section,
                        ", encountered option clash for '",
                        key,
                        "'");
      }
 
      // Check for object type
      auto obj = std::dynamic_pointer_cast<T>(neml2_obj);
      neml_assert(obj != nullptr,
                  "Found object named ",
                  name,
                  " under section ",
                  section,
                  ". But dynamic cast failed. Did you specify the correct object type?");
 
      return obj;
    }
 
  // Otherwise try to create it
  for (auto & options : factory._all_options[section])
    if (options.first == name)
    {
      auto new_options = options.second;
      new_options += additional_options;
      factory.create_object(section, new_options);
      break;
    }
 
  neml_assert(factory._objects.count(section) && factory._objects.at(section).count(name),
              "Failed to get object named ",
              name,
              " under section ",
              section);
 
  return Factory::get_object_ptr<T>(section, name, OptionSet(), false);
}
 
template <class T>
inline T &
Factory::get_object(const std::string & section,
                    const std::string & name,
                    const OptionSet & additional_options,
                    bool force_create)
{
  return *Factory::get_object_ptr<T>(section, name, additional_options, force_create);
}
} // namespace neml2