NonlinearSystem.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/tensors/Tensor.h"
#include "neml2/base/OptionSet.h"
 
namespace neml2
{
class NonlinearSystem
{
public:
  static OptionSet expected_options();
 
  static void disable_automatic_scaling(OptionSet & options);
 
  static void enable_automatic_scaling(OptionSet & options);
 
  NonlinearSystem(const OptionSet & options);
 
  virtual void init_scaling(const bool verbose = false);
 
  Tensor scale_residual(const Tensor & r) const;
  Tensor scale_Jacobian(const Tensor & J) const;
  Tensor scale_direction(const Tensor & p) const;
 
  virtual void set_solution(const Tensor & x);
 
  virtual Tensor solution() const { return _solution; }
 
  Tensor residual(const Tensor & x);
  void residual();
 
  Tensor Jacobian(const Tensor & x);
  void Jacobian();
 
  std::tuple<Tensor, Tensor> residual_and_Jacobian(const Tensor & x);
  void residual_and_Jacobian();
 
  const Tensor & get_residual() const { return _scaled_residual; }
  const Tensor & get_Jacobian() const { return _scaled_Jacobian; }
 
  Tensor residual_norm() const;
 
  virtual bool is_AD_enabled() const { return true; }
  virtual bool is_AD_disabled() const final { return !is_AD_enabled(); }
 
protected:
  virtual void assemble(bool residual, bool Jacobian) = 0;
 
  Size _ndof;
 
  Tensor _solution;
 
  Tensor _residual;
 
  Tensor _Jacobian;
 
  Tensor _scaled_residual;
 
  Tensor _scaled_Jacobian;
 
  const bool _autoscale;
 
  const Real _autoscale_tol;
 
  const unsigned int _autoscale_miter;
 
  bool _scaling_matrices_initialized;
 
  Tensor _row_scaling;
 
  Tensor _col_scaling;
};
} // namespace neml2