NEML2 1.4.0
Loading...
Searching...
No Matches
NewtonWithTrustRegion.h
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#pragma once
26
27#include "neml2/solvers/Newton.h"
28#include "neml2/solvers/TrustRegionSubProblem.h"
29
30namespace neml2
31{
99} // namespace neml2
Definition BatchTensor.h:32
The wrapper (decorator) for cross-referencing unresolved values at parse time.
Definition CrossRef.h:52
The nonlinear solver solves a nonlinear system of equations.
Definition NewtonWithTrustRegion.h:47
Newton _subproblem_solver
Solver used to solver the trust-region subproblem.
Definition NewtonWithTrustRegion.h:73
virtual BatchTensor solve_direction(const NonlinearSystem &system) override
Find the current update direction.
Definition NewtonWithTrustRegion.cxx:164
Real _reduce_criteria
Criteria for reducing the trust region.
Definition NewtonWithTrustRegion.h:85
Real _reduce_factor
Cutback factor if we do reduce the trust region.
Definition NewtonWithTrustRegion.h:91
TrustRegionSubProblem _subproblem
Trust-region subproblem.
Definition NewtonWithTrustRegion.h:70
OptionSet subproblem_solver_options(const OptionSet &) const
Extract options for the subproblem solver.
Definition NewtonWithTrustRegion.cxx:103
Real _delta_max
Maximum size of the trust region.
Definition NewtonWithTrustRegion.h:82
Scalar merit_function_reduction(const NonlinearSystem &system, const BatchTensor &p) const
Reduction in the merit function.
Definition NewtonWithTrustRegion.cxx:193
Real _delta_0
Initial size of the trust region.
Definition NewtonWithTrustRegion.h:79
OptionSet subproblem_options(const OptionSet &) const
Extract options for the subproblem.
Definition NewtonWithTrustRegion.cxx:96
NewtonWithTrustRegion(const OptionSet &options)
Definition NewtonWithTrustRegion.cxx:81
Real _expand_factor
Expansion factor if we do increase the trust region.
Definition NewtonWithTrustRegion.h:94
Scalar _delta
The trust region radius.
Definition NewtonWithTrustRegion.h:76
Real _accept_criteria
Acceptance criteria for a step.
Definition NewtonWithTrustRegion.h:97
virtual void update(NonlinearSystem &system, BatchTensor &x) override
Update trial solution.
Definition NewtonWithTrustRegion.cxx:119
static OptionSet expected_options()
Definition NewtonWithTrustRegion.cxx:35
Real _expand_criteria
Criteria for expanding the trust region.
Definition NewtonWithTrustRegion.h:88
virtual void prepare(const NonlinearSystem &system, const BatchTensor &x) override
Prepare solver internal data before the iterative update.
Definition NewtonWithTrustRegion.cxx:113
The nonlinear solver solves a nonlinear system of equations.
Definition Newton.h:39
Definition of a nonlinear system of equations.
Definition NonlinearSystem.h:37
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
Definition TrustRegionSubProblem.h:38
Definition CrossRef.cxx:32