ChomboIO.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_CHOMBOIO_HPP_
#define GEOS_FILEIO_OUTPUTS_CHOMBOIO_HPP_
 
#include "OutputBase.hpp"
#include "fileIO/coupling/ChomboCoupler.hpp"
 
namespace geos
{
 
class ChomboIO final : public OutputBase
{
public:
  ChomboIO( string const & name, Group * const parent );
 
  virtual ~ChomboIO() override;
 
  static string catalogName()
  { return "ChomboIO"; }
 
  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
  {
    m_waitForInput = 0;
    execute( time_n, 0.0, cycleNumber, eventCounter, eventProgress, domain );
  }
 
  struct viewKeyStruct
  {
    static constexpr char const * outputPathString() { return "outputPath"; }
    static constexpr char const * beginCycleString() { return "beginCycle"; }
    static constexpr char const * inputPathString() { return "inputPath"; }
    static constexpr char const * waitForInputString() { return "waitForInput"; }
    static constexpr char const * useChomboPressuresString() { return "useChomboPressures"; }
 
    dataRepository::ViewKey outputPath = { outputPathString() };
    dataRepository::ViewKey beginCycle = { beginCycleString() };
    dataRepository::ViewKey inputPath = { inputPathString() };
    dataRepository::ViewKey waitForInput = { waitForInputString() };
    dataRepository::ViewKey useChomboPressures = { useChomboPressuresString() };
  } viewKeys;
 
protected:
  logInfo::OutputTimerBase const & getTimerCategory() const override;
 
private:
  ChomboCoupler * m_coupler;
  string m_outputPath;
  double m_beginCycle;
  string m_inputPath;
  integer m_waitForInput;
  integer m_useChomboPressures;
};
 
 
} /* namespace geos */
 
#endif /* GEOS_FILEIO_OUTPUTS_CHOMBOIO_HPP_ */