vtkmultiphasemodule.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:
/*
  Copyright (C) 2011-2013 by Andreas Lauser

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

#include "vtkmultiwriter.hh"
#include "baseoutputmodule.hh"

#include <ewoms/common/propertysystem.hh>
#include <ewoms/common/parametersystem.hh>

#include <opm/material/common/MathToolbox.hpp>

#include <dune/common/fvector.hh>

#include <cstdio>

namespace Ewoms {
namespace Properties {
// create new type tag for the VTK multi-phase output
NEW_TYPE_TAG(VtkMultiPhase);

// create the property tags needed for the multi phase module
NEW_PROP_TAG(VtkWritePressures);
NEW_PROP_TAG(VtkWriteDensities);
NEW_PROP_TAG(VtkWriteSaturations);
NEW_PROP_TAG(VtkWriteMobilities);
NEW_PROP_TAG(VtkWriteRelativePermeabilities);
NEW_PROP_TAG(VtkWriteViscosities);
NEW_PROP_TAG(VtkWriteAverageMolarMasses);
NEW_PROP_TAG(VtkWritePorosity);
NEW_PROP_TAG(VtkWriteIntrinsicPermeabilities);
NEW_PROP_TAG(VtkWritePotentialGradients);
NEW_PROP_TAG(VtkWriteFilterVelocities);
NEW_PROP_TAG(VtkOutputFormat);
NEW_PROP_TAG(Evaluation);

// set default values for what quantities to output
SET_BOOL_PROP(VtkMultiPhase, VtkWritePressures, true);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteDensities, true);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteSaturations, true);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteMobilities, false);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteRelativePermeabilities, true);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteViscosities, false);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteAverageMolarMasses, false);
SET_BOOL_PROP(VtkMultiPhase, VtkWritePorosity, true);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteIntrinsicPermeabilities, false);
SET_BOOL_PROP(VtkMultiPhase, VtkWritePotentialGradients, false);
SET_BOOL_PROP(VtkMultiPhase, VtkWriteFilterVelocities, false);
} // namespace Properties

template<class TypeTag>
class VtkMultiPhaseModule : public BaseOutputModule<TypeTag>
{
    typedef BaseOutputModule<TypeTag> ParentType;

    typedef typename GET_PROP_TYPE(TypeTag, Simulator) Simulator;
    typedef typename GET_PROP_TYPE(TypeTag, Scalar) Scalar;
    typedef typename GET_PROP_TYPE(TypeTag, Evaluation) Evaluation;
    typedef typename GET_PROP_TYPE(TypeTag, ElementContext) ElementContext;

    typedef typename GET_PROP_TYPE(TypeTag, GridView) GridView;
    typedef typename GET_PROP_TYPE(TypeTag, FluidSystem) FluidSystem;
    typedef typename GET_PROP_TYPE(TypeTag, DiscBaseOutputModule) DiscBaseOutputModule;

    static const int vtkFormat = GET_PROP_VALUE(TypeTag, VtkOutputFormat);
    typedef Ewoms::VtkMultiWriter<GridView, vtkFormat> VtkMultiWriter;

    typedef Opm::MathToolbox<Evaluation> Toolbox;

    enum { dimWorld = GridView::dimensionworld };
    enum { numPhases = GET_PROP_VALUE(TypeTag, NumPhases) };

    typedef typename ParentType::ScalarBuffer ScalarBuffer;
    typedef typename ParentType::VectorBuffer VectorBuffer;
    typedef typename ParentType::TensorBuffer TensorBuffer;
    typedef typename ParentType::PhaseBuffer PhaseBuffer;

    typedef Dune::FieldVector<Scalar, dimWorld> DimVector;

    typedef std::array<VectorBuffer, numPhases> PhaseVectorBuffer;

public:
    VtkMultiPhaseModule(const Simulator &simulator)
        : ParentType(simulator)
    {}

    static void registerParameters()
    {
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWritePressures,
                             "Include the phase pressures in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteDensities,
                             "Include the phase densities in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteSaturations,
                             "Include the phase saturations in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteMobilities,
                             "Include the phase mobilities in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteRelativePermeabilities,
                             "Include the phase relative permeabilities in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteViscosities,
                             "Include component phase viscosities in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteAverageMolarMasses,
                             "Include the average phase mass in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWritePorosity,
                             "Include the porosity in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteIntrinsicPermeabilities,
                             "Include the intrinsic permeability in the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWriteFilterVelocities,
                             "Include in the filter velocities of the phases the VTK output files");
        EWOMS_REGISTER_PARAM(TypeTag, bool, VtkWritePotentialGradients,
                             "Include the phase pressure potential gradients in the VTK output files");
    }

    void allocBuffers()
    {
        if (pressureOutput_()) this->resizePhaseBuffer_(pressure_);
        if (densityOutput_()) this->resizePhaseBuffer_(density_);
        if (saturationOutput_()) this->resizePhaseBuffer_(saturation_);
        if (mobilityOutput_()) this->resizePhaseBuffer_(mobility_);
        if (relativePermeabilityOutput_()) this->resizePhaseBuffer_(relativePermeability_);
        if (viscosityOutput_()) this->resizePhaseBuffer_(viscosity_);
        if (averageMolarMassOutput_()) this->resizePhaseBuffer_(averageMolarMass_);

        if (porosityOutput_()) this->resizeScalarBuffer_(porosity_);
        if (intrinsicPermeabilityOutput_()) this->resizeTensorBuffer_(intrinsicPermeability_);

        if (velocityOutput_()) {
            Scalar nDof = this->simulator_.model().numGridDof();
            for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
                velocity_[phaseIdx].resize(nDof);
                for (int dofIdx = 0; dofIdx < nDof; ++ dofIdx) {
                    velocity_[phaseIdx][dofIdx].resize(dimWorld);
                    velocity_[phaseIdx][dofIdx] = 0.0;
                }
            }
            this->resizePhaseBuffer_(velocityWeight_);
        }

        if (potentialGradientOutput_()) {
            Scalar nDof = this->simulator_.model().numGridDof();
            for (int phaseIdx = 0; phaseIdx < numPhases; ++ phaseIdx) {
                potentialGradient_[phaseIdx].resize(nDof);
                for (int dofIdx = 0; dofIdx < nDof; ++ dofIdx) {
                    potentialGradient_[phaseIdx][dofIdx].resize(dimWorld);
                    potentialGradient_[phaseIdx][dofIdx] = 0.0;
                }
            }

            this->resizePhaseBuffer_(potentialWeight_);
        }
    }

    void processElement(const ElementContext &elemCtx)
    {
        typedef Opm::MathToolbox<Evaluation> Toolbox;

        for (int i = 0; i < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++i) {
            int I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);
            const auto &intQuants = elemCtx.intensiveQuantities(i, /*timeIdx=*/0);
            const auto &fs = intQuants.fluidState();

            if (porosityOutput_()) porosity_[I] = Toolbox::value(intQuants.porosity());
            if (intrinsicPermeabilityOutput_()) {
                const auto& K = intQuants.intrinsicPermeability();
                intrinsicPermeability_[I].resize(K.rows, K.cols);
                for (int rowIdx = 0; rowIdx < K.rows; ++rowIdx)
                    for (int colIdx = 0; colIdx < K.cols; ++colIdx)
                        intrinsicPermeability_[I][rowIdx][colIdx] = K[rowIdx][colIdx];
            }

            for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
                if (pressureOutput_())
                    pressure_[phaseIdx][I] = Toolbox::value(fs.pressure(phaseIdx));
                if (densityOutput_())
                    density_[phaseIdx][I] = Toolbox::value(fs.density(phaseIdx));
                if (saturationOutput_())
                    saturation_[phaseIdx][I] = Toolbox::value(fs.saturation(phaseIdx));
                if (mobilityOutput_())
                    mobility_[phaseIdx][I] = Toolbox::value(intQuants.mobility(phaseIdx));
                if (relativePermeabilityOutput_())
                    relativePermeability_[phaseIdx][I] = Toolbox::value(intQuants.relativePermeability(phaseIdx));
                if (viscosityOutput_())
                    viscosity_[phaseIdx][I] = Toolbox::value(fs.viscosity(phaseIdx));
                if (averageMolarMassOutput_())
                    averageMolarMass_[phaseIdx][I] = Toolbox::value(fs.averageMolarMass(phaseIdx));
            }
        }

        if (potentialGradientOutput_()) {
            // calculate velocities if requested
            for (int faceIdx = 0; faceIdx < elemCtx.numInteriorFaces(/*timeIdx=*/0); ++ faceIdx) {
                const auto &extQuants = elemCtx.extensiveQuantities(faceIdx, /*timeIdx=*/0);

                int i = extQuants.interiorIndex();
                int I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);

                for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
                    Scalar weight = extQuants.extrusionFactor();

                    potentialWeight_[phaseIdx][I] += weight;

                    const auto &inputPGrad = extQuants.potentialGrad(phaseIdx);
                    DimVector pGrad;
                    for (int j = 0; j < numPhases; ++j)
                        pGrad[j] = Toolbox::value(inputPGrad[j])*weight;
                    potentialGradient_[phaseIdx][I] += pGrad;
                } // end for all phases
            } // end for all faces
        }

        if (velocityOutput_()) {
            // calculate velocities if requested
            for (int faceIdx = 0; faceIdx < elemCtx.numInteriorFaces(/*timeIdx=*/0); ++ faceIdx) {
                const auto &extQuants = elemCtx.extensiveQuantities(faceIdx, /*timeIdx=*/0);

                int i = extQuants.interiorIndex();
                int I = elemCtx.globalSpaceIndex(i, /*timeIdx=*/0);

                int j = extQuants.exteriorIndex();
                int J = elemCtx.globalSpaceIndex(j, /*timeIdx=*/0);

                for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
                    Scalar weight = std::max<Scalar>(1e-16,
                                                     std::abs(Toolbox::value(extQuants.volumeFlux(phaseIdx))));
                    Valgrind::CheckDefined(extQuants.extrusionFactor());
                    assert(extQuants.extrusionFactor() > 0);
                    weight *= extQuants.extrusionFactor();

                    const auto& inputV = extQuants.filterVelocity(phaseIdx);
                    DimVector v;
                    for (int k = 0; k < dimWorld; ++k)
                        v[k] = Toolbox::value(inputV[k]);
                    if (v.two_norm() > 1e-20)
                        weight /= v.two_norm();
                    v *= weight;

                    velocity_[phaseIdx][I] += v;
                    velocity_[phaseIdx][J] += v;

                    velocityWeight_[phaseIdx][I] += weight;
                    velocityWeight_[phaseIdx][J] += weight;
                } // end for all phases
            } // end for all faces
        }
    }

    void commitBuffers(BaseOutputWriter &baseWriter)
    {
        VtkMultiWriter *vtkWriter = dynamic_cast<VtkMultiWriter*>(&baseWriter);
        if (!vtkWriter)
            return;

        if (pressureOutput_())
            this->commitPhaseBuffer_(baseWriter, "pressure_%s", pressure_);
        if (densityOutput_())
            this->commitPhaseBuffer_(baseWriter, "density_%s", density_);
        if (saturationOutput_())
            this->commitPhaseBuffer_(baseWriter, "saturation_%s", saturation_);
        if (mobilityOutput_())
            this->commitPhaseBuffer_(baseWriter, "mobility_%s", mobility_);
        if (relativePermeabilityOutput_())
            this->commitPhaseBuffer_(baseWriter, "relativePerm_%s", relativePermeability_);
        if (viscosityOutput_())
            this->commitPhaseBuffer_(baseWriter, "viscosity_%s", viscosity_);
        if (averageMolarMassOutput_())
            this->commitPhaseBuffer_(baseWriter, "averageMolarMass_%s", averageMolarMass_);

        if (porosityOutput_())
            this->commitScalarBuffer_(baseWriter, "porosity", porosity_);
        if (intrinsicPermeabilityOutput_())
            this->commitTensorBuffer_(baseWriter, "intrinsicPerm", intrinsicPermeability_);

        if (velocityOutput_()) {
            int nDof = this->simulator_.model().numGridDof();

            for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
                // first, divide the velocity field by the
                // respective finite volume's surface area
                for (int i = 0; i < nDof; ++i)
                    velocity_[phaseIdx][i] /= velocityWeight_[phaseIdx][i];
                // commit the phase velocity
                char name[512];
                snprintf(name, 512, "filterVelocity_%s", FluidSystem::phaseName(phaseIdx));

                DiscBaseOutputModule::attachVectorDofData_(baseWriter, velocity_[phaseIdx], name);
            }
        }

        if (potentialGradientOutput_()) {
            int nDof = this->simulator_.model().numGridDof();

            for (int phaseIdx = 0; phaseIdx < numPhases; ++phaseIdx) {
                // first, divide the velocity field by the
                // respective finite volume's surface area
                for (int i = 0; i < nDof; ++i)
                    potentialGradient_[phaseIdx][i] /= potentialWeight_[phaseIdx][i];
                // commit the phase velocity
                char name[512];
                snprintf(name, 512, "gradP_%s", FluidSystem::phaseName(phaseIdx));

                DiscBaseOutputModule::attachVectorDofData_(baseWriter,
                                                           potentialGradient_[phaseIdx],
                                                           name);
            }
        }
    }

private:
    static bool pressureOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWritePressures); }

    static bool densityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteDensities); }

    static bool saturationOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteSaturations); }

    static bool mobilityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteMobilities); }

    static bool relativePermeabilityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteRelativePermeabilities); }

    static bool viscosityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteViscosities); }

    static bool averageMolarMassOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteAverageMolarMasses); }

    static bool porosityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWritePorosity); }

    static bool intrinsicPermeabilityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteIntrinsicPermeabilities); }

    static bool velocityOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWriteFilterVelocities); }

    static bool potentialGradientOutput_()
    { return EWOMS_GET_PARAM(TypeTag, bool, VtkWritePotentialGradients); }

    PhaseBuffer pressure_;
    PhaseBuffer density_;
    PhaseBuffer saturation_;
    PhaseBuffer mobility_;
    PhaseBuffer relativePermeability_;
    PhaseBuffer viscosity_;
    PhaseBuffer averageMolarMass_;

    ScalarBuffer porosity_;
    TensorBuffer intrinsicPermeability_;

    PhaseVectorBuffer velocity_;
    PhaseBuffer velocityWeight_;

    PhaseVectorBuffer potentialGradient_;
    PhaseBuffer potentialWeight_;
};

} // namespace Ewoms

#endif