NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
TensorValue.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 "neml2/tensors/Tensor.h"
27
28namespace neml2
29{
30// Forward declaration
31enum class TensorType : int8_t;
32
64
68{
69public:
70 explicit TensorValue(T value)
71 : _value(std::move(value))
72 {
73 }
74
75 void to_(const torch::TensorOptions & options) override;
76 void requires_grad_(bool req = true) override;
77 operator Tensor() const override;
78 void operator=(const Tensor & val) override;
79 TensorType type() const override;
80 T & value() { return _value; }
81
82private:
83 T _value;
84};
85} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:54
The base class to allow us to set up a polymorphic container of Tensors. The concrete definitions wil...
Definition TensorValue.h:39
TensorValueBase(const TensorValueBase &)=default
TensorValueBase(TensorValueBase &&) noexcept=default
TensorValueBase & operator=(const TensorValueBase &)=default
virtual TensorType type() const =0
Tensor type.
virtual void requires_grad_(bool req=true)=0
Require grad.
virtual void to_(const torch::TensorOptions &)=0
Send the value to the target options.
Concrete definition of tensor value.
Definition TensorValue.h:68
T & value()
Definition TensorValue.h:80
TensorValue(T value)
Definition TensorValue.h:70
Definition Tensor.h:47
Definition CrossRef.cxx:31
TensorType
Definition tensors.h:61