All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
vtkenergymodule.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_ENERGY_MODULE_HH
28 #define EWOMS_VTK_ENERGY_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 energy output
41 NEW_TYPE_TAG(VtkEnergy);
42 
43 // create the property tags needed for the energy module
44 NEW_PROP_TAG(VtkWriteSolidHeatCapacity);
45 NEW_PROP_TAG(VtkWriteHeatConductivity);
46 NEW_PROP_TAG(VtkWriteInternalEnergies);
47 NEW_PROP_TAG(VtkWriteEnthalpies);
48 NEW_PROP_TAG(VtkOutputFormat);
49 NEW_PROP_TAG(EnableVtkOutput);
50 
51 // set default values for what quantities to output
52 SET_BOOL_PROP(VtkEnergy, VtkWriteSolidHeatCapacity, false);
53 SET_BOOL_PROP(VtkEnergy, VtkWriteHeatConductivity, false);
54 SET_BOOL_PROP(VtkEnergy, VtkWriteInternalEnergies, false);
55 SET_BOOL_PROP(VtkEnergy, VtkWriteEnthalpies, false);
56 } // namespace Properties
57 } // namespace Ewoms
58 
59 namespace Ewoms {
72 template <class TypeTag>
73 class VtkEnergyModule : public BaseOutputModule<TypeTag>
74 {
76 
77  typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
78  typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
79  typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;
80  typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
81  typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
82 
83  typedef typename ParentType::ScalarBuffer ScalarBuffer;
84  typedef typename ParentType::PhaseBuffer PhaseBuffer;
85 
86  static const int vtkFormat = GET_PROP_VALUE(TypeTag, VtkOutputFormat);
87  enum { numPhases = GET_PROP_VALUE(TypeTag, NumPhases) };
88 
89  typedef typename Opm::MathToolbox<Evaluation> Toolbox;
91 
92 public:
93  VtkEnergyModule(const Simulator& simulator)
94  : ParentType(simulator)
95  {
96  }
97 
101  static void registerParameters()
102  {
103  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteSolidHeatCapacity,
104  "Include the specific heat capacities of rock "
105  "matrix in the VTK output files");
106  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteHeatConductivity,
107  "Include the lumped heat conductivity of the "
108  "medium in the VTK output files");
109  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteEnthalpies,
110  "Include the specific enthalpy of the phases in "
111  "the VTK output files");
112  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteInternalEnergies,
113  "Include the specific internal energy of the "
114  "phases in the VTK output files");
115  }
116 
122  {
123  if (enthalpyOutput_())
124  this->resizePhaseBuffer_(enthalpy_);
125  if (internalEnergyOutput_())
126  this->resizePhaseBuffer_(internalEnergy_);
127 
128  if (solidHeatCapacityOutput_())
129  this->resizeScalarBuffer_(solidHeatCapacity_);
130  if (heatConductivityOutput_())
131  this->resizeScalarBuffer_(heatConductivity_);
132  }
133 
138  void processElement(const ElementContext& elemCtx)
139  {
140  if (!EWOMS_GET_PARAM(TypeTag, bool, EnableVtkOutput))
141  return;
142 
143  for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
144  unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
145  const auto& intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
146  const auto& fs = intQuants.fluidState();
147 
148  if (solidHeatCapacityOutput_())
149  solidHeatCapacity_[I] = Toolbox::value(intQuants.heatCapacitySolid());
150  if (heatConductivityOutput_())
151  heatConductivity_[I] = Toolbox::value(intQuants.heatConductivity());
152 
153  for (unsigned phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
154  if (enthalpyOutput_())
155  enthalpy_[phaseIdx][I] = Toolbox::value(fs.enthalpy(phaseIdx));
156  if (internalEnergyOutput_())
157  internalEnergy_[phaseIdx][I] = Toolbox::value(fs.internalEnergy(phaseIdx));
158  }
159  }
160  }
161 
165  void commitBuffers(BaseOutputWriter& baseWriter)
166  {
167  VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
168  if (!vtkWriter) {
169  return;
170  }
171 
172  if (solidHeatCapacityOutput_())
173  this->commitScalarBuffer_(baseWriter, "heatCapacitySolid", solidHeatCapacity_);
174  if (heatConductivityOutput_())
175  this->commitScalarBuffer_(baseWriter, "heatConductivity", heatConductivity_);
176 
177  if (enthalpyOutput_())
178  this->commitPhaseBuffer_(baseWriter, "enthalpy_%s", enthalpy_);
179  if (internalEnergyOutput_())
180  this->commitPhaseBuffer_(baseWriter, "internalEnergy_%s", internalEnergy_);
181  }
182 
183 private:
184  static bool solidHeatCapacityOutput_()
185  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteSolidHeatCapacity); }
186 
187  static bool heatConductivityOutput_()
188  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteHeatConductivity); }
189 
190  static bool enthalpyOutput_()
191  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteEnthalpies); }
192 
193  static bool internalEnergyOutput_()
194  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteInternalEnergies); }
195 
196  PhaseBuffer enthalpy_;
197  PhaseBuffer internalEnergy_;
198 
199  ScalarBuffer heatConductivity_;
200  ScalarBuffer solidHeatCapacity_;
201 };
202 
203 } // namespace Ewoms
204 
205 #endif
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
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition: vtkenergymodule.hh:101
void commitPhaseBuffer_(BaseOutputWriter &baseWriter, const char *pattern, PhaseBuffer &buffer, BufferType bufferType=DofBuffer)
Add a phase-specific buffer to the result file.
Definition: baseoutputmodule.hh:408
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
void processElement(const ElementContext &elemCtx)
Modify the internal buffers according to the intensive quanties relevant for an element.
Definition: vtkenergymodule.hh:138
void commitBuffers(BaseOutputWriter &baseWriter)
Add all buffers to the VTK output writer.
Definition: vtkenergymodule.hh:165
#define EWOMS_GET_PARAM(TypeTag, ParamType, ParamName)
Retrieve a runtime parameter.
Definition: parametersystem.hh:99
void resizePhaseBuffer_(PhaseBuffer &buffer, BufferType bufferType=DofBuffer)
Allocate the space for a buffer storing a phase-specific quantity.
Definition: baseoutputmodule.hh:235
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.
VTK output module for quantities which make sense for models which assume thermal equilibrium...
Definition: vtkenergymodule.hh:73
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 allocBuffers()
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition: vtkenergymodule.hh:121