NEML2 1.4.0
Loading...
Searching...
No Matches
SingleSlipStrengthMap.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/crystal_plasticity/SingleSlipStrengthMap.h"
26
27namespace neml2
28{
29register_NEML2_object(SingleSlipStrengthMap);
30
33{
35
36 options.doc() =
37 "Calculates the slip system strength for all slip systems as \\f$ \\hat{\\tau}_i = "
38 "\\bar{\\tau} + \\tau_0 \\f$ where \\f$ \\hat{\\tau}_i \\f$ is the strength for slip system "
39 "i, \\f$ \\bar{\\tau} \\f$ is an evolving slip system strength (one value of all systems), "
40 "defined by another object, and \\f$ \\tau_0 \\f$ is a constant strength.";
41
42 options.set<VariableName>("slip_hardening") = VariableName("state", "internal", "slip_hardening");
43 options.set("slip_hardening").doc() = "The name of the evovling, scalar strength";
44
45 options.set<CrossRef<Scalar>>("constant_strength");
46 options.set("constant_strength").doc() = "The constant slip system strength";
47
48 return options;
49}
50
52 : SlipStrengthMap(options),
53 _tau_bar(declare_input_variable<Scalar>("slip_hardening")),
54 _tau_const(declare_parameter<Scalar>("constant_strength", "constant_strength"))
55{
56}
57
58void
60{
61 neml_assert_dbg(!d2out_din2, "Second derivative not implemented.");
62
63 if (out)
64 _tau = (_tau_bar + _tau_const).base_unsqueeze(0).base_expand_as(_tau.value());
65
66 if (dout_din)
67 _tau.d(_tau_bar) = Scalar::ones(options()).base_expand_as(_tau.d(_tau_bar).value());
68}
69} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
static Scalar ones(const torch::TensorOptions &options=default_tensor_options())
Unbatched unit tensor.
Definition FixedDimTensor.h:161
The accessor containing all the information needed to access an item in a LabeledAxis.
Definition LabeledAxisAccessor.h:44
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
The (logical) scalar.
Definition Scalar.h:38
A map between the internal variables and the slip strength, for the case where all systems share the ...
Definition SingleSlipStrengthMap.h:33
const Scalar & _tau_const
Constant strength to offset the slip hardening.
Definition SingleSlipStrengthMap.h:48
SingleSlipStrengthMap(const OptionSet &options)
Setup from options.
Definition SingleSlipStrengthMap.cxx:51
const Variable< Scalar > & _tau_bar
Slip hardening variable.
Definition SingleSlipStrengthMap.h:45
static OptionSet expected_options()
Definition SingleSlipStrengthMap.cxx:32
void set_value(bool out, bool dou2_din, bool d2out_din2) override
Set the slip system strengths and associated derivatives.
Definition SingleSlipStrengthMap.cxx:59
Parent class of maps between internal variables and the slip system strengths.
Definition SlipStrengthMap.h:35
Variable< BatchTensor > & _tau
Slip strengths.
Definition SlipStrengthMap.h:46
static OptionSet expected_options()
Definition SlipStrengthMap.cxx:34
Definition CrossRef.cxx:32
void neml_assert_dbg(bool assertion, Args &&... args)
Definition error.h:85
LabeledAxisAccessor VariableName
Definition Variable.h:35