NEML2 2.0.0
Loading...
Searching...
No Matches
OptionCollection.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
25#pragma once
26
27#include "neml2/base/OptionSet.h"
28#include "neml2/base/Settings.h"
29
30namespace neml2
31{
39{
40public:
42 OptionSet & settings() { return _settings; }
43
45 const OptionSet & settings() const { return _settings; }
46
48 operator std::map<std::string, std::map<std::string, OptionSet>>() const { return _data; }
49
51 std::map<std::string, OptionSet> & operator[](const std::string & section);
52
54 const std::map<std::string, OptionSet> & operator[](const std::string & section) const;
55
57 const std::map<std::string, std::map<std::string, OptionSet>> & data() const { return _data; }
58
59private:
62
64 std::map<std::string, std::map<std::string, OptionSet>> _data;
65};
66
67std::ostream & operator<<(std::ostream & os, const OptionCollection & p);
68} // namespace neml2
A data structure that holds options of multiple objects.
Definition OptionCollection.h:39
const OptionSet & settings() const
Get global settings.
Definition OptionCollection.h:45
const std::map< std::string, std::map< std::string, OptionSet > > & data() const
Get a read-only reference to the underlying data structure.
Definition OptionCollection.h:57
OptionSet & settings()
Get global settings.
Definition OptionCollection.h:42
std::map< std::string, OptionSet > & operator[](const std::string &section)
Get all the object options under a specific section.
Definition OptionCollection.cxx:30
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:85
static OptionSet expected_options()
Definition Settings.cxx:33
Definition CrossRef.cxx:31
std::ostream & operator<<(std::ostream &os, const EnumSelection &es)
Definition EnumSelection.cxx:31