vtkblackoilbioeffectsmodule.hpp

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 OPM_VTK_BLACK_OIL_BIOEFFECTS_MODULE_HPP
#define OPM_VTK_BLACK_OIL_BIOEFFECTS_MODULE_HPP

#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/vtkblackoilbioeffectsparams.hpp>
#include <opm/models/io/vtkmultiwriter.hh>

#include <opm/models/utils/parametersystem.hpp>
#include <opm/models/utils/propertysystem.hh>

namespace Opm {
template <class TypeTag>
class VtkBlackOilBioeffectsModule : 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>;
    using Indices = GetPropType<TypeTag, Properties::Indices>;

    static constexpr auto vtkFormat = getPropValue<TypeTag, Properties::VtkOutputFormat>();
    using VtkMultiWriter = ::Opm::VtkMultiWriter<GridView, vtkFormat>;

    enum { enableBioeffects = getPropValue<TypeTag, Properties::EnableBioeffects>() };
    enum { enableMICP = Indices::enableMICP };

    using BufferType = typename ParentType::BufferType;
    using ScalarBuffer = typename ParentType::ScalarBuffer;

public:
    explicit VtkBlackOilBioeffectsModule(const Simulator& simulator)
        : ParentType(simulator)
    {
        if constexpr (enableBioeffects) {
            params_.read(enableMICP);
        }
    }

    static void registerParameters()
    {
        if constexpr (enableBioeffects) {
            VtkBlackOilBioeffectsParams::registerParameters(enableMICP);
        }
    }

    void allocBuffers() override
    {
        if constexpr (enableBioeffects) {
            if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
                return;
            }

            if (params_.microbialConcentrationOutput_) {
                this->resizeScalarBuffer_(microbialConcentration_, BufferType::Dof);
            }
            if (params_.biofilmVolumeFractionOutput_) {
                this->resizeScalarBuffer_(biofilmVolumeFraction_, BufferType::Dof);
            }
            if constexpr (enableMICP) {
                if (params_.oxygenConcentrationOutput_) {
                    this->resizeScalarBuffer_(oxygenConcentration_, BufferType::Dof);
                }
                if (params_.ureaConcentrationOutput_) {
                    this->resizeScalarBuffer_(ureaConcentration_, BufferType::Dof);
                }
                if (params_.calciteVolumeFractionOutput_) {
                    this->resizeScalarBuffer_(calciteVolumeFraction_, BufferType::Dof);
                }
            }
        }
    }

    void processElement(const ElementContext& elemCtx) override
    {
        if constexpr (enableBioeffects) {
            if (!Parameters::Get<Parameters::EnableVtkOutput>()) {
                return;
            }

            for (unsigned dofIdx = 0; dofIdx < elemCtx.numPrimaryDof(/*timeIdx=*/0); ++dofIdx) {
                const auto& intQuants = elemCtx.intensiveQuantities(dofIdx, /*timeIdx=*/0);
                const unsigned globalDofIdx = elemCtx.globalSpaceIndex(dofIdx, /*timeIdx=*/0);

                if (params_.microbialConcentrationOutput_) {
                    microbialConcentration_[globalDofIdx] =
                        scalarValue(intQuants.microbialConcentration());
                }
                if (params_.biofilmVolumeFractionOutput_) {
                    biofilmVolumeFraction_[globalDofIdx] =
                        scalarValue(intQuants.biofilmVolumeFraction());
                }
                if constexpr (enableMICP) {
                    if (params_.oxygenConcentrationOutput_) {
                        oxygenConcentration_[globalDofIdx] =
                            scalarValue(intQuants.oxygenConcentration());
                    }
                    if (params_.ureaConcentrationOutput_) {
                        ureaConcentration_[globalDofIdx] =
                            scalarValue(intQuants.ureaConcentration());
                    }
                    if (params_.calciteVolumeFractionOutput_) {
                        calciteVolumeFraction_[globalDofIdx] =
                            scalarValue(intQuants.calciteVolumeFraction());
                    }
                }
            }
        }
    }

    void commitBuffers(BaseOutputWriter& baseWriter) override
    {
        if constexpr (enableBioeffects) {
            if (!dynamic_cast<VtkMultiWriter*>(&baseWriter)) {
                return;
            }

            if (params_.microbialConcentrationOutput_) {
                this->commitScalarBuffer_(baseWriter, "microbial concentration",
                                          microbialConcentration_, BufferType::Dof);
            }
            if (params_.biofilmVolumeFractionOutput_) {
                this->commitScalarBuffer_(baseWriter, "biofilm volume fraction",
                                          biofilmVolumeFraction_, BufferType::Dof);
            }
            if constexpr (enableMICP) {
                if (params_.oxygenConcentrationOutput_) {
                    this->commitScalarBuffer_(baseWriter, "oxygen concentration",
                                              oxygenConcentration_, BufferType::Dof);
                }
                if (params_.ureaConcentrationOutput_) {
                    this->commitScalarBuffer_(baseWriter, "urea concentration",
                                              ureaConcentration_, BufferType::Dof);
                }
                if (params_.calciteVolumeFractionOutput_) {
                    this->commitScalarBuffer_(baseWriter, "calcite volume fraction",
                                              calciteVolumeFraction_, BufferType::Dof);
                }
            }
        }
    }

private:
    VtkBlackOilBioeffectsParams params_{};
    ScalarBuffer microbialConcentration_{};
    ScalarBuffer oxygenConcentration_{};
    ScalarBuffer ureaConcentration_{};
    ScalarBuffer biofilmVolumeFraction_{};
    ScalarBuffer calciteVolumeFraction_{};
};

} // namespace Opm

#endif // OPM_VTK_BLACK_OIL_BIOEFFECTS_MODULE_HPP