Loading...
Searching...
No Matches
vtkprimaryvarsmodule.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_PRIMARY_VARS_MODULE_HPP
#define OPM_VTK_PRIMARY_VARS_MODULE_HPP
#include <opm/models/discretization/common/fvbaseparameters.hh>
#include <opm/models/io/baseoutputmodule.hh>
#include <opm/models/io/vtkmultiwriter.hh>
#include <opm/models/io/vtkprimaryvarsparams.hpp>
#include <opm/models/utils/parametersystem.hpp>
#include <opm/models/utils/propertysystem.hh>
namespace Opm {
template<class TypeTag>
class VtkPrimaryVarsModule : 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>;
static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
using BufferType = typename ParentType::BufferType;
using ScalarBuffer = typename ParentType::ScalarBuffer;
using EqBuffer = typename ParentType::EqBuffer;
enum { numEq = getPropValue<TypeTag, Properties::NumEq>() };
public:
explicit VtkPrimaryVarsModule(const Simulator& simulator)
: ParentType(simulator)
{
params_.read();
}
static void registerParameters()
{
VtkPrimaryVarsParams::registerParameters();
}
void allocBuffers() override
{
if (params_.primaryVarsOutput_) {
this->resizeEqBuffer_(primaryVars_, BufferType::Dof);
}
if (params_.processRankOutput_) {
this->resizeScalarBuffer_(processRank_,
/*bufferType=*/BufferType::Element);
}
if (params_.dofIndexOutput_) {
this->resizeScalarBuffer_(dofIndex_, BufferType::Dof);
}
}
void processElement(const ElementContext& elemCtx) override
{
if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
return;
}
const auto& elementMapper = elemCtx.model().elementMapper();
const unsigned elemIdx = static_cast<unsigned>(elementMapper.index(elemCtx.element()));
if (params_.processRankOutput_ && !processRank_.empty()) {
processRank_[elemIdx] = static_cast<unsigned>(this->simulator_.gridView().comm().rank());
}
for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
const unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
const auto& priVars = elemCtx.primaryVars(i, /*timeIdx=*/0);
if (params_.dofIndexOutput_) {
dofIndex_[I] = I;
}
for (unsigned eqIdx = 0; eqIdx < numEq; ++eqIdx) {
if (params_.primaryVarsOutput_ && !primaryVars_[eqIdx].empty()) {
primaryVars_[eqIdx][I] = priVars[eqIdx];
}
}
}
}
void commitBuffers(BaseOutputWriter& baseWriter) override
{
if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
return;
}
if (params_.primaryVarsOutput_) {
this->commitPriVarsBuffer_(baseWriter, "PV_%s", primaryVars_, BufferType::Dof);
}
if (params_.processRankOutput_) {
this->commitScalarBuffer_(baseWriter,
"process rank",
processRank_,
/*bufferType=*/BufferType::Element);
}
if (params_.dofIndexOutput_) {
this->commitScalarBuffer_(baseWriter, "DOF index", dofIndex_, BufferType::Dof);
}
}
private:
VtkPrimaryVarsParams params_{};
EqBuffer primaryVars_{};
ScalarBuffer processRank_{};
ScalarBuffer dofIndex_{};
};
} // namespace Opm
#endif // OPM_VTK_PRIMARY_VARS_MODULE_HPP
baseoutputmodule.hh
The base class for writer modules.
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::resizeEqBuffer_
void resizeEqBuffer_(EqBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a equation specific quantity.
Definition baseoutputmodule.hh:185
Opm::BaseOutputModule::commitPriVarsBuffer_
void commitPriVarsBuffer_(BaseOutputWriter &baseWriter, const char *pattern, EqBuffer &buffer, BufferType bufferType)
Add a buffer with as many variables as PDEs to the result file.
Definition baseoutputmodule.hh:304
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::VtkMultiWriter
Simplifies writing multi-file VTK datasets.
Definition vtkmultiwriter.hh:65
Opm::VtkPrimaryVarsModule::allocBuffers
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition vtkprimaryvarsmodule.hpp:83
Opm::VtkPrimaryVarsModule::processElement
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quantities relevant for an element.
Definition vtkprimaryvarsmodule.hpp:101
Opm::VtkPrimaryVarsModule::commitBuffers
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition vtkprimaryvarsmodule.hpp:132
Opm::VtkPrimaryVarsModule::registerParameters
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition vtkprimaryvarsmodule.hpp:74
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::VtkPrimaryVarsParams
Struct holding the parameters for VtkPrimaryPhaseModule.
Definition vtkprimaryvarsparams.hpp:44
Opm::VtkPrimaryVarsParams::registerParameters
static void registerParameters()
Registers the parameters in parameter system.
Definition vtkprimaryvarsparams.cpp:31
vtkmultiwriter.hh
Simplifies writing multi-file VTK datasets.
vtkprimaryvarsparams.hpp
VTK output module for the fluid composition.