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/dynmatrix.hh>
32#include <dune/common/dynvector.hh>
33
34#include <string_view>
35#include <vector>
36
37namespace Opm {
38
46{
47public:
48 using Scalar = double;
49 using Tensor = Dune::DynamicMatrix<double>;
50 using Vector = Dune::DynamicVector<double>;
51 using ScalarBuffer = std::vector<Scalar>;
52 using TensorBuffer = std::vector<Tensor>;
53 using VectorBuffer = std::vector<Vector>;
54
55 virtual ~BaseOutputWriter() = default;
56
61 virtual void beginWrite(double t) = 0;
62
66 virtual void attachScalarVertexData(ScalarBuffer& buf, std::string_view name) = 0;
67
71 virtual void attachScalarElementData(ScalarBuffer& buf, std::string_view name) = 0;
72
76 virtual void attachVectorVertexData(VectorBuffer& buf, std::string_view name) = 0;
77
81 virtual void attachVectorElementData(VectorBuffer& buf, std::string_view name) = 0;
82
86 virtual void attachTensorVertexData(TensorBuffer& buf, std::string_view name) = 0;
87
91 virtual void attachTensorElementData(TensorBuffer& buf, std::string_view name) = 0;
92
100 virtual void endWrite(bool onlyDiscard) = 0;
101};
102
103} // namespace Opm
104
105#endif
The base class for all output writers.
Definition: baseoutputwriter.hh:46
virtual void attachVectorElementData(VectorBuffer &buf, std::string_view name)=0
Add a vectorial element centered quantity to the output.
virtual void beginWrite(double t)=0
Called when ever a new time step or a new grid must be written.
Dune::DynamicVector< double > Vector
Definition: baseoutputwriter.hh:50
virtual void attachTensorElementData(TensorBuffer &buf, std::string_view name)=0
Add a tensorial element centered quantity to the output.
std::vector< Tensor > TensorBuffer
Definition: baseoutputwriter.hh:52
virtual void attachScalarVertexData(ScalarBuffer &buf, std::string_view name)=0
Add a scalar vertex centered vector field to the output.
virtual ~BaseOutputWriter()=default
virtual void attachVectorVertexData(VectorBuffer &buf, std::string_view name)=0
Add a vectorial vertex centered vector field to the output.
virtual void attachScalarElementData(ScalarBuffer &buf, std::string_view name)=0
Add a scalar element centered quantity to the output.
Dune::DynamicMatrix< double > Tensor
Definition: baseoutputwriter.hh:49
virtual void endWrite(bool onlyDiscard)=0
Finalizes the current writer.
virtual void attachTensorVertexData(TensorBuffer &buf, std::string_view name)=0
Add a tensorial vertex centered tensor field to the output.
std::vector< Vector > VectorBuffer
Definition: baseoutputwriter.hh:53
std::vector< Scalar > ScalarBuffer
Definition: baseoutputwriter.hh:51
double Scalar
Definition: baseoutputwriter.hh:48
Definition: blackoilboundaryratevector.hh:39