porousmediumflow/richards/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:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_RICHARDS_VOLUME_VARIABLES_HH
#define DUMUX_RICHARDS_VOLUME_VARIABLES_HH
 
#include <cassert>
 
#include <dune/common/exceptions.hh>
 
#include <dumux/common/typetraits/state.hh>
 
#include <dumux/porousmediumflow/volumevariables.hh>
#include <dumux/porousmediumflow/nonisothermal/volumevariables.hh>
#include <dumux/material/idealgas.hh>
#include <dumux/material/solidstates/updatesolidvolumefractions.hh>
 
namespace Dumux {
 
template <class Traits>
class RichardsVolumeVariables
: public PorousMediumFlowVolumeVariables<Traits>
, public EnergyVolumeVariables<Traits, RichardsVolumeVariables<Traits> >
{
    using ParentType = PorousMediumFlowVolumeVariables<Traits>;
    using EnergyVolVars = EnergyVolumeVariables<Traits, RichardsVolumeVariables<Traits> >;
    using Scalar = typename Traits::PrimaryVariables::value_type;
    using PermeabilityType = typename Traits::PermeabilityType;
    using ModelTraits = typename Traits::ModelTraits;
 
    static constexpr int numFluidComps = ParentType::numFluidComponents();
    static constexpr int numPhases = ParentType::numFluidPhases();
 
    // checks if the fluid system uses the Richards model index convention
    static constexpr auto fsCheck = ModelTraits::checkFluidSystem(typename Traits::FluidSystem{});
 
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 auto liquidPhaseIdx = Traits::FluidSystem::phase0Idx;
    static constexpr auto gasPhaseIdx = Traits::FluidSystem::phase1Idx;
 
    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);
 
        const auto fluidMatrixInteraction = problem.spatialParams().fluidMatrixInteraction(element, scv, elemSol);
 
        // precompute the minimum capillary pressure (entry pressure)
        // needed to make sure we don't compute unphysical capillary pressures and thus saturations
        minPc_ = fluidMatrixInteraction.endPointPc();
 
        //update porosity before calculating the effective properties depending on it
        updateSolidVolumeFractions(elemSol, problem, element, scv, solidState_, numFluidComps);
        completeFluidState(elemSol, problem, element, scv, fluidState_, solidState_);
 
        // specify the other parameters
        relativePermeabilityWetting_ = fluidMatrixInteraction.krw(fluidState_.saturation(liquidPhaseIdx));
        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);
 
        const auto fluidMatrixInteraction = problem.spatialParams().fluidMatrixInteraction(element, scv, elemSol);
 
        const auto& priVars = elemSol[scv.localDofIndex()];
 
        // set the wetting pressure
        using std::max;
        fluidState.setPressure(liquidPhaseIdx, priVars[Indices::pressureIdx]);
        fluidState.setPressure(gasPhaseIdx, max(problem.nonwettingReferencePressure(), fluidState.pressure(liquidPhaseIdx) + minPc_));
 
        // 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(minPc_, problem.nonwettingReferencePressure() - fluidState.pressure(liquidPhaseIdx));
        const Scalar sw = fluidMatrixInteraction.sw(pc);
        fluidState.setSaturation(liquidPhaseIdx, sw);
        fluidState.setSaturation(gasPhaseIdx, 1.0-sw);
 
        // density and viscosity
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updateAll(fluidState);
        fluidState.setDensity(liquidPhaseIdx,
                              FluidSystem::density(fluidState, paramCache, liquidPhaseIdx));
        fluidState.setDensity(gasPhaseIdx,
                              FluidSystem::density(fluidState, paramCache, gasPhaseIdx));
 
        fluidState.setViscosity(liquidPhaseIdx,
                                FluidSystem::viscosity(fluidState, paramCache, liquidPhaseIdx));
 
        // compute and set the enthalpy
        fluidState.setEnthalpy(liquidPhaseIdx, EnergyVolVars::enthalpy(fluidState, paramCache, liquidPhaseIdx));
        fluidState.setEnthalpy(gasPhaseIdx, EnergyVolVars::enthalpy(fluidState, paramCache, gasPhaseIdx));
    }
 
    const FluidState &fluidState() const
    { return fluidState_; }
 
    const SolidState &solidState() const
    { return solidState_; }
 
    Scalar temperature() const
    { return fluidState_.temperature(); }
 
    Scalar porosity() const
    { return solidState_.porosity(); }
 
    const PermeabilityType& permeability() const
    { return permeability_; }
 
    Scalar saturation(const int phaseIdx = liquidPhaseIdx) const
    { return fluidState_.saturation(phaseIdx); }
 
    Scalar density(const int phaseIdx = liquidPhaseIdx) const
    { return fluidState_.density(phaseIdx); }
 
    Scalar pressure(const int phaseIdx = liquidPhaseIdx) const
    { return fluidState_.pressure(phaseIdx); }
 
    Scalar mobility(const int phaseIdx = liquidPhaseIdx) const
    { return relativePermeability(phaseIdx)/fluidState_.viscosity(phaseIdx); }
 
    Scalar viscosity(const int phaseIdx = liquidPhaseIdx) const
    { return phaseIdx == liquidPhaseIdx ? fluidState_.viscosity(liquidPhaseIdx) : 0.0; }
 
    Scalar relativePermeability(const int phaseIdx = liquidPhaseIdx) const
    { return phaseIdx == liquidPhaseIdx ? relativePermeabilityWetting_ : 1.0; }
 
    Scalar capillaryPressure() const
    {
        using std::max;
        return max(minPc_, pressure(gasPhaseIdx) - pressure(liquidPhaseIdx));
    }
 
    Scalar pressureHead(const int phaseIdx = liquidPhaseIdx) const
    { return 100.0 *(pressure(phaseIdx) - pressure(gasPhaseIdx))/density(phaseIdx)/9.81; }
 
    Scalar waterContent(const int phaseIdx = liquidPhaseIdx) const
    { return saturation(phaseIdx) * solidState_.porosity(); }
 
protected:
    FluidState fluidState_; 
    SolidState solidState_;
    Scalar relativePermeabilityWetting_; 
    PermeabilityType permeability_; 
    Scalar minPc_; 
 
    // Effective diffusion coefficients for the phases
    Scalar effectiveDiffCoeff_;
 
};
} // end namespace Dumux
 
#endif