TimeHistoryOutput.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 TotalEnergies
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_FILEIO_OUTPUTS_HISTORYOUTPUT_HPP_
#define GEOS_FILEIO_OUTPUTS_HISTORYOUTPUT_HPP_
 
#include "OutputBase.hpp"
#include "fileIO/timeHistory/HistoryCollection.hpp"
#include "fileIO/timeHistory/BufferedHistoryIO.hpp"
#include "fileIO/timeHistory/HDFHistoryIO.hpp"
 
#include "LvArray/src/Array.hpp" // just for collector
 
namespace geos
{
 
class TimeHistoryOutput : public OutputBase
{
public:
  TimeHistoryOutput( string const & name,
                     Group * const parent );
 
  virtual ~TimeHistoryOutput() override
  { }
 
  static string catalogName() { return "TimeHistory"; }
 
  virtual void initializePostInitialConditionsPostSubGroups() override;
 
  virtual void reinit() override;
 
  void setFileName( string const & root );
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
  virtual void cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  struct viewKeys
  {
    static constexpr char const * timeHistoryOutputTargetString() { return "sources"; }
    static constexpr char const * timeHistoryOutputFilenameString() { return "filename"; }
    static constexpr char const * timeHistoryOutputFormatString() { return "format"; }
    static constexpr char const * timeHistoryRestartString() { return "restart"; }
 
    dataRepository::ViewKey timeHistoryOutputTarget = { "sources" };
    dataRepository::ViewKey timeHistoryOutputFilename = { "filename" };
    dataRepository::ViewKey timeHistoryOutputFormat = { "format" };
    dataRepository::ViewKey timeHistoryRestart = { "restart" };
  } timeHistoryOutputViewKeys;
 
#if defined(GEOS_USE_PYGEOSX)
  virtual PyTypeObject * getPythonType() const override;
#endif
 
protected:
  logInfo::OutputTimerBase const & getTimerCategory() const override;
 
private:
 
  void initCollectorParallel( DomainPartition const & domain, HistoryCollection & collector );
 
  string_array m_collectorPaths;
  string m_format;
  string m_filename;
  integer m_recordCount;
  std::vector< std::unique_ptr< BufferedHistoryIO > > m_io;
};
}
 
#endif