FileOutput.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://www.mooseframework.org
//*
//* 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 "PetscOutput.h"

// Forward declerations
class FileOutput;

template <>
InputParameters validParams<FileOutput>();

class FileOutput : public PetscOutput
{
public:
  FileOutput(const InputParameters & parameters);

  virtual std::string filename();

  void setFileNumber(unsigned int num);

  unsigned int getFileNumber();

  static std::string getOutputFileBase(const MooseApp & app, std::string suffix = "_out");

protected:
  virtual bool shouldOutput(const ExecFlagType & type) override;

  bool checkFilename();

  std::string _file_base;

  unsigned int & _file_num;

  unsigned int _padding;

  std::vector<std::string> _output_if_base_contains;

private:
  // OutputWarehouse needs access to _file_num for MultiApp ninja wizardry (see
  // OutputWarehouse::merge)
  friend class OutputWarehouse;
};