Factory.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/misc/errors.h"
#include "neml2/base/InputFile.h"
 
namespace neml2
{
// Forward decl
class Settings;
class Factory;
class NEML2Object;
class EquationSystem;
class Solver;
class Data;
class Model;
class Driver;
class WorkScheduler;

class Factory
{
public:
  Factory(InputFile);

  InputFile & input_file() { return _input_file; }

  const InputFile & input_file() const { return _input_file; }

  const std::shared_ptr<Settings> & settings() const { return _input_file.settings(); }

  bool has_object(const std::string & section, const std::string & name);

  template <class T>
  std::shared_ptr<T> get_object(const std::string & section,
                                const std::string & name,
                                const OptionSet & additional_options = OptionSet(),
                                bool force_create = true);

  template <class T = EquationSystem>
  std::shared_ptr<T> get_es(const std::string & name);
  template <class T = Solver>
  std::shared_ptr<T> get_solver(const std::string & name);
  template <class T = Data>
  std::shared_ptr<T> get_data(const std::string & name);
  template <class T = Model>
  std::shared_ptr<T> get_model(const std::string & name);
  template <class T = Driver>
  std::shared_ptr<T> get_driver(const std::string & name);
  template <class T = WorkScheduler>
  std::shared_ptr<T> get_scheduler(const std::string & name);

  void clear();

  void print(std::ostream & os = std::cout);
 
protected:
  void create_object(const std::string & section, const OptionSet & options);
 
private:
  bool options_compatible(const std::shared_ptr<NEML2Object> & obj, const OptionSet & opts) const;

  InputFile _input_file;

  std::map<std::string, std::map<std::string, std::vector<std::shared_ptr<NEML2Object>>>> _objects;
};
 
template <class T>
std::shared_ptr<T>
Factory::get_object(const std::string & section,
                    const std::string & name,
                    const OptionSet & additional_options,
                    bool force_create)
{
  if (input_file().data().empty())
    throw FactoryException("The input file is empty.");
 
  // Easy if it already exists
  if (!force_create)
    if (_objects.count(section) && _objects.at(section).count(name))
      for (const auto & neml2_obj : _objects[section][name])
      {
        // Check for option clash
        if (!options_compatible(neml2_obj, additional_options))
          continue;
 
        // Check for object type
        auto obj = std::dynamic_pointer_cast<T>(neml2_obj);
        if (!obj)
          throw FactoryException(
              "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 (const auto & options : _input_file[section])
    if (options.first == name)
    {
      auto new_options = options.second;
      new_options.set_private<Factory *>("_factory", this);
      new_options.set_private<std::shared_ptr<Settings>>("_settings", settings());
      new_options += additional_options;
      create_object(section, new_options);
      break;
    }
 
  if (!_objects.count(section) || !_objects.at(section).count(name))
    throw FactoryException("Failed to get object named " + name + " under section " + section +
                           ". Check to make sure the object is defined in the input file.");
 
  auto obj = std::dynamic_pointer_cast<T>(_objects[section][name].back());
 
  if (!obj)
    throw FactoryException("Found object named " + name + " under section " + section +
                           ". But dynamic cast failed. Did you specify the correct object type?");
 
  return obj;
}
 
template <class T>
std::shared_ptr<T>
Factory::get_es(const std::string & name)
{
  return get_object<T>("EquationSystems", name);
}
 
template <class T>
std::shared_ptr<T>
Factory::get_solver(const std::string & name)
{
  return get_object<T>("Solvers", name);
}
 
template <class T>
std::shared_ptr<T>
Factory::get_data(const std::string & name)
{
  return get_object<T>("Data", name);
}
 
template <class T>
std::shared_ptr<T>
Factory::get_model(const std::string & name)
{
  return get_object<T>("Models", name);
}
 
template <class T>
std::shared_ptr<T>
Factory::get_driver(const std::string & name)
{
  return get_object<T>("Drivers", name);
}
 
template <class T>
std::shared_ptr<T>
Factory::get_scheduler(const std::string & name)
{
  return get_object<T>("Schedulers", name);
}
} // namespace neml2