mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-01 05:19:09 -06:00
3f69e827be
note: the doxygen groups are quite a bit behind the curve and should be overhauled soon. (e.g. now there's not only the vertex centered finite volume space discretization anymore...)
265 lines
11 KiB
C++
265 lines
11 KiB
C++
/*
|
|
Copyright (C) 2011-2013 by Andreas Lauser
|
|
|
|
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/>.
|
|
*/
|
|
/*!
|
|
* \file
|
|
* \copydoc Ewoms::EclOutputBlackOilModule
|
|
*/
|
|
#ifndef EWOMS_ECL_OUTPUT_BLACK_OIL_MODULE_HH
|
|
#define EWOMS_ECL_OUTPUT_BLACK_OIL_MODULE_HH
|
|
|
|
#include "eclwriter.hh"
|
|
|
|
#include <ewoms/io/baseoutputmodule.hh>
|
|
|
|
#include <opm/core/utility/PropertySystem.hpp>
|
|
#include <ewoms/common/parametersystem.hh>
|
|
|
|
#include <dune/common/fvector.hh>
|
|
|
|
#include <type_traits>
|
|
|
|
namespace Opm {
|
|
namespace Properties {
|
|
// create new type tag for the VTK multi-phase output
|
|
NEW_TYPE_TAG(EclOutputBlackOil);
|
|
|
|
// create the property tags needed for the multi phase module
|
|
NEW_PROP_TAG(EclOutputWriteSaturations);
|
|
NEW_PROP_TAG(EclOutputWritePressures);
|
|
NEW_PROP_TAG(EclOutputWriteGasDissolutionFactor);
|
|
NEW_PROP_TAG(EclOutputWriteGasFormationVolumeFactor);
|
|
NEW_PROP_TAG(EclOutputWriteOilFormationVolumeFactor);
|
|
NEW_PROP_TAG(EclOutputWriteOilSaturationPressure);
|
|
|
|
// set default values for what quantities to output
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWriteSaturations, true);
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWritePressures, true);
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWriteGasDissolutionFactor, true);
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWriteGasFormationVolumeFactor, true);
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWriteOilFormationVolumeFactor, true);
|
|
SET_BOOL_PROP(EclOutputBlackOil, EclOutputWriteOilSaturationPressure, true);
|
|
}} // namespace Opm, Properties
|
|
|
|
namespace Ewoms {
|
|
|
|
// forward declaration
|
|
template <class TypeTag>
|
|
class EcfvDiscretization;
|
|
|
|
/*!
|
|
* \ingroup EclBlackOilSimulator
|
|
*
|
|
* \brief Output module for the results black oil model writing in
|
|
* ECL binary format.
|
|
*/
|
|
template <class TypeTag>
|
|
class EclOutputBlackOilModule : public BaseOutputModule<TypeTag>
|
|
{
|
|
typedef BaseOutputModule<TypeTag> ParentType;
|
|
|
|
typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
|
|
typedef typename GET_PROP_TYPE(TypeTag, Discretization) Discretization;
|
|
typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
|
|
typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
|
|
|
|
typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
|
|
|
|
typedef Ewoms::EclWriter<TypeTag> EclWriter;
|
|
|
|
enum { numPhases = FluidSystem::numPhases };
|
|
enum { oilPhaseIdx = FluidSystem::oilPhaseIdx };
|
|
enum { gasPhaseIdx = FluidSystem::gasPhaseIdx };
|
|
enum { waterPhaseIdx = FluidSystem::waterPhaseIdx };
|
|
enum { gasCompIdx = FluidSystem::gasCompIdx };
|
|
|
|
typedef typename ParentType::ScalarBuffer ScalarBuffer;
|
|
|
|
public:
|
|
EclOutputBlackOilModule(const Simulator &simulator)
|
|
: ParentType(simulator)
|
|
{ }
|
|
|
|
/*!
|
|
* \brief Register all run-time parameters for the multi-phase VTK output
|
|
* module.
|
|
*/
|
|
static void registerParameters()
|
|
{
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWriteSaturations,
|
|
"Include the saturations of all fluid phases in the "
|
|
"ECL output files");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWritePressures,
|
|
"Include the absolute pressures of all fluid phases in the "
|
|
"ECL output files");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWriteGasDissolutionFactor,
|
|
"Include the gas dissolution factor in the "
|
|
"ECL output files");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWriteGasFormationVolumeFactor,
|
|
"Include the gas formation volume factor in the "
|
|
"ECL output files");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWriteOilFormationVolumeFactor,
|
|
"Include the oil formation volume factor of saturated oil "
|
|
"in the ECL output files");
|
|
EWOMS_REGISTER_PARAM(TypeTag, bool, EclOutputWriteOilSaturationPressure,
|
|
"Include the saturation pressure of oil in the "
|
|
"ECL output files");
|
|
}
|
|
|
|
/*!
|
|
* \brief Allocate memory for the scalar fields we would like to
|
|
* write to the VTK file.
|
|
*/
|
|
void allocBuffers()
|
|
{
|
|
if (!std::is_same<Discretization, Ewoms::EcfvDiscretization<TypeTag> >::value)
|
|
return;
|
|
|
|
auto bufferType = ParentType::ElementBuffer;
|
|
if (saturationsOutput_()) {
|
|
for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx)
|
|
this->resizeScalarBuffer_(saturation_[phaseIdx], bufferType);
|
|
}
|
|
if (pressuresOutput_()) {
|
|
for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx)
|
|
this->resizeScalarBuffer_(pressure_[phaseIdx], bufferType);
|
|
}
|
|
if (gasDissolutionFactorOutput_())
|
|
this->resizeScalarBuffer_(gasDissolutionFactor_, bufferType);
|
|
if (gasFormationVolumeFactorOutput_())
|
|
this->resizeScalarBuffer_(gasFormationVolumeFactor_, bufferType);
|
|
if (saturatedOilFormationVolumeFactorOutput_())
|
|
this->resizeScalarBuffer_(saturatedOilFormationVolumeFactor_, bufferType);
|
|
if (oilSaturationPressureOutput_())
|
|
this->resizeScalarBuffer_(oilSaturationPressure_, bufferType);
|
|
}
|
|
|
|
/*!
|
|
* \brief Modify the internal buffers according to the intensive quanties relevant
|
|
* for an element
|
|
*/
|
|
void processElement(const ElementContext &elemCtx)
|
|
{
|
|
if (!std::is_same<Discretization, Ewoms::EcfvDiscretization<TypeTag> >::value)
|
|
return;
|
|
|
|
for (int dofIdx = 0; dofIdx < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++dofIdx) {
|
|
const auto &fs = elemCtx.intensiveQuantities(dofIdx, /*timeIdx=*/0).fluidState();
|
|
int globalDofIdx = elemCtx.globalSpaceIndex(dofIdx, /*timeIdx=*/0);
|
|
int regionIdx = elemCtx.primaryVars(dofIdx, /*timeIdx=*/0).pvtRegionIndex();
|
|
Scalar po = fs.pressure(oilPhaseIdx);
|
|
Scalar XoG = fs.massFraction(oilPhaseIdx, gasCompIdx);
|
|
|
|
if (saturationsOutput_()) {
|
|
for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
|
|
saturation_[phaseIdx][globalDofIdx] = fs.saturation(phaseIdx);
|
|
Valgrind::CheckDefined(saturation_[phaseIdx][globalDofIdx]);
|
|
}
|
|
}
|
|
if (pressuresOutput_()) {
|
|
for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
|
|
pressure_[phaseIdx][globalDofIdx] = fs.pressure(phaseIdx) / 1e5;
|
|
Valgrind::CheckDefined(pressure_[phaseIdx][globalDofIdx]);
|
|
}
|
|
}
|
|
if (gasDissolutionFactorOutput_()) {
|
|
gasDissolutionFactor_[globalDofIdx] =
|
|
FluidSystem::gasDissolutionFactor(po, regionIdx);
|
|
Valgrind::CheckDefined(gasDissolutionFactor_[globalDofIdx]);
|
|
}
|
|
if (gasFormationVolumeFactorOutput_()) {
|
|
gasFormationVolumeFactor_[globalDofIdx] =
|
|
FluidSystem::gasFormationVolumeFactor(po, regionIdx);
|
|
Valgrind::CheckDefined(gasFormationVolumeFactor_[globalDofIdx]);
|
|
}
|
|
if (saturatedOilFormationVolumeFactorOutput_()) {
|
|
saturatedOilFormationVolumeFactor_[globalDofIdx] =
|
|
FluidSystem::saturatedOilFormationVolumeFactor(po, regionIdx);
|
|
Valgrind::CheckDefined(saturatedOilFormationVolumeFactor_[globalDofIdx]);
|
|
}
|
|
if (oilSaturationPressureOutput_()) {
|
|
oilSaturationPressure_[globalDofIdx] =
|
|
FluidSystem::oilSaturationPressure(XoG, regionIdx);
|
|
Valgrind::CheckDefined(oilSaturationPressure_[globalDofIdx]);
|
|
}
|
|
}
|
|
}
|
|
|
|
/*!
|
|
* \brief Add all buffers to the VTK output writer.
|
|
*/
|
|
void commitBuffers(BaseOutputWriter &writer)
|
|
{
|
|
if (!std::is_same<Discretization, Ewoms::EcfvDiscretization<TypeTag> >::value)
|
|
return;
|
|
|
|
if (!dynamic_cast<EclWriter*>(&writer))
|
|
return; // this module only consideres ecl writers...
|
|
|
|
typename ParentType::BufferType bufferType = ParentType::ElementBuffer;
|
|
if (pressuresOutput_()) {
|
|
this->commitScalarBuffer_(writer, "PRESSURE", pressure_[oilPhaseIdx], bufferType);
|
|
this->commitScalarBuffer_(writer, "PGAS", pressure_[gasPhaseIdx], bufferType);
|
|
this->commitScalarBuffer_(writer, "PWAT", pressure_[waterPhaseIdx], bufferType);
|
|
}
|
|
if (saturationsOutput_()) {
|
|
this->commitScalarBuffer_(writer, "SWAT", saturation_[waterPhaseIdx], bufferType);
|
|
this->commitScalarBuffer_(writer, "SGAS", saturation_[gasPhaseIdx], bufferType);
|
|
// the oil saturation is _NOT_ written to disk. Instead, it is calculated by
|
|
// the visualization tool. Wondering why is probably a waste of time...
|
|
}
|
|
if (gasDissolutionFactorOutput_())
|
|
this->commitScalarBuffer_(writer, "RS", gasDissolutionFactor_, bufferType);
|
|
if (gasFormationVolumeFactorOutput_())
|
|
this->commitScalarBuffer_(writer, "BG", gasFormationVolumeFactor_, bufferType);
|
|
if (saturatedOilFormationVolumeFactorOutput_())
|
|
this->commitScalarBuffer_(writer, "BOSAT", saturatedOilFormationVolumeFactor_, bufferType);
|
|
if (oilSaturationPressureOutput_())
|
|
this->commitScalarBuffer_(writer, "PSAT", oilSaturationPressure_);
|
|
}
|
|
|
|
private:
|
|
static bool saturationsOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWriteSaturations); }
|
|
|
|
static bool pressuresOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWritePressures); }
|
|
|
|
static bool gasDissolutionFactorOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWriteGasDissolutionFactor); }
|
|
|
|
static bool gasFormationVolumeFactorOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWriteGasFormationVolumeFactor); }
|
|
|
|
static bool saturatedOilFormationVolumeFactorOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWriteOilFormationVolumeFactor); }
|
|
|
|
static bool oilSaturationPressureOutput_()
|
|
{ return EWOMS_GET_PARAM(TypeTag, bool, EclOutputWriteOilSaturationPressure); }
|
|
|
|
ScalarBuffer saturation_[numPhases];
|
|
ScalarBuffer pressure_[numPhases];
|
|
ScalarBuffer gasDissolutionFactor_;
|
|
ScalarBuffer gasFormationVolumeFactor_;
|
|
ScalarBuffer saturatedOilFormationVolumeFactor_;
|
|
ScalarBuffer oilSaturationPressure_;
|
|
};
|
|
} // namespace Ewoms
|
|
|
|
#endif
|