NEML2 1.4.0
Loading...
Searching...
No Matches
Parser.h
1// Copyright 2023, 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 <filesystem>
27
28#include "neml2/base/OptionCollection.h"
29
30namespace neml2
31{
39
47void load_model(const std::string & path,
48 const std::string & additional_input = "",
50
56class Parser
57{
58public:
59 Parser() = default;
60
69 virtual OptionCollection parse(const std::filesystem::path & filename,
70 const std::string & additional_input = "") const = 0;
71};
72
73} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
A data structure that holds options of multiple objects.
Definition OptionCollection.h:38
A parser is responsible for parsing an input file into a collection of options which can be used by t...
Definition Parser.h:57
virtual OptionCollection parse(const std::filesystem::path &filename, const std::string &additional_input="") const =0
Deserialize a file.
Parser()=default
Definition CrossRef.cxx:32
ParserType
Definition Parser.h:33
@ XML
Definition Parser.h:35
@ YAML
Definition Parser.h:36
@ HIT
Definition Parser.h:34
@ AUTO
Definition Parser.h:37
void load_model(const std::string &path, const std::string &additional_input, ParserType ptype)
A convenient function to parse all options from an input file.
Definition Parser.cxx:32