vtkptflashmodule.hpp
Go to the documentation of this file.
1// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2// vi: set et ts=4 sw=4 sts=4:
3/*
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18
19 Consult the COPYING file in the top-level source directory of this
20 module for the precise wording of the license and the list of
21 copyright holders.
22*/
27#ifndef OPM_VTK_PTFLASH_MODULE_HPP
28#define OPM_VTK_PTFLASH_MODULE_HPP
29
30#include <opm/material/common/MathToolbox.hpp>
31
33
37
40
41namespace Opm {
42
51template <class TypeTag>
52class VtkPTFlashModule: public BaseOutputModule<TypeTag>
53{
55
60
62
63 enum { numPhases = getPropValue<TypeTag, Properties::NumPhases>() };
64 enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
65
66 static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
68
69 using BufferType = typename ParentType::BufferType;
72
73public:
74 explicit VtkPTFlashModule(const Simulator& simulator)
75 : ParentType(simulator)
76 {
77 params_.read();
78 }
79
83 static void registerParameters()
84 {
86 }
87
92 void allocBuffers() override
93 {
94 if (params_.LOutput_) {
95 this->resizeScalarBuffer_(L_, BufferType::Dof);
96 }
97 if (params_.equilConstOutput_) {
98 this->resizeComponentBuffer_(K_, BufferType::Dof);
99 }
100 }
101
106 void processElement(const ElementContext& elemCtx) override
107 {
108 using Toolbox = MathToolbox<Evaluation>;
109
110 if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
111 return;
112 }
113
114 for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
115 const unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
116 const auto& intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
117 const auto& fs = intQuants.fluidState();
118
119 if (params_.LOutput_) {
120 L_[I] = Toolbox::value(fs.L());
121 }
122
123 for (unsigned compIdx = 0; compIdx < numComponents; ++compIdx) {
124 if (params_.equilConstOutput_) {
125 K_[compIdx][I] = Toolbox::value(fs.K(compIdx));
126 }
127 }
128 }
129 }
130
134 void commitBuffers(BaseOutputWriter& baseWriter) override
135 {
136 if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
137 return;
138 }
139
140 if (params_.equilConstOutput_) {
141 this->commitComponentBuffer_(baseWriter, "K^%s", K_, BufferType::Dof);
142 }
143 if (params_.LOutput_) {
144 this->commitScalarBuffer_(baseWriter, "L", L_, BufferType::Dof);
145 }
146 }
147
148private:
149 VtkPtFlashParams params_{};
150 ComponentBuffer K_{};
151 ScalarBuffer L_{};
152};
153
154} // namespace Opm
155
156#endif // OPM_VTK_PTFLASH_MODULE_HPP
The base class for writer modules.
Definition: baseoutputmodule.hh:68
BaseOutputWriter::ScalarBuffer ScalarBuffer
Definition: baseoutputmodule.hh:86
void resizeScalarBuffer_(ScalarBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a scalar quantity.
Definition: baseoutputmodule.hh:157
void commitComponentBuffer_(BaseOutputWriter &baseWriter, const char *pattern, ComponentBuffer &buffer, BufferType bufferType)
Add a component-specific buffer to the result file.
Definition: baseoutputmodule.hh:353
std::array< ScalarBuffer, numComponents > ComponentBuffer
Definition: baseoutputmodule.hh:92
BufferType
Definition: baseoutputmodule.hh:143
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
void resizeComponentBuffer_(ComponentBuffer &buffer, BufferType bufferType)
Allocate the space for a buffer storing a component specific quantity.
Definition: baseoutputmodule.hh:211
The base class for all output writers.
Definition: baseoutputwriter.hh:46
Simplifies writing multi-file VTK datasets.
Definition: vtkmultiwriter.hh:65
VTK output module for the PT Flash calculation This module deals with the following quantities: K,...
Definition: vtkptflashmodule.hpp:53
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition: vtkptflashmodule.hpp:83
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quantities relevant for an element.
Definition: vtkptflashmodule.hpp:106
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition: vtkptflashmodule.hpp:92
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition: vtkptflashmodule.hpp:134
VtkPTFlashModule(const Simulator &simulator)
Definition: vtkptflashmodule.hpp:74
Declare the properties used by the infrastructure code of the finite volume discretizations.
Definition: blackoilboundaryratevector.hh:39
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
This file provides the infrastructure to retrieve run-time parameters.
The Opm property system, traits with inheritance.
Struct holding the parameters for VtkPtFlashModule.
Definition: vtkptflashparams.hpp:44
bool LOutput_
Definition: vtkptflashparams.hpp:51
bool equilConstOutput_
Definition: vtkptflashparams.hpp:52
void read()
Reads the parameter values from the parameter system.
static void registerParameters()
Registers the parameters in parameter system.