All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vtktemperaturemodule.hh
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 EWOMS_VTK_TEMPERATURE_MODULE_HH
28 #define EWOMS_VTK_TEMPERATURE_MODULE_HH
29 
30 #include "vtkmultiwriter.hh"
31 #include "baseoutputmodule.hh"
32 
35 
36 #include <opm/material/common/MathToolbox.hpp>
37 
38 namespace Ewoms {
39 namespace Properties {
40 // create new type tag for the VTK temperature output
41 NEW_TYPE_TAG(VtkTemperature);
42 
43 // create the property tags needed for the temperature module
44 NEW_PROP_TAG(VtkWriteTemperature);
45 NEW_PROP_TAG(VtkOutputFormat);
46 NEW_PROP_TAG(EnableVtkOutput);
47 
48 // set default values for what quantities to output
49 SET_BOOL_PROP(VtkTemperature, VtkWriteTemperature, true);
50 } // namespace Properties
51 
58 template<class TypeTag>
59 class VtkTemperatureModule : public BaseOutputModule<TypeTag>
60 {
62 
63  typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
64  typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
65 
66  typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
67  typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;
68 
69  typedef typename ParentType::ScalarBuffer ScalarBuffer;
70 
71  static const int vtkFormat = GET_PROP_VALUE(TypeTag, VtkOutputFormat);
73 
74 public:
75  VtkTemperatureModule(const Simulator& simulator)
76  : ParentType(simulator)
77  {}
78 
82  static void registerParameters()
83  {
84  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteTemperature,
85  "Include the temperature in the VTK output files");
86  }
87 
92  void allocBuffers()
93  {
94  if (temperatureOutput_()) this->resizeScalarBuffer_(temperature_);
95  }
96 
101  void processElement(const ElementContext& elemCtx)
102  {
103  typedef Opm::MathToolbox<Evaluation> Toolbox;
104 
105  if (!EWOMS_GET_PARAM(TypeTag, bool, EnableVtkOutput))
106  return;
107 
108  for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
109  unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
110  const auto& intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
111  const auto& fs = intQuants.fluidState();
112 
113  if (temperatureOutput_())
114  temperature_[I] = Toolbox::value(fs.temperature(/*phaseIdx=*/0));
115  }
116  }
117 
121  void commitBuffers(BaseOutputWriter& baseWriter)
122  {
123  VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
124  if (!vtkWriter) {
125  return;
126  }
127 
128  if (temperatureOutput_())
129  this->commitScalarBuffer_(baseWriter, "temperature", temperature_);
130  }
131 
132 private:
133  static bool temperatureOutput_()
134  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteTemperature); }
135 
136  ScalarBuffer temperature_;
137 };
138 
139 } // namespace Ewoms
140 
141 #endif
void allocBuffers()
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition: vtktemperaturemodule.hh:92
The base class for all output writers.
Definition: baseoutputwriter.hh:43
#define SET_BOOL_PROP(EffTypeTagName, PropTagName,...)
Set a property to a simple constant boolean value.
Definition: propertysystem.hh:361
Simplifies writing multi-file VTK datasets.
Definition: vtkmultiwriter.hh:63
void commitScalarBuffer_(BaseOutputWriter &baseWriter, const char *name, ScalarBuffer &buffer, BufferType bufferType=DofBuffer)
Add a buffer containing scalar quantities to the result file.
Definition: baseoutputmodule.hh:305
#define GET_PROP_VALUE(TypeTag, PropTagName)
Access the value attribute of a property for a type tag.
Definition: propertysystem.hh:469
The base class for writer modules.
#define NEW_TYPE_TAG(...)
Define a new type tag.
Definition: propertysystem.hh:169
#define EWOMS_REGISTER_PARAM(TypeTag, ParamType, ParamName, Description)
Register a run-time parameter.
Definition: parametersystem.hh:68
This file provides the infrastructure to retrieve run-time parameters.
The base class for writer modules.
Definition: baseoutputmodule.hh:80
VTK output module for the temperature in which assume thermal equilibrium.
Definition: vtktemperaturemodule.hh:59
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition: vtktemperaturemodule.hh:82
#define EWOMS_GET_PARAM(TypeTag, ParamType, ParamName)
Retrieve a runtime parameter.
Definition: parametersystem.hh:99
void processElement(const ElementContext &elemCtx)
Modify the internal buffers according to the intensive quantities relevant for an element...
Definition: vtktemperaturemodule.hh:101
Provides the magic behind the eWoms property system.
void resizeScalarBuffer_(ScalarBuffer &buffer, BufferType bufferType=DofBuffer)
Allocate the space for a buffer storing a scalar quantity.
Definition: baseoutputmodule.hh:170
Simplifies writing multi-file VTK datasets.
Manages the initializing and running of time dependent problems.
Definition: simulator.hh:75
#define NEW_PROP_TAG(PTagName)
Define a property tag.
Definition: propertysystem.hh:247
void commitBuffers(BaseOutputWriter &baseWriter)
Add all buffers to the VTK output writer.
Definition: vtktemperaturemodule.hh:121