mirror of
https://github.com/OPM/opm-simulators.git
synced 2024-12-27 09:40:59 -06:00
107 lines
3.1 KiB
C++
107 lines
3.1 KiB
C++
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
// vi: set et ts=4 sw=4 sts=4:
|
|
/*
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OPM is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Consult the COPYING file in the top-level source directory of this
|
|
module for the precise wording of the license and the list of
|
|
copyright holders.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \copydoc Opm::BaseOutputWriter
|
|
*/
|
|
#ifndef EWOMS_BASE_OUTPUT_WRITER_HH
|
|
#define EWOMS_BASE_OUTPUT_WRITER_HH
|
|
|
|
#include <dune/common/dynvector.hh>
|
|
#include <dune/common/dynmatrix.hh>
|
|
|
|
#include <vector>
|
|
|
|
namespace Opm {
|
|
/*!
|
|
* \brief The base class for all output writers.
|
|
*
|
|
* The sole purpose of this class is to enable RTTI
|
|
* (i.e. dynamic_cast) on writer objects.
|
|
*/
|
|
class BaseOutputWriter
|
|
{
|
|
public:
|
|
using Scalar = double;
|
|
using Vector = Dune::DynamicVector<double>;
|
|
using Tensor = Dune::DynamicMatrix<double>;
|
|
using ScalarBuffer = std::vector<Scalar>;
|
|
using VectorBuffer = std::vector<Vector>;
|
|
using TensorBuffer = std::vector<Tensor>;
|
|
|
|
BaseOutputWriter()
|
|
{}
|
|
|
|
virtual ~BaseOutputWriter()
|
|
{}
|
|
|
|
/*!
|
|
* \brief Called when ever a new time step or a new grid
|
|
* must be written.
|
|
*/
|
|
virtual void beginWrite(double t) = 0;
|
|
|
|
/*!
|
|
* \brief Add a scalar vertex centered vector field to the output.
|
|
*/
|
|
virtual void attachScalarVertexData(ScalarBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Add a scalar element centered quantity to the output.
|
|
*/
|
|
virtual void attachScalarElementData(ScalarBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Add a vectorial vertex centered vector field to the output.
|
|
*/
|
|
virtual void attachVectorVertexData(VectorBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Add a vectorial element centered quantity to the output.
|
|
*/
|
|
virtual void attachVectorElementData(VectorBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Add a tensorial vertex centered tensor field to the output.
|
|
*/
|
|
virtual void attachTensorVertexData(TensorBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Add a tensorial element centered quantity to the output.
|
|
*/
|
|
virtual void attachTensorElementData(TensorBuffer& buf, std::string name) = 0;
|
|
|
|
/*!
|
|
* \brief Finalizes the current writer.
|
|
*
|
|
* This means that everything will be written to disk, except if
|
|
* the onlyDiscard argument is true. In this case only all managed
|
|
* buffers are deleted, but no output is written.
|
|
*/
|
|
virtual void endWrite(bool onlyDiscard = false) = 0;
|
|
};
|
|
} // namespace Opm
|
|
|
|
#endif
|