porousmediumflow/richardsnc/volumevariables.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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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 3 of the License, or       *
 *   (at your option) any later version.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_RICHARDSNC_VOLUME_VARIABLES_HH
#define DUMUX_RICHARDSNC_VOLUME_VARIABLES_HH
 
#include <algorithm>
#include <array>
 
#include <dumux/porousmediumflow/volumevariables.hh>
#include <dumux/porousmediumflow/nonisothermal/volumevariables.hh>
#include <dumux/material/solidstates/updatesolidvolumefractions.hh>
 
#include <dumux/common/deprecated.hh>
 
namespace Dumux {
 
template <class Traits>
class RichardsNCVolumeVariables
: public PorousMediumFlowVolumeVariables<Traits>
, public EnergyVolumeVariables<Traits, RichardsNCVolumeVariables<Traits> >
{
 
    using ParentType = PorousMediumFlowVolumeVariables<Traits>;
    using EnergyVolVars = EnergyVolumeVariables<Traits, RichardsNCVolumeVariables<Traits> >;
    using Scalar = typename Traits::PrimaryVariables::value_type;
    using PermeabilityType = typename Traits::PermeabilityType;
 
    static constexpr int numFluidComps = ParentType::numFluidComponents();
    static constexpr bool useMoles = Traits::ModelTraits::useMoles();
 
    using EffDiffModel = typename Traits::EffectiveDiffusivityModel;
    using DiffusionCoefficients = typename Traits::DiffusionType::DiffusionCoefficientsContainer;
 
public:
    using FluidSystem = typename Traits::FluidSystem;
    using FluidState = typename Traits::FluidState;
    using SolidState = typename Traits::SolidState;
    using SolidSystem = typename Traits::SolidSystem;
    using Indices = typename Traits::ModelTraits::Indices;
    static constexpr int liquidPhaseIdx = 0;
    static constexpr int gasPhaseIdx = 1;
 
    template<class ElemSol, class Problem, class Element, class Scv>
    void update(const ElemSol &elemSol,
                const Problem &problem,
                const Element &element,
                const Scv& scv)
    {
        ParentType::update(elemSol, problem, element, scv);
 
        completeFluidState(elemSol, problem, element, scv, fluidState_, solidState_);
        // specify the other parameters
 
        // old material law interface is deprecated: Replace this by
        // const auto& fluidMatrixInteraction = spatialParams.fluidMatrixInteraction(element, scv, elemSol);
        // after the release of 3.3, when the deprecated interface is no longer supported
        const auto fluidMatrixInteraction = Deprecated::makePcKrSw(Scalar{}, problem.spatialParams(), element, scv, elemSol);
 
        relativePermeabilityWetting_ = fluidMatrixInteraction.krw(fluidState_.saturation(0));
 
        // precompute the minimum capillary pressure (entry pressure)
        // needed to make sure we don't compute unphysical capillary pressures and thus saturations
        minPc_ = fluidMatrixInteraction.endPointPc();
        pn_ = problem.nonwettingReferencePressure();
        //porosity
        updateSolidVolumeFractions(elemSol, problem, element, scv, solidState_, ParentType::numFluidComponents());
        EnergyVolVars::updateSolidEnergyParams(elemSol, problem, element, scv, solidState_);
        permeability_ = problem.spatialParams().permeability(element, scv, elemSol);
        EnergyVolVars::updateEffectiveThermalConductivity();
 
        // Second instance of a parameter cache.
        // Could be avoided if diffusion coefficients also
        // became part of the fluid state.
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updatePhase(fluidState_, 0);
 
        auto getEffectiveDiffusionCoefficient = [&](int phaseIdx, int compIIdx, int compJIdx)
        {
            return EffDiffModel::effectiveDiffusionCoefficient(*this, phaseIdx, compIIdx, compJIdx);
        };
 
        effectiveDiffCoeff_.update(getEffectiveDiffusionCoefficient);
 
        // calculate the remaining quantities
        EnergyVolVars::updateSolidEnergyParams(elemSol, problem, element, scv, solidState_);
        permeability_ = problem.spatialParams().permeability(element, scv, elemSol);
        EnergyVolVars::updateEffectiveThermalConductivity();
    }
 
    template<class ElemSol, class Problem, class Element, class Scv>
    void completeFluidState(const ElemSol& elemSol,
                            const Problem& problem,
                            const Element& element,
                            const Scv& scv,
                            FluidState& fluidState,
                            SolidState& solidState)
    {
        EnergyVolVars::updateTemperature(elemSol, problem, element, scv, fluidState, solidState);
 
        // old material law interface is deprecated: Replace this by
        // const auto& fluidMatrixInteraction = spatialParams.fluidMatrixInteraction(element, scv, elemSol);
        // after the release of 3.3, when the deprecated interface is no longer supported
        const auto fluidMatrixInteraction = Deprecated::makePcKrSw(Scalar{}, problem.spatialParams(), element, scv, elemSol);
 
        const auto& priVars = elemSol[scv.localDofIndex()];
 
        // set the wetting pressure
        fluidState.setPressure(0, priVars[Indices::pressureIdx]);
 
        // compute the capillary pressure to compute the saturation
        // make sure that we the capillary pressure is not smaller than the minimum pc
        // this would possibly return unphysical values from regularized material laws
        using std::max;
        const Scalar pc = max(fluidMatrixInteraction.endPointPc(),
                              problem.nonwettingReferencePressure() - fluidState.pressure(0));
        const Scalar sw = fluidMatrixInteraction.sw(pc);
        fluidState.setSaturation(0, sw);
 
        // set the mole/mass fractions
        if(useMoles)
        {
            Scalar sumSecondaryFractions = 0.0;
            for (int compIdx = 1; compIdx < ParentType::numFluidComponents(); ++compIdx)
            {
                fluidState.setMoleFraction(0, compIdx, priVars[compIdx]);
                sumSecondaryFractions += priVars[compIdx];
            }
            fluidState.setMoleFraction(0, 0, 1.0 - sumSecondaryFractions);
        }
        else
        {
            for (int compIdx = 1; compIdx < ParentType::numFluidComponents(); ++compIdx)
                fluidState.setMassFraction(0, compIdx, priVars[compIdx]);
        }
 
        // density and viscosity
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updateAll(fluidState);
        fluidState.setDensity(0, FluidSystem::density(fluidState, paramCache, 0));
        fluidState.setMolarDensity(0, FluidSystem::molarDensity(fluidState, paramCache, 0));
        fluidState.setViscosity(0, FluidSystem::viscosity(fluidState, paramCache, 0));
 
        // compute and set the enthalpy
        fluidState.setEnthalpy(0, EnergyVolVars::enthalpy(fluidState, paramCache, 0));
    }
 
    const FluidState &fluidState() const
    { return fluidState_; }
 
    const SolidState &solidState() const
    { return solidState_; }
 
    Scalar averageMolarMass(const int phaseIdx = 0) const
    { return fluidState_.averageMolarMass(phaseIdx); }
 
    Scalar temperature() const
    { return fluidState_.temperature(); }
 
    Scalar porosity() const
    { return solidState_.porosity(); }
 
    const PermeabilityType& permeability() const
    { return permeability_; }
 
    Scalar saturation(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? fluidState_.saturation(0) : 1.0-fluidState_.saturation(0); }
 
    Scalar density(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? fluidState_.density(phaseIdx) : 0.0; }
 
    Scalar pressure(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? fluidState_.pressure(phaseIdx) : pn_; }
 
    Scalar mobility(const int phaseIdx = 0) const
    { return relativePermeability(phaseIdx)/fluidState_.viscosity(phaseIdx); }
 
    Scalar viscosity(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? fluidState_.viscosity(0) : 0.0; }
 
    Scalar relativePermeability(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? relativePermeabilityWetting_ : 1.0; }
 
    Scalar capillaryPressure() const
    {
        using std::max;
        return max(minPc_, pn_ - fluidState_.pressure(0));
    }
 
    Scalar pressureHead(const int phaseIdx = 0) const
    { return 100.0 *(pressure(phaseIdx) - pn_)/density(phaseIdx)/9.81; }
 
    Scalar waterContent(const int phaseIdx = 0) const
    { return saturation(phaseIdx) * solidState_.porosity(); }
 
    Scalar molarDensity(const int phaseIdx = 0) const
    { return phaseIdx == 0 ? this->fluidState_.molarDensity(phaseIdx) : 0.0; }
 
    Scalar moleFraction(const int phaseIdx, const int compIdx) const
    { return phaseIdx == 0 ? this->fluidState_.moleFraction(phaseIdx, compIdx) : 0.0; }
 
    Scalar massFraction(const int phaseIdx, const int compIdx) const
    { return phaseIdx == 0 ? this->fluidState_.massFraction(phaseIdx, compIdx) : 0.0; }
 
    Scalar molarity(const int phaseIdx, const int compIdx) const
    { return phaseIdx == 0 ? this->fluidState_.molarity(phaseIdx, compIdx) : 0.0; }
 
    Scalar diffusionCoefficient(int phaseIdx, int compIIdx, int compJIdx) const
    {
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updatePhase(fluidState_, phaseIdx);
        return FluidSystem::binaryDiffusionCoefficient(fluidState_, paramCache, phaseIdx, compIIdx, compJIdx);
    }
 
    Scalar effectiveDiffusionCoefficient(int phaseIdx, int compIIdx, int compJIdx) const
    { return effectiveDiffCoeff_(phaseIdx, compIIdx, compJIdx); }
 
protected:
    FluidState fluidState_; 
 
private:
    // Effective diffusion coefficients for the phases
    DiffusionCoefficients effectiveDiffCoeff_;
 
    Scalar relativePermeabilityWetting_; // the relative permeability of the wetting phase
    SolidState solidState_;
    PermeabilityType permeability_; // the instrinsic permeability
    Scalar pn_; // the reference nonwetting pressure
    Scalar minPc_; // the minimum capillary pressure (entry pressure)
};
 
} // end namespace Dumux
 
#endif