TimeHistoryOutput.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2019 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2019 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2019 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All right reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_TIME_HISTORY_OUTPUT_HPP_
#define GEOSX_TIME_HISTORY_OUTPUT_HPP_

#include "OutputBase.hpp"
#include "managers/TimeHistory/TimeHistoryCollection.hpp"
#include "managers/TimeHistory/HistoryIO.hpp"
#include "fileIO/timeHistory/TimeHistHDF.hpp"

#include "LvArray/src/Array.hpp" // just for collector

namespace geosx
{

class TimeHistoryOutput : public OutputBase
{
public:
  TimeHistoryOutput( string const & name,
                     Group * const parent );

  virtual ~TimeHistoryOutput() override
  { }

  static string CatalogName() { return "TimeHistory"; }

  virtual void InitializePostSubGroups( Group * const group ) override;

  virtual void Execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override;
  virtual void Cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        dataRepository::Group * domain ) override;

  struct viewKeys
  {
    static constexpr auto timeHistoryOutputTarget = "sources";
    static constexpr auto timeHistoryOutputFilename = "filename";
    static constexpr auto timeHistoryOutputFormat = "format";
    static constexpr auto timeHistoryRestart = "restart";
  } timeHistoryOutputViewKeys;

private:

  void initCollectorParallel( ProblemManager & problemManager, HistoryCollection * collector );

  string_array m_collectorPaths;
  string m_format;
  string m_filename;
  integer m_recordCount;
  std::vector< std::unique_ptr< BufferedHistoryIO > > m_io;
};
}

#endif