HITParser.cxx

// 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.
 
#include "neml2/base/HITParser.h"
#include "neml2/base/Factory.h"
#include "neml2/base/CrossRef.h"
#include "neml2/base/Sequence.h"
#include "neml2/tensors/LabeledAxis.h"
#include "neml2/tensors/tensors.h"
#include "neml2/tensors/macros.h"
#include <memory>
 
namespace neml2
{
OptionCollection
HITParser::parse(const std::filesystem::path & filename, const std::string & additional_input) const
{
  // Open and read the file
  std::ifstream file(filename);
  neml_assert(file.is_open(), "Unable to open file ", filename);
 
  // Read the file into a string
  std::stringstream buffer;
  buffer << file.rdbuf();
  std::string input = buffer.str();
 
  // Let HIT lex the string
  std::unique_ptr<hit::Node> root(hit::parse(filename, input));
  neml_assert(root.get(), "HIT failed to lex the input file: ", filename);
 
  // Explode the tree
  hit::explode(root.get());
 
  // Handle additional input (they could be coming from cli args)
  std::unique_ptr<hit::Node> cli_root(hit::parse("cliargs", additional_input));
  hit::explode(cli_root.get());
  hit::merge(cli_root.get(), root.get());
 
  // Preevaluate the input
  hit::BraceExpander expander;
  hit::EnvEvaler env;
  hit::RawEvaler raw;
  expander.registerEvaler("env", env);
  expander.registerEvaler("raw", raw);
  root->walk(&expander);
 
  // Loop over each known section and extract options for each object
  OptionCollection all_options;
  for (const auto & section : Factory::pipeline)
  {
    auto section_node = root->find(section);
    if (section_node)
    {
      auto objects = section_node->children(hit::NodeType::Section);
      for (auto object : objects)
      {
        auto options = extract_object_options(object, section_node);
        all_options[section][options.name()] = options;
      }
    }
  }
 
  return all_options;
}
 
OptionSet
HITParser::extract_object_options(hit::Node * object, hit::Node * section) const
{
  // There is a special field reserved for object type
  std::string type = object->param<std::string>("type");
  // Extract the options
  auto options = Registry::expected_options(type);
  extract_options(object, options);
 
  // Also fill in the metadata
  options.name() = object->path();
  options.type() = type;
  options.path() = section->fullpath();
 
  return options;
}
 
void
HITParser::extract_options(hit::Node * object, OptionSet & options) const
{
  for (auto node : object->children(hit::NodeType::Field))
    if (node->path() != "type")
      extract_option(node, options);
}
 
void
HITParser::extract_option(hit::Node * n, OptionSet & options) const
{
#define extract_option_base(ptype, method)                                                         \
  else if (option->type() ==                                                                       \
           utils::demangle(                                                                        \
               typeid(ptype).name())) dynamic_cast<OptionSet::Option<ptype> *>(option.get())       \
      ->set() = method(n->strVal())
 
#define extract_option_t(ptype)                                                                    \
  extract_option_base(ptype, utils::parse<ptype>);                                                 \
  extract_option_base(std::vector<ptype>, utils::parse_vector<ptype>);                             \
  extract_option_base(std::vector<std::vector<ptype>>, utils::parse_vector_vector<ptype>);         \
  extract_option_base(Sequence<ptype>, utils::parse<Sequence<ptype>>)
 
#define extract_option_t_cr(ptype) extract_option_t(CrossRef<ptype>)
 
  if (n->type() == hit::NodeType::Field)
  {
    bool found = false;
    for (auto & [name, option] : options)
      if (name == n->path())
      {
        neml_assert(!option->suppressed(),
                    "Option named '",
                    option->name(),
                    "' is suppressed, and its value cannot be modified.");
 
        found = true;
 
        if (false)
          ;
        extract_option_t(TorchShape);
        extract_option_t(bool);
        extract_option_t(int);
        extract_option_t(unsigned int);
        extract_option_t(TorchSize);
        extract_option_t(Real);
        extract_option_t(std::string);
        extract_option_t(VariableName);
        extract_option_t(CrossRef<torch::Tensor>);
        FOR_ALL_BATCHTENSORBASE(extract_option_t_cr);
        // LCOV_EXCL_START
        else neml_assert(false, "Unsupported option type for option ", n->fullpath());
        // LCOV_EXCL_STOP
 
        break;
      }
    neml_assert(found, "Unused option ", n->fullpath());
  }
}
} // namespace neml2