NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
HITParser.h
1// Copyright 2024, UChicago Argonne, LLC
2// All Rights Reserved
3// Software Name: NEML2 -- the New Engineering material Model Library, version 2
4// By: Argonne National Laboratory
5// OPEN SOURCE LICENSE (MIT)
6//
7// Permission is hereby granted, free of charge, to any person obtaining a copy
8// of this software and associated documentation files (the "Software"), to deal
9// in the Software without restriction, including without limitation the rights
10// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11// copies of the Software, and to permit persons to whom the Software is
12// furnished to do so, subject to the following conditions:
13//
14// The above copyright notice and this permission notice shall be included in
15// all copies or substantial portions of the Software.
16//
17// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23// THE SOFTWARE.
24#pragma once
25
26#include "hit/hit.h"
27#include "neml2/base/Parser.h"
28
29namespace neml2
30{
31class OptionSet;
32
38class HITParser : public Parser
39{
40public:
41 HITParser() = default;
42
43 HITParser(const HITParser &) = default;
44 HITParser(HITParser &&) noexcept = default;
45 HITParser & operator=(const HITParser &) = default;
46 HITParser & operator=(HITParser &&) noexcept = default;
47 ~HITParser() override = default;
48
49 OptionCollection parse(const std::filesystem::path & filename,
50 const std::string & additional_input = "") const override;
51
59 virtual OptionSet extract_object_options(hit::Node * object, hit::Node * section) const;
60
61private:
62 void extract_options(hit::Node * object, OptionSet & options) const;
63 void extract_option(hit::Node * node, OptionSet & options) const;
64};
65
66} // namespace neml2
HITParser(HITParser &&) noexcept=default
OptionCollection parse(const std::filesystem::path &filename, const std::string &additional_input="") const override
Deserialize a file.
Definition HITParser.cxx:40
HITParser(const HITParser &)=default
HITParser()=default
virtual OptionSet extract_object_options(hit::Node *object, hit::Node *section) const
Extract options for a specific object.
Definition HITParser.cxx:97
A data structure that holds options of multiple objects.
Definition OptionCollection.h:38
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:52
Parser()=default
Definition DiagnosticsInterface.cxx:30