porousmediumflow/1pnc/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_1PNC_VOLUME_VARIABLES_HH
#define DUMUX_1PNC_VOLUME_VARIABLES_HH
 
#include <dune/common/fvector.hh>
 
#include <dumux/porousmediumflow/volumevariables.hh>
#include <dumux/porousmediumflow/nonisothermal/volumevariables.hh>
#include <dumux/material/solidstates/updatesolidvolumefractions.hh>
 
namespace Dumux {
 
template <class Traits>
class OnePNCVolumeVariables
: public PorousMediumFlowVolumeVariables<Traits>
, public EnergyVolumeVariables<Traits, OnePNCVolumeVariables<Traits> >
{
    using ParentType = PorousMediumFlowVolumeVariables<Traits>;
    using EnergyVolVars = EnergyVolumeVariables<Traits, OnePNCVolumeVariables<Traits> >;
    using Scalar = typename Traits::PrimaryVariables::value_type;
    using PermeabilityType = typename Traits::PermeabilityType;
    using EffDiffModel = typename Traits::EffectiveDiffusivityModel;
    using Idx = typename Traits::ModelTraits::Indices;
    static constexpr int numFluidComps = ParentType::numFluidComponents();
    using DiffusionCoefficients = typename Traits::DiffusionType::DiffusionCoefficientsContainer;
 
    enum
    {
        // pressure primary variable index
        pressureIdx = Idx::pressureIdx
    };
 
public:
    using FluidState = typename Traits::FluidState;
    using FluidSystem = typename Traits::FluidSystem;
    using Indices = typename Traits::ModelTraits::Indices;
    using SolidState = typename Traits::SolidState;
    using SolidSystem = typename Traits::SolidSystem;
 
    static constexpr bool useMoles() { return Traits::ModelTraits::useMoles(); }
 
    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_);
 
        // calculate the remaining quantities
        updateSolidVolumeFractions(elemSol, problem, element, scv, solidState_, numFluidComps);
        EnergyVolVars::updateSolidEnergyParams(elemSol, problem, element, scv, solidState_);
        permeability_ = problem.spatialParams().permeability(element, scv, elemSol);
        EnergyVolVars::updateEffectiveThermalConductivity();
 
        auto getEffectiveDiffusionCoefficient = [&](int phaseIdx, int compIIdx, int compJIdx)
        {
            return EffDiffModel::effectiveDiffusionCoefficient(*this, phaseIdx, compIIdx, compJIdx);
        };
 
        effectiveDiffCoeff_.update(getEffectiveDiffusionCoefficient);
    }
 
    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);
        fluidState.setSaturation(0, 1.0);
 
        const auto& priVars = elemSol[scv.localDofIndex()];
        fluidState.setPressure(0, priVars[pressureIdx]);
 
        // Set fluid state mole fractions
        if (useMoles())
        {
            Scalar sumMoleFracNotMainComp = 0;
            for (int compIdx = 1; compIdx < numFluidComps; ++compIdx)
            {
                fluidState.setMoleFraction(0, compIdx, priVars[compIdx]);
                sumMoleFracNotMainComp += priVars[compIdx];
            }
            fluidState.setMoleFraction(0, 0, 1.0 - sumMoleFracNotMainComp);
        }
        else
        {
            // for mass fractions we only have to set numComponents-1 mass fractions
            // the fluid state will internally compute the remaining mass fraction
            for (int compIdx = 1; compIdx < numFluidComps; ++compIdx)
                fluidState.setMassFraction(0, compIdx, priVars[compIdx]);
        }
 
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updateAll(fluidState);
 
        Scalar rho = FluidSystem::density(fluidState, paramCache, 0);
        Scalar rhoMolar = FluidSystem::molarDensity(fluidState, paramCache, 0);
        Scalar mu = FluidSystem::viscosity(fluidState, paramCache, 0);
 
        fluidState.setDensity(0, rho);
        fluidState.setMolarDensity(0, rhoMolar);
        fluidState.setViscosity(0, mu);
 
        // compute and set the enthalpy
        Scalar h = EnergyVolVars::enthalpy(fluidState, paramCache, 0);
        fluidState.setEnthalpy(0, h);
    }
 
    const FluidState &fluidState() const
    { return fluidState_; }
 
    const SolidState &solidState() const
    { return solidState_; }
 
    Scalar averageMolarMass(int phaseIdx = 0) const
    { return fluidState_.averageMolarMass(0); }
 
    Scalar density(int phaseIdx = 0) const
    {
        return fluidState_.density(0);
    }
 
    Scalar molarDensity(int phaseIdx = 0) const
    {
        return fluidState_.molarDensity(0);
    }
 
    Scalar saturation(int phaseIdx = 0) const
    { return 1.0; }
 
    Scalar moleFraction(int phaseIdx, int compIdx) const
    {
        // make sure this is only called with admissible indices
        assert(compIdx < numFluidComps);
        return fluidState_.moleFraction(0, compIdx);
    }
 
    Scalar massFraction(int phaseIdx, int compIdx) const
    {
        // make sure this is only called with admissible indices
        assert(compIdx < numFluidComps);
        return fluidState_.massFraction(0, compIdx);
    }
 
    Scalar pressure(int phaseIdx = 0) const
    {
        return fluidState_.pressure(0);
    }
 
    Scalar temperature() const
    { return fluidState_.temperature(); }
 
    Scalar mobility(int phaseIdx = 0) const
    {
        return 1.0/fluidState_.viscosity(0);
    }
 
    Scalar viscosity(int phaseIdx = 0) const
    {
        return fluidState_.viscosity(0);
    }
 
    Scalar porosity() const
    { return solidState_.porosity(); }
 
    [[deprecated("Will be removed after release 3.2. Use diffusionCoefficient(phaseIdx, compIIdx, compJIdx)!")]]
    Scalar diffusionCoefficient(int phaseIdx, int compIdx) const
    { return diffusionCoefficient(phaseIdx, FluidSystem::getMainComponent(phaseIdx), compIdx); }
 
    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); }
 
    Scalar molarity(int compIdx) const // [moles/m^3]
    {
        assert(compIdx < numFluidComps);
        return fluidState_.molarity(0, compIdx);
    }
 
    Scalar massFraction(int compIdx) const
    {
        assert(compIdx < numFluidComps);
        return fluidState_.massFraction(0, compIdx);
    }
 
    const PermeabilityType& permeability() const
    { return permeability_; }
 
protected:
    FluidState fluidState_;
    SolidState solidState_;
 
private:
    PermeabilityType permeability_;
 
    // Effective diffusion coefficients for the phases
    DiffusionCoefficients effectiveDiffCoeff_;
};
 
} // end namespace Dumux
 
#endif