NonlinearSolver.h

// Copyright 2024, UChicago Argonne, LLC
// All Rights Reserved
// Software Name: NEML2 -- the New Engineering material Model Library, version 2
// By: Argonne National Laboratory
// OPEN SOURCE LICENSE (MIT)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
 
#pragma once
 
#include "neml2/solvers/Solver.h"
#include "neml2/solvers/NonlinearSystem.h"
 
namespace neml2
{
class NonlinearSolver : public Solver
{
public:
  enum class RetCode
  {
    SUCCESS = 0,
    MAXITER = 1,
    FAILURE = 2
  };
 
  struct Result
  {
    RetCode ret = RetCode::FAILURE;
    NonlinearSystem::Sol<false> solution;
    std::size_t iterations = 0;
  };
 
public:
  static OptionSet expected_options();
 
  NonlinearSolver(const OptionSet & options);
 
  virtual Result solve(NonlinearSystem & system, const NonlinearSystem::Sol<false> & x0) = 0;
 
  Real atol;
  Real rtol;
  unsigned int miters;
};
} // namespace neml2