NEML2 2.0.0
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
HermiteSmoothStep.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{
32{
33public:
35
36 HermiteSmoothStep(const OptionSet & options);
37
38protected:
39 void set_value(bool out, bool dout_din, bool d2out_din2) override;
40
43
46
48 const Scalar & _x0;
49
51 const Scalar & _x1;
52
54 const bool _comp_cond;
55};
56} // namespace neml2
Variable< Scalar > & _y
Value of the smooth step function.
Definition HermiteSmoothStep.h:45
const Scalar & _x0
Lower bound of the argument.
Definition HermiteSmoothStep.h:48
const bool _comp_cond
Complementary condition.
Definition HermiteSmoothStep.h:54
const Variable< Scalar > & _x
Argument of the smooth step function.
Definition HermiteSmoothStep.h:42
const Scalar & _x1
Upper bound of the argument.
Definition HermiteSmoothStep.h:51
static OptionSet expected_options()
Definition HermiteSmoothStep.cxx:34
HermiteSmoothStep(const OptionSet &options)
Definition HermiteSmoothStep.cxx:57
void set_value(bool out, bool dout_din, bool d2out_din2) override
The map between input -> output, and optionally its derivatives.
Definition HermiteSmoothStep.cxx:68
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
Scalar.
Definition Scalar.h:38
Concrete definition of a variable.
Definition Variable.h:236
Definition DiagnosticsInterface.cxx:30