NEML2ModelExecutor.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "NEML2ModelInterface.h"
#include "GeneralUserObject.h"
#include "NEML2BatchIndexGenerator.h"
 
class MOOSEToNEML2;
 
class NEML2ModelExecutor : public NEML2ModelInterface<GeneralUserObject>
{
public:
  static InputParameters actionParams();
 
  static InputParameters validParams();
 
  NEML2ModelExecutor(const InputParameters & params);
 
#ifndef NEML2_ENABLED
  void initialize() override {}
  void execute() override {}
  void finalize() override {}
#else
  void initialize() override;
  void meshChanged() override;
  void execute() override;
  void finalize() override;
 
  void initialSetup() override;
 
  std::size_t getBatchIndex(dof_id_type elem_id) const;
 
  const neml2::Tensor & getOutput(const neml2::VariableName & output_name) const;
 
  const neml2::Tensor & getOutputDerivative(const neml2::VariableName & output_name,
                                            const neml2::VariableName & input_name) const;
 
  const neml2::Tensor & getOutputParameterDerivative(const neml2::VariableName & output_name,
                                                     const std::string & parameter_name) const;
 
  bool outputReady() const { return _output_ready; }
 
protected:
  virtual void addGatheredVariable(const UserObjectName &, const neml2::VariableName &);
 
  virtual void addGatheredParameter(const UserObjectName &, const std::string &);
 
  virtual void checkExecutionStage() const final;
 
  virtual void fillInputs();
 
  virtual bool solve();
 
  virtual void extractOutputs();
 
  virtual void expandInputs();
 
  void advanceState();
 
  const NEML2BatchIndexGenerator & _batch_index_generator;
 
  const bool _manage_state_advance;
 
  const bool _debug_inputs_on_failure;
 
  bool _output_ready;
 
  std::map<std::string, neml2::Tensor> _model_params;
 
  neml2::ValueMap _in;
 
  neml2::ValueMap _out;
 
  neml2::ValueMap _state_vars;
 
  neml2::DerivMap _dout_din;
 
  // set of gathered NEML2 input variables
  std::set<neml2::VariableName> _gathered_variable_names;
 
  // set of gathered NEML2 model parameters
  std::set<std::string> _gathered_parameter_names;
 
  std::vector<const MOOSEToNEML2 *> _gatherers;
  std::vector<const MOOSEToNEML2 *> _param_gatherers;
 
  mutable neml2::ValueMap _retrieved_outputs;
 
  mutable neml2::DerivMap _retrieved_derivatives;
 
  mutable std::map<neml2::VariableName, std::map<std::string, neml2::Tensor>>
      _retrieved_parameter_derivatives;
 
private:
  bool _error;
  std::string _error_message;
#endif
};