GEOSX
PythonOutput.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2018-2019 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2019 The Board of Trustees of the Leland Stanford Junior University
7  * Copyright (c) 2018-2019 TotalEnergies
8  * Copyright (c) 2019- GEOSX Contributors
9  * All right reserved
10  *
11  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
12  * ------------------------------------------------------------------------------------------------------------
13  */
14 
19 #ifndef GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
20 #define GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
21 
23 
24 namespace geos
25 {
26 
31 class PythonOutput : public OutputBase
32 {
33 public:
34 
40  PythonOutput( string const & name,
41  Group * const parent ):
42  OutputBase( name, parent )
43  {}
44 
48  virtual ~PythonOutput() override
49  {}
50 
55  static string catalogName() { return "Python"; }
56 
62  virtual bool execute( real64 const time_n,
63  real64 const dt,
64  integer const cycleNumber,
65  integer const eventCounter,
66  real64 const eventProgress,
67  DomainPartition & domain ) override
68  {
69  GEOS_UNUSED_VAR( time_n );
70  GEOS_UNUSED_VAR( dt );
71  GEOS_UNUSED_VAR( cycleNumber );
72  GEOS_UNUSED_VAR( eventCounter );
73  GEOS_UNUSED_VAR( eventProgress );
74  GEOS_UNUSED_VAR( domain );
75  return true;
76  }
77 };
78 
79 
80 } // namespace geos
81 
82 #endif // GEOS_FILEIO_OUTPUTS_PYTHONOUTPUT_HPP_
#define GEOS_UNUSED_VAR(...)
Mark an unused variable and silence compiler warnings.
Definition: GeosxMacros.hpp:83
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:139
std::int32_t integer
Signed integer type.
Definition: DataTypes.hpp:122