vtktemperaturemodule.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_TEMPERATURE_MODULE_HPP
28#define OPM_VTK_TEMPERATURE_MODULE_HPP
29
30#include <opm/material/common/MathToolbox.hpp>
31
33
37
40
41namespace Opm {
42
49template<class TypeTag>
51{
53
56
59
61
62 static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
64
65public:
66 explicit VtkTemperatureModule(const Simulator& simulator)
67 : ParentType(simulator)
68 {
69 params_.read();
70 }
71
75 static void registerParameters()
76 {
78 }
79
84 void allocBuffers() override
85 {
86 if (params_.temperatureOutput_) {
88 }
89 }
90
95 void processElement(const ElementContext& elemCtx) override
96 {
97 using Toolbox = MathToolbox<Evaluation>;
98
99 if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
100 return;
101 }
102
103 for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
104 const unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
105 const auto& intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
106 const auto& fs = intQuants.fluidState();
107
108 if (params_.temperatureOutput_) {
109 temperature_[I] = Toolbox::value(fs.temperature(/*phaseIdx=*/0));
110 }
111 }
112 }
113
117 void commitBuffers(BaseOutputWriter& baseWriter) override
118 {
119 if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
120 return;
121 }
122
123 if (params_.temperatureOutput_) {
124 this->commitScalarBuffer_(baseWriter, "temperature", temperature_,
126 }
127 }
128
129private:
130 VtkTemperatureParams params_{};
131 ScalarBuffer temperature_{};
132};
133
134} // namespace Opm
135
136#endif // OPM_VTK_TEMPERATURE_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
@ Dof
Buffer contains data associated with the degrees of freedom.
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
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 temperature in which assume thermal equilibrium.
Definition: vtktemperaturemodule.hpp:51
void allocBuffers() override
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition: vtktemperaturemodule.hpp:84
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition: vtktemperaturemodule.hpp:75
VtkTemperatureModule(const Simulator &simulator)
Definition: vtktemperaturemodule.hpp:66
void commitBuffers(BaseOutputWriter &baseWriter) override
Add all buffers to the VTK output writer.
Definition: vtktemperaturemodule.hpp:117
void processElement(const ElementContext &elemCtx) override
Modify the internal buffers according to the intensive quantities relevant for an element.
Definition: vtktemperaturemodule.hpp:95
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 VtkTemperatureModule.
Definition: vtktemperatureparams.hpp:43
void read()
Reads the parameter values from the parameter system.
static void registerParameters()
Registers the parameters in parameter system.
bool temperatureOutput_
Definition: vtktemperatureparams.hpp:50