baseoutputwriter.hh

Go to the documentation of this file.

// -*- 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.
*/
#ifndef EWOMS_BASE_OUTPUT_WRITER_HH
#define EWOMS_BASE_OUTPUT_WRITER_HH

#include <dune/common/dynmatrix.hh>
#include <dune/common/dynvector.hh>

#include <string_view>
#include <vector>

namespace Opm {

class BaseOutputWriter
{
public:
    using Scalar = double;
    using Tensor = Dune::DynamicMatrix<double>;
    using Vector = Dune::DynamicVector<double>;
    using ScalarBuffer = std::vector<Scalar>;
    using TensorBuffer = std::vector<Tensor>;
    using VectorBuffer = std::vector<Vector>;

    virtual ~BaseOutputWriter() = default;

    virtual void beginWrite(double t) = 0;

    virtual void attachScalarVertexData(ScalarBuffer& buf, std::string_view name) = 0;

    virtual void attachScalarElementData(ScalarBuffer& buf, std::string_view name) = 0;

    virtual void attachVectorVertexData(VectorBuffer& buf, std::string_view name) = 0;

    virtual void attachVectorElementData(VectorBuffer& buf, std::string_view name) = 0;

    virtual void attachTensorVertexData(TensorBuffer& buf, std::string_view name) = 0;

    virtual void attachTensorElementData(TensorBuffer& buf, std::string_view name) = 0;

    virtual void endWrite(bool onlyDiscard) = 0;
};

} // namespace Opm

#endif