OutputBase.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_OUTPUTBASE_HPP_
#define GEOS_FILEIO_OUTPUTS_OUTPUTBASE_HPP_
 
#include "dataRepository/Group.hpp"
#include "dataRepository/ExecutableGroup.hpp"
#include "dataRepository/LogLevelsInfo.hpp"  // For logInfo namespace
#include "common/Timer.hpp"
 
namespace geos
{
 
namespace logInfo
{
struct OutputTimers
{
  static std::string_view getDescription() { return "Output timing information"; }
 
  static constexpr int getMinLogLevel() { return 1; }
};
 
struct OutputTimerBase
{
  virtual std::string_view getDescription() const = 0;
};
}
 
class OutputBase : public ExecutableGroup
{
public:
  explicit OutputBase( string const & name, Group * const parent );
 
  virtual ~OutputBase() override;
 
  static void setOutputDirectory( string const & outputDir );
 
  static string const & getOutputDirectory();
 
  static void setFileNameRoot( string const & root );
 
  static string const & getFileNameRoot();
 
  virtual void setupDirectoryStructure();
 
  // Catalog interface
  using CatalogInterface = dataRepository::CatalogInterface< OutputBase, string const &, Group * const >;
  static CatalogInterface::CatalogType & getCatalog();
 
  // Catalog view keys
  struct viewKeysStruct
  {
    static constexpr auto childDirectoryString = "childDirectory";
    static constexpr auto parallelThreadsString = "parallelThreads";
  } outputBaseViewKeys;
 
  string childDirectory() const { return m_childDirectory; }
 
  integer parallelThreads() const { return m_parallelThreads; }
 
 
 
protected:
  virtual void initializePreSubGroups() override;
 
  std::chrono::system_clock::duration m_outputTimer;
 
  virtual logInfo::OutputTimerBase const & getTimerCategory() const = 0;
 
  virtual void cleanup( real64 const time_n,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
private:
  string m_childDirectory;
  integer m_parallelThreads;
 
};
 
 
} /* namespace geos */
 
#endif /* GEOS_FILEIO_OUTPUTS_OUTPUTBASE_HPP_ */