Loading...
Searching...
No Matches
vtkdiffusionmodule.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_DIFFUSION_MODULE_HPP
#define OPM_VTK_DIFFUSION_MODULE_HPP
#include <opm/material/densead/Evaluation.hpp>
#include <opm/material/densead/Math.hpp>
#include <opm/models/discretization/common/fvbaseparameters.hh>
#include <opm/models/io/baseoutputmodule.hh>
#include <opm/models/io/vtkdiffusionparams.hpp>
#include <opm/models/io/vtkmultiwriter.hh>
#include <opm/models/utils/propertysystem.hh>
#include <opm/models/utils/parametersystem.hpp>
namespace Opm {
template <class TypeTag>
class VtkDiffusionModule : public BaseOutputModule<TypeTag>
{
using ParentType = BaseOutputModule<TypeTag>;
using Simulator = GetPropType<TypeTag, Properties::Simulator>;
using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
using GridView = GetPropType<TypeTag, Properties::GridView>;
using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
using Toolbox = MathToolbox<Evaluation>;
using BufferType = typename ParentType::BufferType;
using PhaseBuffer = typename ParentType::PhaseBuffer;
using PhaseComponentBuffer = typename ParentType::PhaseComponentBuffer;
static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
public:
explicit VtkDiffusionModule(const Simulator& simulator)
: ParentType(simulator)
{
params_.read();
}
static void registerParameters()
{
VtkDiffusionParams::registerParameters();
}
void allocBuffers() override
{
if (params_.tortuosityOutput_) {
this->resizePhaseBuffer_(tortuosity_, BufferType::Dof);
}
if (params_.diffusionCoefficientOutput_) {
this->resizePhaseComponentBuffer_(diffusionCoefficient_, BufferType::Dof);
}
if (params_.effectiveDiffusionCoefficientOutput_) {
this->resizePhaseComponentBuffer_(effectiveDiffusionCoefficient_, BufferType::Dof);
}
}
void processElement(const ElementContext& elemCtx) override
{
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);
for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
if (params_.tortuosityOutput_) {
tortuosity_[phaseIdx][I] = Toolbox::value(intQuants.tortuosity(phaseIdx));
}
for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
if (params_.diffusionCoefficientOutput_) {
diffusionCoefficient_[phaseIdx][compIdx][I] =
Toolbox::value(intQuants.diffusionCoefficient(phaseIdx, compIdx));
}
if (params_.effectiveDiffusionCoefficientOutput_) {
effectiveDiffusionCoefficient_[phaseIdx][compIdx][I] =
Toolbox::value(intQuants.effectiveDiffusionCoefficient(phaseIdx, compIdx));
}
}
}
}
}
void commitBuffers(BaseOutputWriter& baseWriter) override
{
if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
return;
}
if (params_.tortuosityOutput_) {
this->commitPhaseBuffer_(baseWriter, "tortuosity", tortuosity_, BufferType::Dof);
}
if (params_.diffusionCoefficientOutput_) {
this->commitPhaseComponentBuffer_(baseWriter, "diffusionCoefficient",
diffusionCoefficient_, BufferType::Dof);
}
if (params_.effectiveDiffusionCoefficientOutput_) {
this->commitPhaseComponentBuffer_(baseWriter,
"effectiveDiffusionCoefficient",
effectiveDiffusionCoefficient_,
BufferType::Dof);
}
}
private:
VtkDiffusionParams params_{};
PhaseBuffer tortuosity_{};
PhaseComponentBuffer diffusionCoefficient_{};
PhaseComponentBuffer effectiveDiffusionCoefficient_{};
};
} // namespace Opm
#endif // OPM_VTK_DIFFUSION_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::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::commitPhaseBuffer_
void commitPhaseBuffer_(BaseOutputWriter &baseWriter, const char *pattern, PhaseBuffer &buffer, BufferType bufferType)
Add a phase-specific buffer to the result file.
Definition baseoutputmodule.hh:337
Opm::BaseOutputModule::resizePhaseBuffer_
void resizePhaseBuffer_(PhaseBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a phase-specific quantity.
Definition baseoutputmodule.hh:198
Opm::BaseOutputWriter
The base class for all output writers.
Definition baseoutputwriter.hh:46
Opm::VtkDiffusionModule::allocBuffers
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition vtkdiffusionmodule.hpp:97
Opm::VtkDiffusionModule::commitBuffers
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition vtkdiffusionmodule.hpp:145
Opm::VtkDiffusionModule::processElement
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quanties relevant for an element.
Definition vtkdiffusionmodule.hpp:114
Opm::VtkDiffusionModule::registerParameters
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition vtkdiffusionmodule.hpp:88
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::VtkDiffusionParams
Struct holding the parameters for VtkDiffusionModule.
Definition vtkdiffusionparams.hpp:46
Opm::VtkDiffusionParams::registerParameters
static void registerParameters()
Registers the parameters in parameter system.
Definition vtkdiffusionparams.cpp:31
vtkdiffusionparams.hpp
VTK output module for quantities which make sense for models which incorperate molecular diffusion.
vtkmultiwriter.hh
Simplifies writing multi-file VTK datasets.