Loading...
Searching...
No Matches
LogOutputHelper.hpp
Go to the documentation of this file.
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
#ifndef LOG_OUTPUT_HELPER_HPP
#define LOG_OUTPUT_HELPER_HPP
#include <opm/output/eclipse/Inplace.hpp>
#include <cstddef>
#include <map>
#include <string>
#include <unordered_map>
#include <vector>
#include <boost/date_time.hpp>
namespace Opm {
class Connection;
class EclipseState;
class Inplace;
class Schedule;
class SummaryState;
class Well;
template<class Scalar>
class LogOutputHelper {
public:
LogOutputHelper(const EclipseState& eclState,
const Schedule& schedule,
const SummaryState& st,
const std::string& moduleVersionName);
void cumulative(const std::size_t reportStepNum,
const bool withConns) const;
void error(const std::vector<int>& failedCellsPbub,
const std::vector<int>& failedCellsPdew) const;
void fip(const Inplace& inplace,
const Inplace& initialInplace,
const std::string& name) const;
void fipResv(const Inplace& inplace, const std::string& name) const;
void fip_csv(std::ostringstream& ss,const Inplace& inplace, const std::string& name) const;
void csv_header(std::ostringstream& ss) const;
void injection(const std::size_t reportStepNum,
const std::map<std::pair<std::string,int>, double>& block_pressures) const;
void msw(const std::size_t reportStepNum) const;
void production(const std::size_t reportStepNum,
const std::map<std::pair<std::string,int>, double>& block_pressures) const;
void wellSpecification(const std::vector<std::string>& changedWells,
const std::size_t reportStepNum) const;
void timeStamp(const std::string& lbl,
double elapsed,
int rstep,
boost::posix_time::ptime currentDate) const;
private:
struct ConnData
{
explicit ConnData(const Connection& conn);
int I, J, K;
std::vector<Scalar> data;
};
void beginCumulativeReport_() const;
void endCumulativeReport_() const;
void outputCumulativeReportRecord_(const std::vector<Scalar>& wellCum,
const std::vector<std::string>& wellCumNames,
const std::vector<ConnData>& connData) const;
void outputRegionFluidInPlace_(std::unordered_map<Inplace::Phase, Scalar> oip,
std::unordered_map<Inplace::Phase, Scalar> cip,
const Scalar pav,
const std::string& name,
const int reg) const;
void outputResvFluidInPlace_(std::unordered_map<Inplace::Phase, Scalar> cipr,
const int reg) const;
void beginInjectionReport_() const;
void endInjectionReport_() const;
void outputInjectionReportRecord_(const std::vector<Scalar>& wellInj,
const std::vector<std::string>& wellInjNames,
const std::vector<ConnData>& connData) const;
void beginMSWReport_() const;
void endMSWReport_() const;
void outputMSWReportRecord_(const Well& well) const;
void beginProductionReport_() const;
void endProductionReport_() const;
void outputProductionReportRecord_(const std::vector<Scalar>& wellProd,
const std::vector<std::string>& wellProdNames,
const std::vector<ConnData>& connData) const;
void fipUnitConvert_(std::unordered_map<Inplace::Phase, Scalar>& fip) const;
void pressureUnitConvert_(Scalar& pav) const;
struct WellCumDataType
{
enum WCId
{
WellLocationi = 0, // WLi
WellLocationj = 1, // WLj
OilProd = 2, // OP
WaterProd = 3, // WP
GasProd = 4, // GP
FluidResVolProd = 5, // FRVP
OilInj = 6, // OI
WaterInj = 7, // WI
GasInj = 8, // GI
FluidResVolInj = 9, // FRVI
WellName = 0, // WName
WellType = 1, // WType
WellCTRL = 2, // WCTRL
};
static constexpr int numWCValues = 10;
static constexpr int numWCNames = 3;
};
struct WellInjDataType
{
enum WIId
{
WellLocationi = 0, // WLi
WellLocationj = 1, // WLj
OilRate = 2, // OR
WaterRate = 3, // WR
GasRate = 4, // GR
FluidResVol = 5, // FRV
BHP = 6, // BHP
CPR = 6, // Connection pressure
THP = 7, // THP
BPR = 7, // Block pressures for connections
SteadyStateII = 8, // SteadyStateII
WellName = 0, // WName
CTRLModeOil = 1, // CTRLo
CTRLModeWat = 2, // CTRLw
CTRLModeGas = 3, // CTRLg
};
static constexpr int numWIValues = 9;
static constexpr int numWINames = 4;
};
struct WellProdDataType
{
enum WPId
{
WellLocationi = 0, // WLi
WellLocationj = 1, // WLj
OilRate = 2, // OR
WaterRate = 3, // WR
GasRate = 4, // GR
FluidResVol = 5, // FRV
WaterCut = 6, // WC
GasOilRatio = 7, // GOR
WatGasRatio = 8, // WGR
BHP = 9, // BHP
CPR = 9, // Connection pressure
THP = 10, // THP
BPR = 10, // Block pressures for connections
SteadyStatePI = 11, // SteadyStatePI
WellName = 0, // WName
CTRLMode = 1, // CTRL
};
static constexpr int numWPValues = 12;
static constexpr int numWPNames = 2;
};
const EclipseState& eclState_;
const Schedule& schedule_;
const SummaryState& summaryState_;
std::string flowVersionName_;
};
} // namespace Opm
#endif // LOG_OUTPUT_HELPER_HPP
Opm::LogOutputHelper::error
void error(const std::vector< int > &failedCellsPbub, const std::vector< int > &failedCellsPdew) const
Write error report to output.
Definition LogOutputHelper.cpp:275
Opm::LogOutputHelper::fip
void fip(const Inplace &inplace, const Inplace &initialInplace, const std::string &name) const
Write fluid-in-place reports to output.
Definition LogOutputHelper.cpp:302
Opm::LogOutputHelper::msw
void msw(const std::size_t reportStepNum) const
Write msw report to output.
Definition LogOutputHelper.cpp:552
Opm::LogOutputHelper::cumulative
void cumulative(const std::size_t reportStepNum, const bool withConns) const
Write cumulative production and injection reports to output.
Definition LogOutputHelper.cpp:179
Opm::LogOutputHelper::fipResv
void fipResv(const Inplace &inplace, const std::string &name) const
Write fluid-in-place reservoir reports to output.
Definition LogOutputHelper.cpp:349
Opm::LogOutputHelper::injection
void injection(const std::size_t reportStepNum, const std::map< std::pair< std::string, int >, double > &block_pressures) const
Write injection report to output.
Definition LogOutputHelper.cpp:451
Opm::LogOutputHelper::fip_csv
void fip_csv(std::ostringstream &ss, const Inplace &inplace, const std::string &name) const
Write fluid-in-place reservoir reports to csv file.
Definition LogOutputHelper.cpp:408
Opm::LogOutputHelper::wellSpecification
void wellSpecification(const std::vector< std::string > &changedWells, const std::size_t reportStepNum) const
Write well specification report to output.
Definition LogOutputHelper.cpp:688
Opm::LogOutputHelper::production
void production(const std::size_t reportStepNum, const std::map< std::pair< std::string, int >, double > &block_pressures) const
Write production report to output.
Definition LogOutputHelper.cpp:579
Opm::LogOutputHelper::csv_header
void csv_header(std::ostringstream &ss) const
Write fluid-in-place reservoir reports to csv file.
Definition LogOutputHelper.cpp:398
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::moduleVersionName
std::string moduleVersionName()
Return the version name of the module, for example "2015.10" (for a release branch) or "2016....
Definition moduleVersion.cpp:34