NEML2 1.4.0
Loading...
Searching...
No Matches
Data.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/NEML2Object.h"
28#include "neml2/models/BufferStore.h"
29
30#include "neml2/base/Registry.h"
31#include "neml2/base/Factory.h"
32
33namespace neml2
34{
35class Data : public NEML2Object, public BufferStore
36{
37public:
39
45 Data(const OptionSet & options);
46
48 const std::vector<Data *> & registered_data() const { return _registered_data; }
49
50protected:
54 template <typename T, typename = typename std::enable_if_t<std::is_base_of_v<Data, T>>>
55 T & register_data(const std::string & name)
56 {
58 extra_opts.set<NEML2Object *>("_host") = host();
59
60 auto data = Factory::get_object_ptr<Data>("Data", name, extra_opts);
61 _registered_data.push_back(data.get());
62 return *(std::dynamic_pointer_cast<T>(data));
63 }
64
66 std::vector<Data *> _registered_data;
67};
68} // namespace neml2
Interface for object which can store buffers.
Definition BufferStore.h:41
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:56
Definition Data.h:36
T & register_data(const std::string &name)
Definition Data.h:55
const std::vector< Data * > & registered_data() const
All the registered data objects.
Definition Data.h:48
std::vector< Data * > _registered_data
Registered Data objects.
Definition Data.h:66
Data(const OptionSet &options)
Construct a new Data object.
Definition Data.cxx:37
static OptionSet expected_options()
Definition Data.cxx:30
The base class of all "manufacturable" objects in the NEML2 library.
Definition NEML2Object.h:38
const std::string & name() const
A readonly reference to the object's name.
Definition NEML2Object.h:65
const T * host() const
Get a readonly pointer to the host.
Definition NEML2Object.h:90
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:100
Definition CrossRef.cxx:30