LinearSystem.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/base/LabeledAxisAccessor.h"
#include "neml2/misc/types.h"
 
namespace neml2
{
struct SparseTensorList;

class LinearSystem
{
public:
  LinearSystem() = default;
  LinearSystem(const LinearSystem &) = default;
  LinearSystem(LinearSystem &&) noexcept = default;
  LinearSystem & operator=(const LinearSystem &) = default;
  LinearSystem & operator=(LinearSystem &&) noexcept = default;
  virtual ~LinearSystem() = default;
 
  virtual void init();

  std::size_t m() const;
  std::size_t n() const;
  std::size_t p() const;

  virtual void set_u(const SparseTensorList &) = 0;
  virtual void set_g(const SparseTensorList &) = 0;
  virtual SparseTensorList u() const = 0;
  virtual SparseTensorList g() const = 0;

  virtual void u_changed();
  virtual void g_changed();

  SparseTensorList A();
  SparseTensorList b();
  std::tuple<SparseTensorList, SparseTensorList> A_and_b();
  std::tuple<SparseTensorList, SparseTensorList> A_and_B();
  std::tuple<SparseTensorList, SparseTensorList, SparseTensorList> A_and_B_and_b();

  const std::vector<LabeledAxisAccessor> & umap() const;
  const std::vector<TensorShape> & intmd_ulayout() const;
  const std::vector<TensorShape> & ulayout() const;

  const std::vector<LabeledAxisAccessor> & gmap() const;
  const std::vector<TensorShape> & intmd_glayout() const;
  const std::vector<TensorShape> & glayout() const;

  const std::vector<LabeledAxisAccessor> & bmap() const;
  const std::vector<TensorShape> & intmd_blayout() const;
  const std::vector<TensorShape> & blayout() const;
 
protected:
  virtual std::vector<LabeledAxisAccessor> setup_umap() = 0;
  virtual std::vector<TensorShape> setup_intmd_ulayout() = 0;
  virtual std::vector<TensorShape> setup_ulayout() = 0;

  virtual std::vector<LabeledAxisAccessor> setup_gmap() = 0;
  virtual std::vector<TensorShape> setup_intmd_glayout() = 0;
  virtual std::vector<TensorShape> setup_glayout() = 0;

  virtual std::vector<LabeledAxisAccessor> setup_bmap() = 0;
  virtual std::vector<TensorShape> setup_intmd_blayout() = 0;
  virtual std::vector<TensorShape> setup_blayout() = 0;

  virtual void assemble(SparseTensorList * A, SparseTensorList * B, SparseTensorList * b) = 0;

  virtual void pre_assemble(bool A, bool B, bool b);

  virtual void post_assemble(bool A, bool B, bool b);

  bool _A_up_to_date = false;
  bool _B_up_to_date = false;
  bool _b_up_to_date = false;

  std::vector<LabeledAxisAccessor> _umap;
  std::optional<std::vector<TensorShape>> _intmd_ulayout;
  std::vector<TensorShape> _ulayout;

  std::vector<LabeledAxisAccessor> _gmap;
  std::optional<std::vector<TensorShape>> _intmd_glayout;
  std::vector<TensorShape> _glayout;

  std::vector<LabeledAxisAccessor> _bmap;
  std::optional<std::vector<TensorShape>> _intmd_blayout;
  std::vector<TensorShape> _blayout;
 
private:
};
 
} // namespace neml2