TransientDriver.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 <filesystem>
 
#include "neml2/drivers/ModelDriver.h"
 
namespace torch::nn
{
class ModuleDict;
}
 
namespace neml2
{
class TransientDriver : public ModelDriver
{
public:
  static OptionSet expected_options();
 
  TransientDriver(const OptionSet & options);
 
  void setup() override;
 
  void diagnose() const override;
 
  bool run() override;
 
protected:
  virtual bool solve();
 
  // @{ Routines that are called every step
  virtual void advance_step();
  virtual void update_forces();
  virtual void apply_ic();
  virtual void apply_predictor();
  virtual void solve_step();
  virtual void postprocess();
  virtual void store_input();
  // @}
 
  const VariableName _time_name;
  Scalar _time;
  Size _step_count = 0;
  const Size _nsteps;
  ValueMap _in;
 
  const EnumSelection _predictor;
 
  std::vector<ValueMap> _result_in;
  std::vector<ValueMap> _result_out;
 
  std::vector<VariableName> _driving_force_names;
  std::vector<Tensor> _driving_forces;
 
public:
  virtual torch::nn::ModuleDict result() const;
  virtual std::string save_as_path() const;
 
protected:
  virtual void output() const;
 
  std::string _save_as;
 
private:
  void output_pt(const std::filesystem::path & out) const;
 
  bool _has_input_state = false;
};
} // namespace neml2