GEOS
PythonOutput.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 Total, S.A
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
21 #define GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
22 
24 
25 namespace geos
26 {
27 
32 class PythonOutput : public OutputBase
33 {
34 public:
35 
41  PythonOutput( string const & name,
42  Group * const parent ):
43  OutputBase( name, parent )
44  {}
45 
49  virtual ~PythonOutput() override
50  {}
51 
56  static string catalogName() { return "Python"; }
57 
63  virtual bool execute( real64 const time_n,
64  real64 const dt,
65  integer const cycleNumber,
66  integer const eventCounter,
67  real64 const eventProgress,
68  DomainPartition & domain ) override
69  {
70  GEOS_UNUSED_VAR( time_n );
71  GEOS_UNUSED_VAR( dt );
72  GEOS_UNUSED_VAR( cycleNumber );
73  GEOS_UNUSED_VAR( eventCounter );
74  GEOS_UNUSED_VAR( eventProgress );
75  GEOS_UNUSED_VAR( domain );
76  return true;
77  }
78 };
79 
80 
81 } // namespace geos
82 
83 #endif // GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
#define GEOS_UNUSED_VAR(...)
Mark an unused variable and silence compiler warnings.
Definition: GeosxMacros.hpp:84
Partition of the decomposed physical domain. It also manages the connexion information to its neighbo...
Performs no actual output but returns control to the Python interpreter.
virtual bool execute(real64 const time_n, real64 const dt, integer const cycleNumber, integer const eventCounter, real64 const eventProgress, DomainPartition &domain) override
Signals the EventManager to exit the loop early, and return to Python.
static string catalogName()
Get the name used to register this object in an XML file.
virtual ~PythonOutput() override
Destructor.
PythonOutput(string const &name, Group *const parent)
Constructor.
double real64
64-bit floating point type.
Definition: DataTypes.hpp:99
std::int32_t integer
Signed integer type.
Definition: DataTypes.hpp:82