Line data    Source code

       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              : #include "neml2/solvers/NonlinearSolver.h"
      26              : 
      27              : namespace neml2
      28              : {
      29              : OptionSet
      30           18 : NonlinearSolver::expected_options()
      31              : {
      32           18 :   OptionSet options = Solver::expected_options();
      33              : 
      34           36 :   options.set<double>("abs_tol") = 1e-10;
      35           36 :   options.set("abs_tol").doc() = "Absolute tolerance in the convergence criteria";
      36              : 
      37           36 :   options.set<double>("rel_tol") = 1e-8;
      38           36 :   options.set("rel_tol").doc() = "Relative tolerance in the convergence criteria";
      39              : 
      40           36 :   options.set<unsigned int>("max_its") = 100;
      41           36 :   options.set("max_its").doc() =
      42           18 :       "Maximum number of iterations allowed before issuing an error/exception";
      43              : 
      44           18 :   return options;
      45            0 : }
      46              : 
      47           21 : NonlinearSolver::NonlinearSolver(const OptionSet & options)
      48              :   : Solver(options),
      49           42 :     atol(options.get<double>("abs_tol")),
      50           42 :     rtol(options.get<double>("rel_tol")),
      51           42 :     miters(options.get<unsigned int>("max_its"))
      52              : {
      53           21 : }
      54              : } // namespace neml2