Newton.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/NonlinearSolver.h"
#include "neml2/misc/math.h"
 
namespace neml2
{
class Newton : public NonlinearSolver
{
public:
  static OptionSet expected_options();
 
  Newton(const OptionSet & options);
 
  Result solve(NonlinearSystem & system, const NonlinearSystem::Sol<false> & x0) override;
 
protected:
  virtual void prepare(const NonlinearSystem & /*system*/, const NonlinearSystem::Sol<true> & /*x*/)
  {
  }
 
  virtual bool converged(size_t itr, const torch::Tensor & nR, const torch::Tensor & nR0) const;
 
  virtual void update(NonlinearSystem & system,
                      NonlinearSystem::Sol<true> & x,
                      const NonlinearSystem::Res<true> & r,
                      const NonlinearSystem::Jac<true> & J);
 
  virtual void final_update(NonlinearSystem & system,
                            NonlinearSystem::Sol<true> & x,
                            const NonlinearSystem::Res<true> & r,
                            const NonlinearSystem::Jac<true> & J);
 
  virtual NonlinearSystem::Sol<true> solve_direction(const NonlinearSystem::Res<true> & r,
                                                     const NonlinearSystem::Jac<true> & J);
};
} // namespace neml2