My Project
Loading...
Searching...
No Matches
GasLiftCommon.hpp
1/*
2 Copyright 2022 Equinor ASA.
3
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18*/
19
20#ifndef OPM_GASLIFT_COMMON_HEADER_INCLUDED
21#define OPM_GASLIFT_COMMON_HEADER_INCLUDED
22
23#include <opm/simulators/utils/ParallelCommunication.hpp>
24
25#include <string>
26
27namespace Opm {
28
29class DeferredLogger;
30template<class Scalar> class GroupState;
31template<class Scalar> class WellState;
32
33template<class Scalar>
35{
36public:
37 virtual ~GasLiftCommon() = default;
38
39protected:
41 const GroupState<Scalar>& group_state,
43 const Parallel::Communication& comm,
44 bool glift_debug);
45
46 enum class MessageType { INFO, WARNING };
47
48 int debugUpdateGlobalCounter_() const;
49 virtual void displayDebugMessage_(const std::string& msg) const = 0;
50 void displayDebugMessageOnRank0_(const std::string& msg) const;
51 void logMessage_(const std::string& prefix,
52 const std::string& msg,
53 MessageType msg_type = MessageType::INFO) const;
54
55 WellState<Scalar>& well_state_;
56 const GroupState<Scalar>& group_state_;
57 DeferredLogger& deferred_logger_;
58 const Parallel::Communication& comm_;
59 bool debug;
60 // By setting this variable to true we restrict some debug output
61 // to only be printed for rank 0. By setting this variable to false we keep
62 // the output on all ranks. This can in some cases be helpful as a debugging
63 // aid to check that the output is in fact identical over all ranks
64 bool debug_output_only_on_rank0 = false;
65};
66
67} // namespace Opm
68
69#endif // OPM_GASLIFT_COMMON_INCLUDED
Definition DeferredLogger.hpp:57
Definition GasLiftCommon.hpp:35
Definition GroupState.hpp:38
The state of a set of wells, tailored for use by the fully implicit blackoil simulator.
Definition WellState.hpp:62
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilboundaryratevector.hh:37
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:242