vtkphasepresencemodule.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_PHASE_PRESENCE_MODULE_HH
28 #define EWOMS_VTK_PHASE_PRESENCE_MODULE_HH
29 
30 #include "vtkmultiwriter.hh"
31 #include "baseoutputmodule.hh"
32 
35 
36 namespace Ewoms {
37 namespace Properties {
38 // create new type tag for the VTK primary variables output
39 NEW_TYPE_TAG(VtkPhasePresence);
40 
41 // create the property tags needed for the primary variables module
42 NEW_PROP_TAG(VtkWritePhasePresence);
43 NEW_PROP_TAG(VtkOutputFormat);
44 NEW_PROP_TAG(EnableVtkOutput);
45 
46 SET_BOOL_PROP(VtkPhasePresence, VtkWritePhasePresence, false);
47 } // namespace Properties
48 } // namespace Ewoms
49 
50 namespace Ewoms {
56 template<class TypeTag>
58 {
60 
61  typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
62  typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
63  typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;
64  typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
65 
66  static const int vtkFormat = GET_PROP_VALUE(TypeTag, VtkOutputFormat);
68 
69  typedef typename ParentType::ScalarBuffer ScalarBuffer;
70 
71 
72 public:
73  VtkPhasePresenceModule(const Simulator& simulator)
74  : ParentType(simulator)
75  { }
76 
80  static void registerParameters()
81  {
82  EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWritePhasePresence,
83  "Include the phase presence pseudo primary "
84  "variable in the VTK output files");
85  }
86 
91  void allocBuffers()
92  {
93  if (phasePresenceOutput_()) this->resizeScalarBuffer_(phasePresence_);
94  }
95 
100  void processElement(const ElementContext& elemCtx)
101  {
102  if (!EWOMS_GET_PARAM(TypeTag, bool, EnableVtkOutput))
103  return;
104 
105  for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
106  // calculate the phase presence
107  int phasePresence = elemCtx.primaryVars(i, /*timeIdx=*/0).phasePresence();
108  unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
109 
110  if (phasePresenceOutput_())
111  phasePresence_[I] = phasePresence;
112  }
113  }
114 
118  void commitBuffers(BaseOutputWriter& baseWriter)
119  {
120  VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
121  if (!vtkWriter) {
122  return;
123  }
124 
125  if (phasePresenceOutput_())
126  this->commitScalarBuffer_(baseWriter, "phase presence", phasePresence_);
127  }
128 
129 private:
130  static bool phasePresenceOutput_()
131  { return EWOMS_GET_PARAM(TypeTag, bool, VtkWritePhasePresence); }
132 
133  ScalarBuffer phasePresence_;
134 };
135 
136 } // namespace Ewoms
137 
138 #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
Definition: baseauxiliarymodule.hh:37
void allocBuffers()
Allocate memory for the scalar fields we would like to write to the VTK file.
Definition: vtkphasepresencemodule.hh:91
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
static void registerParameters()
Register all run-time parameters for the Vtk output module.
Definition: vtkphasepresencemodule.hh:80
void commitBuffers(BaseOutputWriter &baseWriter)
Add all buffers to the output writer.
Definition: vtkphasepresencemodule.hh:118
VTK output module for the fluid composition.
Definition: vtkphasepresencemodule.hh:57
#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: vtkphasepresencemodule.hh:100
#define EWOMS_GET_PARAM(TypeTag, ParamType, ParamName)
Retrieve a runtime parameter.
Definition: parametersystem.hh:99
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