NEML2 1.4.0
Loading...
Searching...
No Matches
RateIndependentPlasticFlowConstraint.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/RateIndependentPlasticFlowConstraint.h"
26
27namespace neml2
28{
30
33{
35 options.doc() = "Solve the consistent plasticity yield envelope by solving the equivalent "
36 "complementarity condition \\f[ r = \\dot{\\gamma} - f^p - "
37 "\\sqrt{{\\dot{\\gamma}}^2 + {f^p}^2} \\f]";
38
39 options.set<VariableName>("yield_function") = VariableName("state", "internal", "fp");
40 options.set("yield_function").doc() = "Yield function";
41
42 options.set<VariableName>("flow_rate") = VariableName("state", "internal", "gamma_rate");
43 options.set("flow_rate").doc() = "Flow rate";
44
45 return options;
46}
47
49 const OptionSet & options)
50 : Model(options),
51 _fp(declare_input_variable<Scalar>("yield_function")),
52 _gamma_dot(declare_input_variable<Scalar>("flow_rate")),
53 _r(declare_output_variable<Scalar>(
54 options.get<VariableName>("flow_rate").slice(1).on("residual")))
55{
56}
57
58void
60{
61 neml_assert_dbg(!d2out_din2, "Second derivative not implemented.");
62
63 const auto FB = _gamma_dot - _fp - math::sqrt(_gamma_dot * _gamma_dot + _fp * _fp);
64
65 if (out)
66 _r = FB;
67
68 if (dout_din)
69 {
70 const auto I = Scalar::identity_map(options());
73 }
74}
75
76} // namespace neml2
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
The accessor containing all the information needed to access an item in a LabeledAxis.
Definition LabeledAxisAccessor.h:44
The base class for all constitutive models.
Definition Model.h:53
const torch::TensorOptions & options() const
This model's tensor options.
Definition Model.h:116
static OptionSet expected_options()
Definition Model.cxx:33
A custom map-like data structure. The keys are strings, and the values can be nonhomogeneously typed.
Definition OptionSet.h:59
Definition RateIndependentPlasticFlowConstraint.h:32
RateIndependentPlasticFlowConstraint(const OptionSet &options)
Definition RateIndependentPlasticFlowConstraint.cxx:48
const Variable< Scalar > & _fp
Plastic yield function.
Definition RateIndependentPlasticFlowConstraint.h:42
Variable< Scalar > & _r
The residual for the consistency parameter equation.
Definition RateIndependentPlasticFlowConstraint.h:48
const Variable< Scalar > & _gamma_dot
Flow rate (rate of the consistency parameter)
Definition RateIndependentPlasticFlowConstraint.h:45
static OptionSet expected_options()
Definition RateIndependentPlasticFlowConstraint.cxx:32
void set_value(bool out, bool dout_din, bool d2out_din2) override
The map between input -> output, and optionally its derivatives.
Definition RateIndependentPlasticFlowConstraint.cxx:59
The (logical) scalar.
Definition Scalar.h:38
static Scalar identity_map(const torch::TensorOptions &options=default_tensor_options())
The derivative of a Scalar with respect to itself.
Definition Scalar.cxx:35
Derivative d(const VariableBase &x)
Create a wrapper representing the derivative dy/dx.
Definition Variable.cxx:102
Derived sqrt(const Derived &a)
Definition BatchTensorBase.h:439
Definition CrossRef.cxx:32
void neml_assert_dbg(bool assertion, Args &&... args)
Definition error.h:85
LabeledAxisAccessor VariableName
Definition Variable.h:35