Loading...
Searching...
No Matches
vtkcompositionmodule.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_COMPOSITION_MODULE_HPP
#define OPM_VTK_COMPOSITION_MODULE_HPP
#include <opm/material/common/MathToolbox.hpp>
#include <opm/models/discretization/common/fvbaseparameters.hh>
#include <opm/models/io/baseoutputmodule.hh>
#include <opm/models/io/vtkcompositionparams.hpp>
#include <opm/models/io/vtkmultiwriter.hh>
#include <opm/models/utils/parametersystem.hpp>
#include <opm/models/utils/propertysystem.hh>
namespace Opm {
template <class TypeTag>
class VtkCompositionModule : 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>;
enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
using BufferType = typename ParentType::BufferType;
using ComponentBuffer = typename ParentType::ComponentBuffer;
using PhaseComponentBuffer = typename ParentType::PhaseComponentBuffer;
public:
explicit VtkCompositionModule(const Simulator& simulator)
: ParentType(simulator)
{
params_.read();
}
static void registerParameters()
{
VtkCompositionParams::registerParameters();
}
void allocBuffers() override
{
if (params_.moleFracOutput_) {
this->resizePhaseComponentBuffer_(moleFrac_, BufferType::Dof);
}
if (params_.massFracOutput_) {
this->resizePhaseComponentBuffer_(massFrac_, BufferType::Dof);
}
if (params_.totalMassFracOutput_) {
this->resizeComponentBuffer_(totalMassFrac_, BufferType::Dof);
}
if (params_.totalMoleFracOutput_) {
this->resizeComponentBuffer_(totalMoleFrac_, BufferType::Dof);
}
if (params_.molarityOutput_) {
this->resizePhaseComponentBuffer_(molarity_, BufferType::Dof);
}
if (params_.fugacityOutput_) {
this->resizeComponentBuffer_(fugacity_, BufferType::Dof);
}
if (params_.fugacityCoeffOutput_) {
this->resizePhaseComponentBuffer_(fugacityCoeff_, BufferType::Dof);
}
}
void processElement(const ElementContext& elemCtx) override
{
using Toolbox = MathToolbox<Evaluation>;
if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
return;
}
for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
const unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
const auto& intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
const auto& fs = intQuants.fluidState();
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
if (params_.moleFracOutput_) {
moleFrac_[phaseIdx][compIdx][I] = Toolbox::value(fs.moleFraction(phaseIdx, compIdx));
}
if (params_.massFracOutput_) {
massFrac_[phaseIdx][compIdx][I] = Toolbox::value(fs.massFraction(phaseIdx, compIdx));
}
if (params_.molarityOutput_) {
molarity_[phaseIdx][compIdx][I] = Toolbox::value(fs.molarity(phaseIdx, compIdx));
}
if (params_.fugacityCoeffOutput_) {
fugacityCoeff_[phaseIdx][compIdx][I] =
Toolbox::value(fs.fugacityCoefficient(phaseIdx, compIdx));
}
}
}
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
if (params_.totalMassFracOutput_) {
Scalar compMass = 0;
Scalar totalMass = 0;
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
totalMass += Toolbox::value(fs.density(phaseIdx)) * Toolbox::value(fs.saturation(phaseIdx));
compMass +=
Toolbox::value(fs.density(phaseIdx)) *
Toolbox::value(fs.saturation(phaseIdx)) *
Toolbox::value(fs.massFraction(phaseIdx, compIdx));
}
totalMassFrac_[compIdx][I] = compMass / totalMass;
}
if (params_.totalMoleFracOutput_) {
Scalar compMoles = 0;
Scalar totalMoles = 0;
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
totalMoles +=
Toolbox::value(fs.molarDensity(phaseIdx)) *
Toolbox::value(fs.saturation(phaseIdx));
compMoles +=
Toolbox::value(fs.molarDensity(phaseIdx)) *
Toolbox::value(fs.saturation(phaseIdx)) *
Toolbox::value(fs.moleFraction(phaseIdx, compIdx));
}
totalMoleFrac_[compIdx][I] = compMoles / totalMoles;
}
if (params_.fugacityOutput_) {
fugacity_[compIdx][I] = Toolbox::value(intQuants.fluidState().fugacity(/*phaseIdx=*/0, compIdx));
}
}
}
}
void commitBuffers(BaseOutputWriter& baseWriter) override
{
if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
return;
}
if (params_.moleFracOutput_) {
this->commitPhaseComponentBuffer_(baseWriter, "moleFrac_%s^%s",
moleFrac_, BufferType::Dof);
}
if (params_.massFracOutput_) {
this->commitPhaseComponentBuffer_(baseWriter, "massFrac_%s^%s",
massFrac_, BufferType::Dof);
}
if (params_.molarityOutput_) {
this->commitPhaseComponentBuffer_(baseWriter, "molarity_%s^%s",
molarity_, BufferType::Dof);
}
if (params_.totalMassFracOutput_) {
this->commitComponentBuffer_(baseWriter, "totalMassFrac^%s",
totalMassFrac_, BufferType::Dof);
}
if (params_.totalMoleFracOutput_) {
this->commitComponentBuffer_(baseWriter, "totalMoleFrac^%s",
totalMoleFrac_, BufferType::Dof);
}
if (params_.fugacityOutput_) {
this->commitComponentBuffer_(baseWriter, "fugacity^%s",
fugacity_, BufferType::Dof);
}
if (params_.fugacityCoeffOutput_) {
this->commitPhaseComponentBuffer_(baseWriter, "fugacityCoeff_%s^%s",
fugacityCoeff_, BufferType::Dof);
}
}
private:
VtkCompositionParams params_{};
PhaseComponentBuffer moleFrac_{};
PhaseComponentBuffer massFrac_{};
PhaseComponentBuffer molarity_{};
ComponentBuffer totalMassFrac_{};
ComponentBuffer totalMoleFrac_{};
ComponentBuffer fugacity_{};
PhaseComponentBuffer fugacityCoeff_{};
};
} // namespace Opm
#endif // OPM_VTK_COMPOSITION_MODULE_HPP
baseoutputmodule.hh
The base class for writer modules.
Opm::BaseOutputModule::commitPhaseComponentBuffer_
void commitPhaseComponentBuffer_(BaseOutputWriter &baseWriter, const char *pattern, PhaseComponentBuffer &buffer, BufferType bufferType)
Add a phase and component specific quantities to the output.
Definition baseoutputmodule.hh:369
Opm::BaseOutputModule::commitComponentBuffer_
void commitComponentBuffer_(BaseOutputWriter &baseWriter, const char *pattern, ComponentBuffer &buffer, BufferType bufferType)
Add a component-specific buffer to the result file.
Definition baseoutputmodule.hh:353
Opm::BaseOutputModule::BufferType
BufferType
Definition baseoutputmodule.hh:143
Opm::BaseOutputModule::resizePhaseComponentBuffer_
void resizePhaseComponentBuffer_(PhaseComponentBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a phase and component specific buffer.
Definition baseoutputmodule.hh:224
Opm::BaseOutputModule::resizeComponentBuffer_
void resizeComponentBuffer_(ComponentBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a component specific quantity.
Definition baseoutputmodule.hh:211
Opm::BaseOutputWriter
The base class for all output writers.
Definition baseoutputwriter.hh:46
Opm::VtkCompositionModule::processElement
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quantities relevant for an element.
Definition vtkcompositionmodule.hpp:126
Opm::VtkCompositionModule::commitBuffers
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition vtkcompositionmodule.hpp:195
Opm::VtkCompositionModule::allocBuffers
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition vtkcompositionmodule.hpp:96
Opm::VtkCompositionModule::registerParameters
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition vtkcompositionmodule.hpp:87
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::VtkCompositionParams
Struct holding the parameters for VtkCompositionModule.
Definition vtkcompositionparams.hpp:49
Opm::VtkCompositionParams::registerParameters
static void registerParameters()
Registers the parameters in parameter system.
Definition vtkcompositionparams.cpp:31
vtkcompositionparams.hpp
VTK output module for the fluid composition.
vtkmultiwriter.hh
Simplifies writing multi-file VTK datasets.