ComposedModel.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/models/Model.h"
#include "neml2/base/DependencyResolver.h"
 
#include <future>
 
namespace neml2
{
class ComposedModel : public Model
{
public:
  static OptionSet expected_options();
 
  ComposedModel(const OptionSet & options);
 
  virtual void check_AD_limitation() const override;
 
  virtual std::map<std::string, const VariableBase *>
  named_nonlinear_parameters(bool recursive = false) const override;
 
  virtual std::map<std::string, Model *>
  named_nonlinear_parameter_models(bool recursive = false) const override;
 
  virtual void setup() override;
 
  using AssemblyIndices = std::map<indexing::TensorIndex,
                                   std::pair<indexing::TensorIndex, Model *>,
                                   LabeledAxis::AssemblySliceCmp>;
 
protected:
  virtual void allocate_variables(bool in, bool out) override;
 
  virtual void setup_submodel_input_views(VariableStore * host) override;
 
  virtual void setup_output_views() override;
 
  void set_value(bool, bool, bool) override;
 
private:
  AssemblyIndices consolidate(const AssemblyIndices & indices) const;
 
  void set_value_async(Model * i, bool out, bool dout_din, bool d2out_din2);
 
  void apply_chain_rule(Model * i);
 
  void apply_second_order_chain_rule(Model * i);
 
  void rethrow_exceptions() const;
 
  const std::vector<VariableName> _additional_outputs;
 
  const bool _auto_nl_param;
 
  DependencyResolver<Model, VariableName> _dependency;
 
  std::map<Model *, AssemblyIndices> _assembly_indices;
 
  std::map<Model *, std::vector<Tensor>> _dpin_din_views;
 
  std::map<Model *, LabeledMatrix> _dpout_din;
 
  std::map<Model *, std::vector<Tensor>> _d2pin_din2_views;
 
  std::map<Model *, LabeledTensor3D> _d2pout_din2;
 
  std::map<Model *, std::future<void>> _async_results;
 
  std::map<std::thread::id, std::exception_ptr> _async_exceptions;
};
} // namespace neml2