NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
VariableRate.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/models/Model.h"
28
29namespace neml2
30{
31class Scalar;
32class Vec;
33class SR2;
34
35template <typename T>
36class VariableRate : public Model
37{
38public:
40
41 VariableRate(const OptionSet & options);
42
43 void diagnose() const override;
44
45protected:
46 void set_value(bool out, bool dout_din, bool d2out_din2) override;
47
49 const Variable<T> & _v;
50
53
56
59
62};
63} // namespace neml2
Model(const OptionSet &options)
Construct a new Model object.
Definition Model.cxx:110
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:52
The symmetric second order tensor.
Definition SR2.h:46
Scalar.
Definition Scalar.h:38
Variable< Scalar > & _dv_dt
Definition VariableRate.h:61
const Variable< Scalar > & _t
Definition VariableRate.h:55
VariableRate(const OptionSet &options)
Definition VariableRate.cxx:55
const Variable< Scalar > & _tn
Definition VariableRate.h:58
const Variable< Scalar > & _vn
Definition VariableRate.h:52
const Variable< Scalar > & _v
Definition VariableRate.h:49
void diagnose() const override
Check for common problems.
Definition VariableRate.cxx:69
static OptionSet expected_options()
Definition VariableRate.cxx:35
void set_value(bool out, bool dout_din, bool d2out_din2) override
The map between input -> output, and optionally its derivatives.
Definition VariableRate.cxx:77
Concrete definition of a variable.
Definition Variable.h:236
3-vector.
Definition Vec.h:42
Definition DiagnosticsInterface.cxx:30