GridDataOutput.hpp

Go to the documentation of this file.

/*
  Copyright 2023 Inria, Bretagne–Atlantique Research Center

  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 3 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/>.
*/

#ifndef OPM_GRID_DATA_OUTPUT_HPP
#define OPM_GRID_DATA_OUTPUT_HPP

#include <opm/common/ErrorMacros.hpp>

#include <dune/grid/common/partitionset.hh>

#include <iosfwd>
#include <string>

namespace Opm::GridDataOutput
{
enum ConnectivityVertexOrder { DUNE = 0, VTK = 1 };

template <class GridView, unsigned int partitions>
class SimMeshDataAccessor
{
public:
    explicit SimMeshDataAccessor(const GridView& gridView,
                                 Dune::PartitionSet<partitions> dunePartition);

    bool polyhedralCellPresent() const;

    void countEntities();

    template <typename T>
    long writeGridPoints(T* x_inout, T* y_inout, T* z_inout, long max_size = 0) const;

    template <typename VectType>
    long writeGridPoints(VectType& x_inout, VectType& y_inout, VectType& z_inout) const;

    template <typename T>
    long writeGridPoints_AOS(T* xyz_inout, long max_size = 0) const;

    template <typename VectType>
    long writeGridPoints_AOS(VectType& xyz_inout) const;

    template <typename T>
    long writeGridPoints_SOA(T* xyz_inout, long max_size = 0) const;

    template <typename VectType>
    long writeGridPoints_SOA(VectType& xyz_inout) const;

    template <typename Integer>
    long writeConnectivity(Integer* connectivity_inout,
                           ConnectivityVertexOrder whichOrder, long max_size = 0) const;

    template <typename VectType>
    long writeConnectivity(VectType& connectivity_inout,
                           ConnectivityVertexOrder whichOrder) const;

    template <typename Integer>
    long writeOffsetsCells(Integer* offsets_inout, long max_size = 0) const;

    template <typename VectType>
    long writeOffsetsCells(VectType& offsets_inout) const;

    template <typename Integer>
    long writeCellTypes(Integer* types_inout, long max_size = 0) const;

    template <typename VectType>
    long writeCellTypes(VectType& types_inout) const;

    std::string getPartitionTypeString() const;

    Dune::PartitionSet<partitions> getPartition(void)
    {
        return this->dunePartition_;
    }

    void printGridDetails(std::ostream& outstr) const;

    int getNCells() const
    {
        return ncells_;
    }

    int getNVertices() const
    {
        return nvertices_;
    }

    int getNCorners() const
    {
        return ncorners_;
    }

    std::string getError() const
    {
        return error_;
    }

    void clearError()
    {
        error_.clear();
    }

    bool hasError() const
    {
        return !error_.empty();
    }

protected:
    GridView gridView_; // the grid

    Dune::PartitionSet<partitions> dunePartition_;
    unsigned int partition_value_;

    int ncells_;
    int nvertices_;
    int ncorners_;

    int dimw_; // dimensions of the input grid

private:
    std::string error_;
};

} // namespace Opm::GridDataOutput

#endif