NEML2Object.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/base/OptionSet.h"
#include "neml2/base/Factory.h"
 
// Registry.h is included here because it is needed for the factory pattern, i.e., for the
// register_NEML2_object macros
#include "neml2/base/Registry.h"
 
namespace neml2
{
class Settings;
class EquationSystem;
class Solver;
class Data;
class Model;
class Driver;
class WorkScheduler;

class NEML2Object
{
public:
  static OptionSet expected_options();
 
  NEML2Object() = delete;
  NEML2Object(NEML2Object &&) = delete;
  NEML2Object(const NEML2Object &) = delete;
  NEML2Object & operator=(NEML2Object &&) = delete;
  NEML2Object & operator=(const NEML2Object &) = delete;
  virtual ~NEML2Object() = default;

  NEML2Object(const OptionSet & options);
 
  const OptionSet & input_options() const { return _input_options; }

  virtual void setup() {}

  const std::string & name() const { return _input_options.name(); }
  std::string type() const { return _input_options.type(); }
  const std::string & path() const { return _input_options.path(); }
  const std::string & doc() const { return _input_options.doc(); }

  Factory * factory() const { return _factory; }

  const Settings & settings() const { return *_settings; }

  template <typename T = NEML2Object>
  const T * host() const;

  template <typename T = NEML2Object>
  T * host();

  template <typename T>
  const T & resolve_tensor(const std::string & name);

  template <class T>
  std::shared_ptr<T> get_object(const std::string & section, const std::string & name);
  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);
 
protected:
  VariableName history_name(const VariableName & var, std::size_t nstep) const;

  VariableName rate_name(const VariableName & var) const;

  VariableName residual_name(const VariableName & var) const;
 
private:
  const OptionSet _input_options;

  Factory * _factory;

  const std::shared_ptr<Settings> _settings;

  NEML2Object * _host;
};
 
template <typename T>
const T *
NEML2Object::host() const
{
  auto host_ptr = dynamic_cast<const T *>(_host ? _host : this);
  if (!host_ptr)
    throw NEMLException("Internal error: Failed to retrieve host of object " + name());
  return host_ptr;
}
 
template <typename T>
T *
NEML2Object::host()
{
  auto host_ptr = dynamic_cast<T *>(_host ? _host : this);
  if (!host_ptr)
    throw NEMLException("Internal error: Failed to retrieve host of object " + name());
  return host_ptr;
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_object(const std::string & section, const std::string & name)
{
  auto obj_name = _input_options.contains(name) ? _input_options.get<std::string>(name) : name;
 
  if (!_factory)
    throw NEMLException("Internal error: factory is nullptr for object " + this->name());
 
  if (!_factory->has_object(section, obj_name))
  {
    if (_input_options.contains(name))
      throw NEMLException(
          path() + " failed to get an object via option '" + name + "' under section " + section +
          ". Currently, " + path() + "/" + name + " = '" + obj_name +
          "'. Check to make sure the object name is specified correctly in the input file.");
    else
      throw NEMLException(path() + " failed to get an object named '" + obj_name +
                          "' under section " + section + ".");
  }
 
  OptionSet extra_opts;
  extra_opts.add_private<NEML2Object *>("_host", host());
  return _factory->get_object<T>(section, obj_name, extra_opts, /*force_create=*/false);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_es(const std::string & name)
{
  return get_object<T>("EquationSystems", name);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_solver(const std::string & name)
{
  return get_object<T>("Solvers", name);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_data(const std::string & name)
{
  return get_object<T>("Data", name);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_model(const std::string & name)
{
  return get_object<T>("Models", name);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_driver(const std::string & name)
{
  return get_object<T>("Drivers", name);
}
 
template <class T>
std::shared_ptr<T>
NEML2Object::get_scheduler(const std::string & name)
{
  return get_object<T>("Schedulers", name);
}
} // namespace neml2