flashmodel.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_FLASH_MODEL_HH
#define EWOMS_FLASH_MODEL_HH

#include <opm/material/constraintsolvers/NcpFlash.hpp>

#include <opm/material/densead/Math.hpp>

#include <opm/material/fluidmatrixinteractions/MaterialTraits.hpp>
#include <opm/material/fluidmatrixinteractions/NullMaterial.hpp>

#include <opm/models/common/energymodule.hh>
#include <opm/models/common/multiphasebasemodel.hh>

#include <opm/models/flash/flashboundaryratevector.hh>
#include <opm/models/flash/flashextensivequantities.hh>
#include <opm/models/flash/flashindices.hh>
#include <opm/models/flash/flashintensivequantities.hh>
#include <opm/models/flash/flashlocalresidual.hh>
#include <opm/models/flash/flashparameters.hh>
#include <opm/models/flash/flashprimaryvariables.hh>
#include <opm/models/flash/flashproperties.hh>
#include <opm/models/flash/flashratevector.hh>

#include <opm/models/io/vtkcompositionmodule.hpp>
#include <opm/models/io/vtkdiffusionmodule.hpp>
#include <opm/models/io/vtkenergymodule.hpp>

#include <cassert>
#include <memory>
#include <sstream>
#include <string>
#include <tuple>

namespace Opm {

template <class TypeTag>
class FlashModel;

}

namespace Opm::Properties {

namespace TTag {

struct FlashModel
{ using InheritsFrom = std::tuple<MultiPhaseBaseModel>; };

} // namespace TTag

template<class TypeTag>
struct LocalResidual<TypeTag, TTag::FlashModel>
{ using type = FlashLocalResidual<TypeTag>; };

template<class TypeTag>
struct FlashSolver<TypeTag, TTag::FlashModel>
{
    using type = NcpFlash<GetPropType<TypeTag, Properties::Scalar>,
                          GetPropType<TypeTag, Properties::FluidSystem>>;
};

template<class TypeTag>
struct Model<TypeTag, TTag::FlashModel>
{ using type = FlashModel<TypeTag>; };

template<class TypeTag>
struct PrimaryVariables<TypeTag, TTag::FlashModel>
{ using type = FlashPrimaryVariables<TypeTag>; };

template<class TypeTag>
struct RateVector<TypeTag, TTag::FlashModel>
{ using type = FlashRateVector<TypeTag>; };

template<class TypeTag>
struct BoundaryRateVector<TypeTag, TTag::FlashModel>
{ using type = FlashBoundaryRateVector<TypeTag>; };

template<class TypeTag>
struct IntensiveQuantities<TypeTag, TTag::FlashModel>
{ using type = FlashIntensiveQuantities<TypeTag>; };

template<class TypeTag>
struct ExtensiveQuantities<TypeTag, TTag::FlashModel>
{ using type = FlashExtensiveQuantities<TypeTag>; };

template<class TypeTag>
struct Indices<TypeTag, TTag::FlashModel>
{ using type = FlashIndices<TypeTag, /*PVIdx=*/0>; };

// disable molecular diffusion by default
template<class TypeTag>
struct EnableDiffusion<TypeTag, TTag::FlashModel>
{ static constexpr bool value = false; };

template<class TypeTag>
struct EnableEnergy<TypeTag, TTag::FlashModel>
{ static constexpr bool value = false; };

} // namespace Opm::Properties

namespace Opm {

template <class TypeTag>
class FlashModel
    : public MultiPhaseBaseModel<TypeTag>
{
    using ParentType = MultiPhaseBaseModel<TypeTag>;

    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
    using Simulator = GetPropType<TypeTag, Properties::Simulator>;

    using Indices = GetPropType<TypeTag, Properties::Indices>;

    enum { numComponents = getPropValue<TypeTag, Properties::NumComponents>() };
    enum { enableDiffusion = getPropValue<TypeTag, Properties::EnableDiffusion>() };
    enum { enableEnergy = getPropValue<TypeTag, Properties::EnableEnergy>() };

    using EnergyModule = ::Opm::EnergyModule<TypeTag, enableEnergy>;

public:
    explicit FlashModel(Simulator& simulator)
        : ParentType(simulator)
    {}

    static void registerParameters()
    {
        ParentType::registerParameters();

        // register runtime parameters of the VTK output modules
        VtkCompositionModule<TypeTag>::registerParameters();

        if constexpr (enableDiffusion) {
            VtkDiffusionModule<TypeTag>::registerParameters();
        }

        if constexpr (enableEnergy) {
            VtkEnergyModule<TypeTag>::registerParameters();
        }

        Parameters::Register<Parameters::FlashTolerance<Scalar>>
            ("The maximum tolerance for the flash solver to "
             "consider the solution converged");

        // The updates of intensive quantities tend to be _very_ expensive for this
        // model, so let's try to minimize the number of required ones
        Parameters::SetDefault<Parameters::EnableIntensiveQuantityCache>(true);

        // since thermodynamic hints are basically free if the cache for intensive quantities is
        // enabled, and this model usually shows quite a performance improvment if they are
        // enabled, let's enable them by default.
        Parameters::SetDefault<Parameters::EnableThermodynamicHints>(true);
    }

    static std::string name()
    { return "flash"; }

    std::string primaryVarName(unsigned pvIdx) const
    {
        const std::string& tmp = EnergyModule::primaryVarName(pvIdx);
        if (!tmp.empty()) {
            return tmp;
        }

        if (Indices::cTot0Idx <= pvIdx && pvIdx < Indices::cTot0Idx + numComponents) {
            std::ostringstream oss;
            oss << "c_tot," << FluidSystem::componentName(/*compIdx=*/pvIdx - Indices::cTot0Idx);
            return oss.str();
        }
        else {
            assert(false);
            return "";
        }
    }

    std::string eqName(unsigned eqIdx) const
    {
        const std::string& tmp = EnergyModule::eqName(eqIdx);
        if (!tmp.empty()) {
            return tmp;
        }

        if (Indices::conti0EqIdx <= eqIdx && eqIdx < Indices::conti0EqIdx + numComponents) {
            const unsigned compIdx = eqIdx - Indices::conti0EqIdx;
            std::ostringstream oss;
            oss << "continuity^" << FluidSystem::componentName(compIdx);
            return oss.str();
        }
        else {
            assert(false);
            return "";
        }
    }

    Scalar primaryVarWeight(unsigned globalDofIdx, unsigned pvIdx) const
    {
        const Scalar tmp = EnergyModule::primaryVarWeight(*this, globalDofIdx, pvIdx);
        if (tmp > 0) {
            return tmp;
        }

        const unsigned compIdx = pvIdx - Indices::cTot0Idx;

        // make all kg equal. also, divide the weight of all total
        // compositions by 100 to make the relative errors more
        // comparable to the ones of the other models (at 10% porosity
        // the medium is fully saturated with water at atmospheric
        // conditions if 100 kg/m^3 are present!)
        return FluidSystem::molarMass(compIdx) / 100.0;
    }

    Scalar eqWeight(unsigned globalDofIdx, unsigned eqIdx) const
    {
        const Scalar tmp = EnergyModule::eqWeight(*this, globalDofIdx, eqIdx);
        if (tmp > 0) {
            return tmp;
        }

        const unsigned compIdx = eqIdx - Indices::conti0EqIdx;

        // make all kg equal
        return FluidSystem::molarMass(compIdx);
    }

    void registerOutputModules_()
    {
        ParentType::registerOutputModules_();

        // add the VTK output modules which are meaningful for the model
        this->addOutputModule(std::make_unique<VtkCompositionModule<TypeTag>>(this->simulator_));
        if constexpr (enableDiffusion) {
            this->addOutputModule(std::make_unique<VtkDiffusionModule<TypeTag>>(this->simulator_));
        }
        if constexpr (enableEnergy) {
            this->addOutputModule(std::make_unique<VtkEnergyModule<TypeTag>>(this->simulator_));
        }
    }
};

} // namespace Opm

#endif