Loading...
Searching...
No Matches
vtkblackoilmodule.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 OPM_VTK_BLACK_OIL_MODULE_HPP
#define OPM_VTK_BLACK_OIL_MODULE_HPP
#include <dune/common/fvector.hh>
#include <opm/material/densead/Math.hpp>
#include <opm/models/blackoil/blackoilproperties.hh>
#include <opm/models/discretization/common/fvbaseparameters.hh>
#include <opm/models/io/baseoutputmodule.hh>
#include <opm/models/io/vtkblackoilparams.hpp>
#include <opm/models/io/vtkmultiwriter.hh>
#include <opm/models/utils/parametersystem.hpp>
#include <opm/models/utils/propertysystem.hh>
#include <algorithm>
#include <type_traits>
namespace Opm {
template <class TypeTag>
class VtkBlackOilModule : public BaseOutputModule<TypeTag>
{
using ParentType = BaseOutputModule<TypeTag>;
using Simulator = GetPropType<TypeTag, Properties::Simulator>;
using Scalar = GetPropType<TypeTag, Properties::Scalar>;
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
using GridView = GetPropType<TypeTag, Properties::GridView>;
using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
enum { oilPhaseIdx = FluidSystem::oilPhaseIdx };
enum { gasPhaseIdx = FluidSystem::gasPhaseIdx };
enum { waterPhaseIdx = FluidSystem::waterPhaseIdx };
enum { gasCompIdx = FluidSystem::gasCompIdx };
enum { oilCompIdx = FluidSystem::oilCompIdx };
enum { waterCompIdx = FluidSystem::waterCompIdx };
using BufferType = typename ParentType::BufferType;
using ScalarBuffer = typename ParentType::ScalarBuffer;
public:
explicit VtkBlackOilModule(const Simulator& simulator)
: ParentType(simulator)
{
params_.read();
}
static void registerParameters()
{
VtkBlackoilParams::registerParameters();
}
void allocBuffers() override
{
if (params_.gasDissolutionFactorOutput_) {
this->resizeScalarBuffer_(gasDissolutionFactor_, BufferType::Dof);
}
if (params_.oilVaporizationFactorOutput_) {
this->resizeScalarBuffer_(oilVaporizationFactor_, BufferType::Dof);
}
if (params_.oilFormationVolumeFactorOutput_) {
this->resizeScalarBuffer_(oilFormationVolumeFactor_, BufferType::Dof);
}
if (params_.gasFormationVolumeFactorOutput_) {
this->resizeScalarBuffer_(gasFormationVolumeFactor_, BufferType::Dof);
}
if (params_.waterFormationVolumeFactorOutput_) {
this->resizeScalarBuffer_(waterFormationVolumeFactor_, BufferType::Dof);
}
if (params_.oilSaturationPressureOutput_) {
this->resizeScalarBuffer_(oilSaturationPressure_, BufferType::Dof);
}
if (params_.gasSaturationPressureOutput_) {
this->resizeScalarBuffer_(gasSaturationPressure_, BufferType::Dof);
}
if (params_.saturatedOilGasDissolutionFactorOutput_) {
this->resizeScalarBuffer_(saturatedOilGasDissolutionFactor_, BufferType::Dof);
}
if (params_.saturatedGasOilVaporizationFactorOutput_) {
this->resizeScalarBuffer_(saturatedGasOilVaporizationFactor_, BufferType::Dof);
}
if (params_.saturationRatiosOutput_) {
this->resizeScalarBuffer_(oilSaturationRatio_, BufferType::Dof);
this->resizeScalarBuffer_(gasSaturationRatio_, BufferType::Dof);
}
if (params_.primaryVarsMeaningOutput_) {
this->resizeScalarBuffer_(primaryVarsMeaningPressure_, BufferType::Dof);
this->resizeScalarBuffer_(primaryVarsMeaningWater_, BufferType::Dof);
this->resizeScalarBuffer_(primaryVarsMeaningGas_, BufferType::Dof);
}
}
void processElement(const ElementContext& elemCtx) override
{
if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
return;
}
for (unsigned dofIdx = 0; dofIdx < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++dofIdx) {
const auto& fs = elemCtx.intensiveQuantities(dofIdx, /*timeIdx=*/0).fluidState();
using FluidState = std::remove_const_t<std::remove_reference_t<decltype(fs)>>;
const unsigned globalDofIdx = elemCtx.globalSpaceIndex(dofIdx, /*timeIdx=*/0);
const auto& primaryVars = elemCtx.primaryVars(dofIdx, /*timeIdx=*/0);
const unsigned pvtRegionIdx = elemCtx.primaryVars(dofIdx, /*timeIdx=*/0).pvtRegionIndex();
const Scalar SoMax =
FluidSystem::phaseIsActive(oilPhaseIdx)
? std::max(getValue(fs.saturation(oilPhaseIdx)),
elemCtx.problem().maxOilSaturation(globalDofIdx))
: 0.0;
if (FluidSystem::phaseIsActive(gasPhaseIdx) && FluidSystem::phaseIsActive(oilPhaseIdx)) {
const Scalar x_oG = getValue(fs.moleFraction(oilPhaseIdx, gasCompIdx));
const Scalar x_gO = getValue(fs.moleFraction(gasPhaseIdx, oilCompIdx));
const Scalar X_oG = getValue(fs.massFraction(oilPhaseIdx, gasCompIdx));
const Scalar X_gO = getValue(fs.massFraction(gasPhaseIdx, oilCompIdx));
const Scalar Rs = FluidSystem::convertXoGToRs(X_oG, pvtRegionIdx);
const Scalar Rv = FluidSystem::convertXgOToRv(X_gO, pvtRegionIdx);
const Scalar RsSat =
FluidSystem::template saturatedDissolutionFactor<FluidState, Scalar>(fs,
oilPhaseIdx,
pvtRegionIdx,
SoMax);
const Scalar X_oG_sat = FluidSystem::convertRsToXoG(RsSat, pvtRegionIdx);
const Scalar x_oG_sat = FluidSystem::convertXoGToxoG(X_oG_sat, pvtRegionIdx);
const Scalar RvSat =
FluidSystem::template saturatedDissolutionFactor<FluidState, Scalar>(fs,
gasPhaseIdx,
pvtRegionIdx,
SoMax);
const Scalar X_gO_sat = FluidSystem::convertRvToXgO(RvSat, pvtRegionIdx);
const Scalar x_gO_sat = FluidSystem::convertXgOToxgO(X_gO_sat, pvtRegionIdx);
if (params_.gasDissolutionFactorOutput_) {
gasDissolutionFactor_[globalDofIdx] = Rs;
}
if (params_.oilVaporizationFactorOutput_) {
oilVaporizationFactor_[globalDofIdx] = Rv;
}
if (params_.oilSaturationPressureOutput_) {
oilSaturationPressure_[globalDofIdx] =
FluidSystem::template saturationPressure<FluidState, Scalar>(fs, oilPhaseIdx, pvtRegionIdx);
}
if (params_.gasSaturationPressureOutput_) {
gasSaturationPressure_[globalDofIdx] =
FluidSystem::template saturationPressure<FluidState, Scalar>(fs, gasPhaseIdx, pvtRegionIdx);
}
if (params_.saturatedOilGasDissolutionFactorOutput_) {
saturatedOilGasDissolutionFactor_[globalDofIdx] = RsSat;
}
if (params_.saturatedGasOilVaporizationFactorOutput_) {
saturatedGasOilVaporizationFactor_[globalDofIdx] = RvSat;
}
if (params_.saturationRatiosOutput_) {
if (x_oG_sat <= 0.0) {
oilSaturationRatio_[globalDofIdx] = 1.0;
}
else {
oilSaturationRatio_[globalDofIdx] = x_oG / x_oG_sat;
}
if (x_gO_sat <= 0.0) {
gasSaturationRatio_[globalDofIdx] = 1.0;
}
else {
gasSaturationRatio_[globalDofIdx] = x_gO / x_gO_sat;
}
}
}
if (params_.oilFormationVolumeFactorOutput_) {
oilFormationVolumeFactor_[globalDofIdx] =
1.0 / FluidSystem::template inverseFormationVolumeFactor<FluidState, Scalar>(fs, oilPhaseIdx, pvtRegionIdx);
}
if (params_.gasFormationVolumeFactorOutput_) {
gasFormationVolumeFactor_[globalDofIdx] =
1.0 / FluidSystem::template inverseFormationVolumeFactor<FluidState, Scalar>(fs, gasPhaseIdx, pvtRegionIdx);
}
if (params_.waterFormationVolumeFactorOutput_) {
waterFormationVolumeFactor_[globalDofIdx] =
1.0 / FluidSystem::template inverseFormationVolumeFactor<FluidState, Scalar>(fs, waterPhaseIdx, pvtRegionIdx);
}
if (params_.primaryVarsMeaningOutput_) {
primaryVarsMeaningWater_[globalDofIdx] =
static_cast<int>(primaryVars.primaryVarsMeaningWater());
primaryVarsMeaningGas_[globalDofIdx] =
static_cast<int>(primaryVars.primaryVarsMeaningGas());
primaryVarsMeaningPressure_[globalDofIdx] =
static_cast<int>(primaryVars.primaryVarsMeaningPressure());
}
}
}
void commitBuffers(BaseOutputWriter& baseWriter) override
{
if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
return;
}
if (params_.gasDissolutionFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "R_s",
gasDissolutionFactor_, BufferType::Dof);
}
if (params_.oilVaporizationFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "R_v",
oilVaporizationFactor_, BufferType::Dof);
}
if (params_.oilFormationVolumeFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "B_o",
oilFormationVolumeFactor_, BufferType::Dof);
}
if (params_.gasFormationVolumeFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "B_g",
gasFormationVolumeFactor_, BufferType::Dof);
}
if (params_.waterFormationVolumeFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "B_w",
waterFormationVolumeFactor_, BufferType::Dof);
}
if (params_.oilSaturationPressureOutput_) {
this->commitScalarBuffer_(baseWriter, "p_o,sat",
oilSaturationPressure_, BufferType::Dof);
}
if (params_.gasSaturationPressureOutput_) {
this->commitScalarBuffer_(baseWriter, "p_g,sat",
gasSaturationPressure_, BufferType::Dof);
}
if (params_.saturatedOilGasDissolutionFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "R_s,sat",
saturatedOilGasDissolutionFactor_, BufferType::Dof);
}
if (params_.saturatedGasOilVaporizationFactorOutput_) {
this->commitScalarBuffer_(baseWriter, "R_v,sat",
saturatedGasOilVaporizationFactor_, BufferType::Dof);
}
if (params_.saturationRatiosOutput_) {
this->commitScalarBuffer_(baseWriter, "saturation ratio_oil",
oilSaturationRatio_, BufferType::Dof);
this->commitScalarBuffer_(baseWriter, "saturation ratio_gas",
gasSaturationRatio_, BufferType::Dof);
}
if (params_.primaryVarsMeaningOutput_) {
this->commitScalarBuffer_(baseWriter, "primary vars meaning water",
primaryVarsMeaningWater_, BufferType::Dof);
this->commitScalarBuffer_(baseWriter, "primary vars meaning gas",
primaryVarsMeaningGas_, BufferType::Dof);
this->commitScalarBuffer_(baseWriter, "primary vars meaning pressure",
primaryVarsMeaningPressure_, BufferType::Dof);
}
}
private:
VtkBlackoilParams params_{};
ScalarBuffer gasDissolutionFactor_{};
ScalarBuffer oilVaporizationFactor_{};
ScalarBuffer oilFormationVolumeFactor_{};
ScalarBuffer gasFormationVolumeFactor_{};
ScalarBuffer waterFormationVolumeFactor_{};
ScalarBuffer oilSaturationPressure_{};
ScalarBuffer gasSaturationPressure_{};
ScalarBuffer saturatedOilGasDissolutionFactor_{};
ScalarBuffer saturatedGasOilVaporizationFactor_{};
ScalarBuffer oilSaturationRatio_{};
ScalarBuffer gasSaturationRatio_{};
ScalarBuffer primaryVarsMeaningPressure_{};
ScalarBuffer primaryVarsMeaningWater_{};
ScalarBuffer primaryVarsMeaningGas_{};
};
} // namespace Opm
#endif // OPM_VTK_BLACK_OIL_MODULE_HPP
baseoutputmodule.hh
The base class for writer modules.
blackoilproperties.hh
Declares the properties required by the black oil model.
Opm::BaseOutputModule::resizeScalarBuffer_
void resizeScalarBuffer_(ScalarBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a scalar quantity.
Definition baseoutputmodule.hh:157
Opm::BaseOutputModule::BufferType
BufferType
Definition baseoutputmodule.hh:143
Opm::BaseOutputModule::commitScalarBuffer_
void commitScalarBuffer_(BaseOutputWriter &baseWriter, const char *name, ScalarBuffer &buffer, BufferType bufferType)
Add a buffer containing scalar quantities to the result file.
Definition baseoutputmodule.hh:238
Opm::BaseOutputWriter
The base class for all output writers.
Definition baseoutputwriter.hh:46
Opm::VtkBlackOilModule::processElement
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quantities relevant for an element.
Definition vtkblackoilmodule.hpp:146
Opm::VtkBlackOilModule::registerParameters
static void registerParameters()
Register all run-time parameters for the multi-phase VTK output module.
Definition vtkblackoilmodule.hpp:93
Opm::VtkBlackOilModule::commitBuffers
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition vtkblackoilmodule.hpp:252
Opm::VtkBlackOilModule::allocBuffers
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition vtkblackoilmodule.hpp:102
Opm::VtkMultiWriter
Simplifies writing multi-file VTK datasets.
Definition vtkmultiwriter.hh:65
fvbaseparameters.hh
Declare the properties used by the infrastructure code of the finite volume discretizations.
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
Opm::getPropValue
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:240
parametersystem.hpp
This file provides the infrastructure to retrieve run-time parameters.
Opm::Parameters::Get
auto Get(bool errorIfNotRegistered=true)
Retrieve a runtime parameter.
Definition parametersystem.hpp:187
propertysystem.hh
The Opm property system, traits with inheritance.
Opm::VtkBlackoilParams
Struct holding the parameters for VtkBlackoilOutputModule.
Definition vtkblackoilparams.hpp:53
Opm::VtkBlackoilParams::registerParameters
static void registerParameters()
Registers the parameters in parameter system.
Definition vtkblackoilparams.cpp:31
vtkblackoilparams.hpp
VTK output module for the black oil model's parameters.
vtkmultiwriter.hh
Simplifies writing multi-file VTK datasets.