All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
baseoutputwriter.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 */
28 #ifndef EWOMS_BASE_OUTPUT_WRITER_HH
29 #define EWOMS_BASE_OUTPUT_WRITER_HH
30 
31 #include <dune/common/dynvector.hh>
32 #include <dune/common/dynmatrix.hh>
33 
34 #include <vector>
35 
36 namespace Ewoms {
44 {
45 public:
46  typedef double Scalar;
47  typedef Dune::DynamicVector<double> Vector;
48  typedef Dune::DynamicMatrix<double> Tensor;
49  typedef std::vector<Scalar> ScalarBuffer;
50  typedef std::vector<Vector> VectorBuffer;
51  typedef std::vector<Tensor> TensorBuffer;
52 
54  {}
55 
56  virtual ~BaseOutputWriter()
57  {}
58 
63  virtual void beginWrite(double t) = 0;
64 
68  virtual void attachScalarVertexData(ScalarBuffer& buf, std::string name) = 0;
69 
73  virtual void attachScalarElementData(ScalarBuffer& buf, std::string name) = 0;
74 
78  virtual void attachVectorVertexData(VectorBuffer& buf, std::string name) = 0;
79 
83  virtual void attachVectorElementData(VectorBuffer& buf, std::string name) = 0;
84 
88  virtual void attachTensorVertexData(TensorBuffer& buf, std::string name) = 0;
89 
93  virtual void attachTensorElementData(TensorBuffer& buf, std::string name) = 0;
94 
102  virtual void endWrite(bool onlyDiscard = false) = 0;
103 };
104 } // namespace Ewoms
105 
106 #endif
The base class for all output writers.
Definition: baseoutputwriter.hh:43
virtual void beginWrite(double t)=0
Called when ever a new time step or a new grid must be written.
virtual void attachTensorElementData(TensorBuffer &buf, std::string name)=0
Add a tensorial element centered quantity to the output.
virtual void endWrite(bool onlyDiscard=false)=0
Finalizes the current writer.
virtual void attachVectorVertexData(VectorBuffer &buf, std::string name)=0
Add a vectorial vertex centered vector field to the output.
virtual void attachScalarElementData(ScalarBuffer &buf, std::string name)=0
Add a scalar element centered quantity to the output.
virtual void attachTensorVertexData(TensorBuffer &buf, std::string name)=0
Add a tensorial vertex centered tensor field to the output.
virtual void attachVectorElementData(VectorBuffer &buf, std::string name)=0
Add a vectorial element centered quantity to the output.
virtual void attachScalarVertexData(ScalarBuffer &buf, std::string name)=0
Add a scalar vertex centered vector field to the output.