vtkprimaryvarsmodule.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_VTK_PRIMARY_VARS_MODULE_HH
#define EWOMS_VTK_PRIMARY_VARS_MODULE_HH
 
#include <opm/models/io/baseoutputmodule.hh>
#include <opm/models/io/vtkmultiwriter.hh>
 
#include <opm/models/utils/parametersystem.hh>
#include <opm/models/utils/propertysystem.hh>
 
namespace Opm::Properties {
 
namespace TTag {
 
// create new type tag for the VTK primary variables output
struct VtkPrimaryVars {};
 
} // namespace TTag
 
// create the property tags needed for the primary variables module
template<class TypeTag, class MyTypeTag>
struct VtkWritePrimaryVars { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct VtkWriteProcessRank { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct VtkWriteDofIndex { using type = UndefinedProperty; };
 
template<class TypeTag>
struct VtkWritePrimaryVars<TypeTag, TTag::VtkPrimaryVars> { static constexpr bool value = false; };
template<class TypeTag>
struct VtkWriteProcessRank<TypeTag, TTag::VtkPrimaryVars> { static constexpr bool value = false; };
template<class TypeTag>
struct VtkWriteDofIndex<TypeTag, TTag::VtkPrimaryVars> { static constexpr bool value = false; };
 
} // namespace Opm::Properties
 
namespace Opm {
 
template<class TypeTag>
class VtkPrimaryVarsModule : public BaseOutputModule<TypeTag>
{
    using ParentType = BaseOutputModule<TypeTag>;
 
    using Simulator = GetPropType<TypeTag, Properties::Simulator>;
    using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
    using GridView = GetPropType<TypeTag, Properties::GridView>;
 
    static const int vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
    using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
 
    using ScalarBuffer = typename ParentType::ScalarBuffer;
    using EqBuffer = typename ParentType::EqBuffer;
 
    enum { numEq = getPropValue<TypeTag, Properties::NumEq>() };
 
public:
    VtkPrimaryVarsModule(const Simulator& simulator)
        : ParentType(simulator)
    { }
 
    static void registerParameters()
    {
        Parameters::registerParam<TypeTag, Properties::VtkWritePrimaryVars>
            ("Include the primary variables into the VTK output files");
        Parameters::registerParam<TypeTag, Properties::VtkWriteProcessRank>
            ("Include the MPI process rank into the VTK output files");
        Parameters::registerParam<TypeTag, Properties::VtkWriteDofIndex>
            ("Include the index of the degrees of freedom into the VTK output files");
    }
 
    void allocBuffers()
    {
        if (primaryVarsOutput_())
            this->resizeEqBuffer_(primaryVars_);
        if (processRankOutput_())
            this->resizeScalarBuffer_(processRank_,
                                      /*bufferType=*/ParentType::ElementBuffer);
        if (dofIndexOutput_())
            this->resizeScalarBuffer_(dofIndex_);
    }
 
    void processElement(const ElementContext& elemCtx)
    {
        if (!Parameters::get<TypeTag, Properties::EnableVtkOutput>())
            return;
 
        const auto& elementMapper = elemCtx.model().elementMapper();
        unsigned elemIdx = static_cast<unsigned>(elementMapper.index(elemCtx.element()));
        if (processRankOutput_() && !processRank_.empty())
            processRank_[elemIdx] = static_cast<unsigned>(this->simulator_.gridView().comm().rank());
 
        for (unsigned i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
            unsigned I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
            const auto& priVars = elemCtx.primaryVars(i, /*timeIdx=*/0);
 
            if (dofIndexOutput_())
                dofIndex_[I] = I;
 
            for (unsigned eqIdx = 0; eqIdx < numEq; ++eqIdx) {
                if (primaryVarsOutput_() && !primaryVars_[eqIdx].empty())
                    primaryVars_[eqIdx][I] = priVars[eqIdx];
            }
        }
    }
 
    void commitBuffers(BaseOutputWriter& baseWriter)
    {
        VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
        if (!vtkWriter) {
            return;
        }
 
        if (primaryVarsOutput_())
            this->commitPriVarsBuffer_(baseWriter, "PV_%s", primaryVars_);
        if (processRankOutput_())
            this->commitScalarBuffer_(baseWriter,
                                      "process rank",
                                      processRank_,
                                      /*bufferType=*/ParentType::ElementBuffer);
        if (dofIndexOutput_())
            this->commitScalarBuffer_(baseWriter, "DOF index", dofIndex_);
    }
 
private:
    static bool primaryVarsOutput_()
    {
        static bool val = Parameters::get<TypeTag, Properties::VtkWritePrimaryVars>();
        return val;
    }
    static bool processRankOutput_()
    {
        static bool val = Parameters::get<TypeTag, Properties::VtkWriteProcessRank>();
        return val;
    }
    static bool dofIndexOutput_()
    {
        static bool val = Parameters::get<TypeTag, Properties::VtkWriteDofIndex>();
        return val;
    }
 
    EqBuffer primaryVars_;
    ScalarBuffer processRank_;
    ScalarBuffer dofIndex_;
};
 
} // namespace Opm
 
#endif