OutputBase.hpp

Go to the documentation of this file.

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

#ifndef GEOSX_MANAGERS_OUTPUTS_OUTPUTBASE_HPP_
#define GEOSX_MANAGERS_OUTPUTS_OUTPUTBASE_HPP_

#include "dataRepository/Group.hpp"
#include "dataRepository/ExecutableGroup.hpp"


namespace geosx
{

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

  virtual ~OutputBase() override;

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

  virtual void SetupDirectoryStructure();

  // Catalog interface
  using CatalogInterface = dataRepository::CatalogInterface< OutputBase, std::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( Group * const group ) override;

private:
  string m_childDirectory;
  integer m_parallelThreads;

};


} /* namespace geosx */

#endif /* GEOSX_MANAGERS_OUTPUTS_OUTPUTBASE_HPP_ */