vtkblackoilsolventmodule.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_BLACK_OIL_SOLVENT_MODULE_HH
#define EWOMS_VTK_BLACK_OIL_SOLVENT_MODULE_HH
 
#include <dune/common/fvector.hh>
 
#include <opm/material/densead/Math.hpp>
 
#include <opm/models/blackoil/blackoilproperties.hh>
 
#include <opm/models/discretization/common/fvbaseparameters.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::Parameters {
 
// set default values for what quantities to output
struct VtkWriteSolventSaturation { static constexpr bool value = true; };
struct VtkWriteSolventRsw { static constexpr bool value = true; };
struct VtkWriteSolventDensity { static constexpr bool value = true; };
struct VtkWriteSolventViscosity { static constexpr bool value = true; };
struct VtkWriteSolventMobility { static constexpr bool value = true; };
 
} // namespace Opm::Properties
 
namespace Opm {
template <class TypeTag>
class VtkBlackOilSolventModule : public BaseOutputModule<TypeTag>
{
    using ParentType = BaseOutputModule<TypeTag>;
 
    using Simulator = GetPropType<TypeTag, Properties::Simulator>;
    using GridView = GetPropType<TypeTag, Properties::GridView>;
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using Evaluation = GetPropType<TypeTag, Properties::Evaluation>;
    using ElementContext = GetPropType<TypeTag, Properties::ElementContext>;
 
    static const int vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
    using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;
 
    enum { enableSolvent = getPropValue<TypeTag, Properties::EnableSolvent>() };
 
    using ScalarBuffer = typename ParentType::ScalarBuffer;
 
public:
    VtkBlackOilSolventModule(const Simulator& simulator)
        : ParentType(simulator)
    { }
 
    static void registerParameters()
    {
        if (!enableSolvent)
            return;
 
        Parameters::Register<Parameters::VtkWriteSolventSaturation>
            ("Include the \"saturation\" of the solvent component "
             "in the VTK output files");
        Parameters::Register<Parameters::VtkWriteSolventRsw>
            ("Include the \"dissolved volume in water\" of the solvent component "
             "in the VTK output files");
        Parameters::Register<Parameters::VtkWriteSolventDensity>
            ("Include the \"density\" of the solvent component "
             "in the VTK output files");
        Parameters::Register<Parameters::VtkWriteSolventViscosity>
            ("Include the \"viscosity\" of the solvent component "
             "in the VTK output files");
        Parameters::Register<Parameters::VtkWriteSolventMobility>
            ("Include the \"mobility\" of the solvent component "
             "in the VTK output files");
    }
 
    void allocBuffers()
    {
        if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
            return;
        }
 
        if (!enableSolvent)
            return;
 
        if (solventSaturationOutput_())
            this->resizeScalarBuffer_(solventSaturation_);
        if (solventRswOutput_())
            this->resizeScalarBuffer_(solventRsw_);
        if (solventDensityOutput_())
            this->resizeScalarBuffer_(solventDensity_);
        if (solventViscosityOutput_())
            this->resizeScalarBuffer_(solventViscosity_);
        if (solventMobilityOutput_())
            this->resizeScalarBuffer_(solventMobility_);
    }
 
    void processElement(const ElementContext& elemCtx)
    {
        if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
            return;
        }
 
        if (!enableSolvent)
            return;
 
        using Toolbox = MathToolbox<Evaluation>;
        for (unsigned dofIdx = 0; dofIdx < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++dofIdx) {
            const auto& intQuants = elemCtx.intensiveQuantities(dofIdx, /*timeIdx=*/0);
            unsigned globalDofIdx = elemCtx.globalSpaceIndex(dofIdx, /*timeIdx=*/0);
 
            if (solventSaturationOutput_())
                solventSaturation_[globalDofIdx] =
                    Toolbox::scalarValue(intQuants.solventSaturation());
 
            if (solventRswOutput_())
                solventRsw_[globalDofIdx] =
                    Toolbox::scalarValue(intQuants.rsSolw());
 
            if (solventDensityOutput_())
                solventDensity_[globalDofIdx] =
                    Toolbox::scalarValue(intQuants.solventDensity());
 
            if (solventViscosityOutput_())
                solventViscosity_[globalDofIdx] =
                    Toolbox::scalarValue(intQuants.solventViscosity());
 
            if (solventMobilityOutput_())
                solventMobility_[globalDofIdx] =
                    Toolbox::scalarValue(intQuants.solventMobility());
        }
    }
 
    void commitBuffers(BaseOutputWriter& baseWriter)
    {
        VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
        if (!vtkWriter)
            return;
 
        if (!enableSolvent)
            return;
 
        if (solventSaturationOutput_())
            this->commitScalarBuffer_(baseWriter, "saturation_solvent", solventSaturation_);
 
        if (solventRswOutput_())
            this->commitScalarBuffer_(baseWriter, "dissolved_solvent", solventRsw_);
 
        if (solventDensityOutput_())
            this->commitScalarBuffer_(baseWriter, "density_solvent", solventDensity_);
 
        if (solventViscosityOutput_())
            this->commitScalarBuffer_(baseWriter, "viscosity_solvent", solventViscosity_);
 
        if (solventMobilityOutput_())
            this->commitScalarBuffer_(baseWriter, "mobility_solvent", solventMobility_);
    }
 
private:
    static bool solventSaturationOutput_()
    {
        static bool val = Parameters::Get<Parameters::VtkWriteSolventSaturation>();
        return val;
    }
 
    static bool solventRswOutput_()
    {
        static bool val = Parameters::Get<Parameters::VtkWriteSolventRsw>();
        return val;
    }
 
    static bool solventDensityOutput_()
    {
        static bool val = Parameters::Get<Parameters::VtkWriteSolventDensity>();
        return val;
    }
 
    static bool solventViscosityOutput_()
    {
        static bool val = Parameters::Get<Parameters::VtkWriteSolventViscosity>();
        return val;
    }
 
    static bool solventMobilityOutput_()
    {
        static bool val = Parameters::Get<Parameters::VtkWriteSolventMobility>();
        return val;
    }
 
    ScalarBuffer solventSaturation_;
    ScalarBuffer solventRsw_;
    ScalarBuffer solventDensity_;
    ScalarBuffer solventViscosity_;
    ScalarBuffer solventMobility_;
};
 
} // namespace Opm
 
#endif