Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : // MOOSE includes
      13             : #include "SampledOutput.h"
      14             : 
      15             : /**
      16             :  * Class for output data to the TecplotII format
      17             :  */
      18             : class Tecplot : public SampledOutput
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   /**
      24             :    * Class constructor
      25             :    */
      26             :   Tecplot(const InputParameters & parameters);
      27             : 
      28          24 :   bool supportsMaterialPropertyOutput() const override { return true; }
      29             : 
      30             : protected:
      31             :   /**
      32             :    * Overload the Output::output method, this is required for Tecplot
      33             :    * output due to the method utilized for outputting single/global parameters
      34             :    */
      35             :   virtual void output() override;
      36             : 
      37             :   /**
      38             :    * Returns the current filename, this method handles adding the timestep suffix
      39             :    * @return A string containing the current filename to be written
      40             :    */
      41             :   virtual std::string filename() override;
      42             : 
      43             : private:
      44             :   /// Flag for binary output
      45             :   bool _binary;
      46             : 
      47             :   /// Flag for turning on appending to ASCII files
      48             :   bool _ascii_append;
      49             : 
      50             :   /// True if this is the first time the file has been written to,
      51             :   /// gets set to false after the first call to output().  If the user
      52             :   /// has set _ascii_append but _first_time==true, we won't actually
      53             :   /// append.  This prevents old data files in a directory from being
      54             :   /// appended to.  Declared as a reference so it can be restartable
      55             :   /// data, that way if we restart, we don't think it's the first time
      56             :   /// again.
      57             :   bool & _first_time;
      58             : };