NEML2 1.4.0
Loading...
Searching...
No Matches
LinearKinematicHardening.cxx
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
25#include "neml2/models/solid_mechanics/LinearKinematicHardening.h"
26#include "neml2/tensors/SSR4.h"
27
28namespace neml2
29{
30register_NEML2_object(LinearKinematicHardening);
31
34{
36 options.doc() += " following a linear relationship, i.e., \\f$ \\boldsymbol{X} = H "
37 "\\boldsymbol{K}_p \\f$ where \\f$ H \\f$ is the hardening modulus.";
38
39 options.set<CrossRef<Scalar>>("hardening_modulus");
40 options.set("hardening_modulus").doc() = "Hardening modulus";
41
42 return options;
43}
44
46 : KinematicHardening(options),
47 _H(declare_parameter<Scalar>("H", "hardening_modulus"))
48{
49}
50
51void
53{
54 if (out)
55 _X = _H * _Kp;
56
57 if (dout_din)
59
60 if (d2out_din2)
61 {
62 // zero
63 }
64}
65} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
Definition KinematicHardening.h:32
Variable< SR2 > & _X
Back stress.
Definition KinematicHardening.h:43
const Variable< SR2 > & _Kp
Kinematic plastic strain.
Definition KinematicHardening.h:40
static OptionSet expected_options()
Definition KinematicHardening.cxx:30
Simple linear map between equivalent strain and hardening.
Definition LinearKinematicHardening.h:36
LinearKinematicHardening(const OptionSet &options)
Definition LinearKinematicHardening.cxx:45
const Scalar & _H
Hardening modulus.
Definition LinearKinematicHardening.h:46
static OptionSet expected_options()
Definition LinearKinematicHardening.cxx:33
void set_value(bool out, bool dout_din, bool d2out_din2) override
The map between input -> output, and optionally its derivatives.
Definition LinearKinematicHardening.cxx:52
const torch::TensorOptions & options() const
This model's tensor options.
Definition Model.h:116
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:59
static SSR4 identity_map(const torch::TensorOptions &options=default_tensor_options())
The derivative of a SR2 with respect to itself.
Definition SR2.cxx:116
The (logical) scalar.
Definition Scalar.h:38
Definition CrossRef.cxx:32