NonlinearSystem.h

// Copyright 2023, 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/BatchTensor.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);
 
  BatchTensor scale_residual(const BatchTensor & r) const;
  BatchTensor scale_Jacobian(const BatchTensor & J) const;
  BatchTensor scale_direction(const BatchTensor & p) const;
 
  virtual void set_solution(const BatchTensor & x);
 
  virtual BatchTensor solution() const { return _solution; }
 
  BatchTensor residual(const BatchTensor & x);
  void residual();
 
  BatchTensor Jacobian(const BatchTensor & x);
  void Jacobian();
 
  std::tuple<BatchTensor, BatchTensor> residual_and_Jacobian(const BatchTensor & x);
  void residual_and_Jacobian();
 
  const BatchTensor & residual_view() const { return _autoscale ? _scaled_residual : _residual; }
  const BatchTensor & Jacobian_view() const { return _autoscale ? _scaled_Jacobian : _Jacobian; }
 
  BatchTensor residual_norm() const;
 
protected:
  virtual void assemble(bool residual, bool Jacobian) = 0;
 
  TorchSize _ndof;
 
  BatchTensor _solution;
 
  BatchTensor _residual;
 
  BatchTensor _Jacobian;
 
  BatchTensor _scaled_residual;
 
  BatchTensor _scaled_Jacobian;
 
  const bool _autoscale;
 
  const Real _autoscale_tol;
 
  const unsigned int _autoscale_miter;
 
  bool _scaling_matrices_initialized;
 
  BatchTensor _row_scaling;
 
  BatchTensor _col_scaling;
};
} // namespace neml2