Checkpoint.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

// MOOSE includes
#include "FileOutput.h"
#include "AutoCheckpointAction.h"

#include <deque>
#include <filesystem>

enum CheckpointType : unsigned short
{
  SYSTEM_CREATED,
  USER_CREATED
};

class MaterialPropertyStorage;

struct CheckpointFileNames
{
  std::string checkpoint;

  std::vector<std::filesystem::path> restart;

  bool operator==(const CheckpointFileNames & rhs) const
  {
    // Compare the relevant members for equality
    return (this->checkpoint == rhs.checkpoint) && (this->restart == rhs.restart);
  }
};

class Checkpoint : public FileOutput
{

  friend class AutoCheckpointAction;

public:
  static InputParameters validParams();

  Checkpoint(const InputParameters & parameters);

  virtual std::string filename() override;

  std::string directory() const;

  void setAutosaveFlag(CheckpointType flag) { _checkpoint_type = flag; }

  std::stringstream checkpointInfo() const;

  bool supportsMaterialPropertyOutput() const override { return true; }

protected:
  virtual void output() override;

  virtual bool shouldOutput() override;

private:
  void updateCheckpointFiles(CheckpointFileNames file_struct);

  void validateExecuteOn() const;

  CheckpointType _checkpoint_type;

  unsigned int _num_files;

  const std::string _suffix;

  std::deque<CheckpointFileNames> _file_names;
};