NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
WR2ImplicitExponentialTimeIntegration.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 Rot;
33class WR2;
34
36// This function takes as input a skew tensor giving the spin and does the rotational update
38{
39public:
41
43
44 void diagnose() const override;
45
46private:
48 const VariableName _var_name;
49
51 const VariableName _var_rate_name;
52
53protected:
55 void set_value(bool out, bool dout_din, bool d2out_din2) override;
56
59
62
65
68
71
74};
75} // 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
Rotation stored as modified Rodrigues parameters.
Definition Rot.h:49
Scalar.
Definition Scalar.h:38
Concrete definition of a variable.
Definition Variable.h:236
const Variable< WR2 > & _s_dot
Current variable spin rate.
Definition WR2ImplicitExponentialTimeIntegration.h:64
WR2ImplicitExponentialTimeIntegration(const OptionSet &options)
Definition WR2ImplicitExponentialTimeIntegration.cxx:60
Variable< Rot > & _r
Nonlinear residual.
Definition WR2ImplicitExponentialTimeIntegration.h:73
const Variable< Scalar > & _t
Current time.
Definition WR2ImplicitExponentialTimeIntegration.h:67
const Variable< Scalar > & _tn
Previous time.
Definition WR2ImplicitExponentialTimeIntegration.h:70
void diagnose() const override
Check for common problems.
Definition WR2ImplicitExponentialTimeIntegration.cxx:75
static OptionSet expected_options()
Definition WR2ImplicitExponentialTimeIntegration.cxx:38
const Variable< Rot > & _sn
Previous value.
Definition WR2ImplicitExponentialTimeIntegration.h:61
const Variable< Rot > & _s
Current guess at next value.
Definition WR2ImplicitExponentialTimeIntegration.h:58
void set_value(bool out, bool dout_din, bool d2out_din2) override
Perform the update by defining the nonlinear residual and it's derivatives.
Definition WR2ImplicitExponentialTimeIntegration.cxx:84
A skew-symmetric second order tensor, represented as an axial vector.
Definition WR2.h:43
Definition DiagnosticsInterface.cxx:30
LabeledAxisAccessor VariableName
Definition LabeledAxisAccessor.h:185