ModelNonlinearSystem.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"
#include "neml2/equation_systems/EquationSystem.h"
#include "neml2/equation_systems/NonlinearSystem.h"
#include "neml2/models/ParameterStore.h"
#include "neml2/models/BufferStore.h"
 
namespace neml2
{
class Model;

class ModelNonlinearSystem : public EquationSystem,
                             public NonlinearSystem,
                             public ParameterStore,
                             public BufferStore
{
public:
  static OptionSet expected_options();
 
  ModelNonlinearSystem(const OptionSet & options);
 
  const std::shared_ptr<Model> & model_ptr() const { return _model; }
  const Model & model() const { return *_model; }
  Model & model() { return *_model; }
 
  void setup() override;
 
  void to(const TensorOptions &) override;
 
  void set_u(const AssembledVector &) override;
  void set_g(const AssembledVector &) override;
 
  AssembledVector u() const override;
  AssembledVector g() const override;
 
protected:
  std::shared_ptr<AxisLayout> setup_ulayout() override;
  std::shared_ptr<AxisLayout> setup_glayout() override;
  std::shared_ptr<AxisLayout> setup_blayout() override;
 
  void assemble(AssembledMatrix * A, AssembledMatrix * B, AssembledVector * b) override;
  void pre_assemble(bool A, bool B, bool b) override;
  void post_assemble(bool A, bool B, bool b) override;
 
private:
  void update_layouts();
  bool _layouts_updated = false;

  const std::vector<std::vector<VariableName>> _unknown_groups;
  std::vector<std::vector<VariableName>> _residual_groups;
  const std::vector<AxisLayout::IStructure> _unknown_istrs;
  const std::vector<AxisLayout::IStructure> _residual_istrs;
 
  std::shared_ptr<Model> _model;
};
 
} // namespace neml2