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/equation_systems/AxisLayout.h"
 
namespace neml2
{
struct AssembledVector;
struct AssembledMatrix;

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();

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

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

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

  AxisLayout ulayout() const;
  AxisLayout glayout() const;
  AxisLayout blayout() const;
 
protected:
  virtual std::shared_ptr<AxisLayout> setup_ulayout() = 0;
  virtual std::shared_ptr<AxisLayout> setup_glayout() = 0;
  virtual std::shared_ptr<AxisLayout> setup_blayout() = 0;

  virtual void assemble(AssembledMatrix * A, AssembledMatrix * B, AssembledVector * 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::shared_ptr<AxisLayout> _ulayout;
  std::shared_ptr<AxisLayout> _glayout;
  std::shared_ptr<AxisLayout> _blayout;
};
 
} // namespace neml2