porousmediumflow/1p/variables.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-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_ONEP_VARIABLES_HH
#define DUMUX_ONEP_VARIABLES_HH
 
#include <dumux/common/concepts/ipdata_.hh>
 
namespace Dumux::Experimental {

template<class Traits>
class OnePVariables
{
    using Scalar = typename Traits::PrimaryVariables::value_type;
    using ModelTraits = typename Traits::ModelTraits;
 
    static_assert(!ModelTraits::enableEnergyBalance(),
                  "The energy balance is currently not implemented for variables defined per local dof");
 
public:
    using PrimaryVariables = typename Traits::PrimaryVariables;
    using Indices = typename ModelTraits::Indices;
    using FluidSystem = typename Traits::FluidSystem;
    using FluidState = typename Traits::FluidState;
    using PermeabilityType = typename Traits::PermeabilityType;

    static constexpr int numFluidPhases() { return ModelTraits::numFluidPhases(); }
    static constexpr int numFluidComponents() { return ModelTraits::numFluidComponents(); }

    template<class ElementSolution, class Problem, class ElementDiscretization, Concept::LocalDofIpData IpData>
    void update(const ElementSolution& elemSol,
                const Problem& problem,
                const ElementDiscretization& elemDisc,
                const IpData& ipData)
    {
        priVars_ = elemSol[ipData.localDofIndex()];
 
        const auto& spatialParams = problem.spatialParams();
        extrusionFactor_ = spatialParams.extrusionFactor(elemDisc, ipData, elemSol);
        porosity_ = spatialParams.porosity(elemDisc, ipData, elemSol);
        permeability_ = spatialParams.permeability(elemDisc, ipData, elemSol);
 
        completeFluidState(elemSol, problem, elemDisc, ipData, fluidState_);
    }

    template<class ElementSolution, class Problem, class ElementDiscretization, Concept::LocalDofIpData IpData>
    void completeFluidState(const ElementSolution& elemSol,
                            const Problem& problem,
                            const ElementDiscretization& elemDisc,
                            const IpData& ipData,
                            FluidState& fluidState) const
    {
        fluidState.setTemperature(/*phaseIdx=*/0, problem.spatialParams().temperature(elemDisc, ipData, elemSol));
        fluidState.setPressure(/*phaseIdx=*/0, elemSol[ipData.localDofIndex()][Indices::pressureIdx]);
 
        // saturation in a single phase is always 1 and thus redundant to set. But since we use
        // the fluid state shared by the immiscible multi-phase models, we have to set it here
        fluidState.setSaturation(/*phaseIdx=*/0, 1.0);
 
        typename FluidSystem::ParameterCache paramCache;
        paramCache.updatePhase(fluidState, /*phaseIdx=*/0);
 
        Scalar value = FluidSystem::density(fluidState, paramCache, /*phaseIdx=*/0);
        fluidState.setDensity(/*phaseIdx=*/0, value);
 
        value = FluidSystem::viscosity(fluidState, paramCache, /*phaseIdx=*/0);
        fluidState.setViscosity(/*phaseIdx=*/0, value);
 
        // the enthalpy is zero for isothermal models
        fluidState.setEnthalpy(/*phaseIdx=*/0, 0.0);
    }

    Scalar extrusionFactor() const
    { return extrusionFactor_; }

    Scalar porosity() const
    { return porosity_; }

    const PermeabilityType& permeability() const
    { return permeability_; }

    Scalar pressure(int phaseIdx = 0) const
    { return fluidState_.pressure(phaseIdx); }

    Scalar saturation(int phaseIdx = 0) const
    { return 1.0; }

    Scalar density(int phaseIdx = 0) const
    { return fluidState_.density(phaseIdx); }

    Scalar molarDensity(int phaseIdx = 0) const
    { return fluidState_.molarDensity(phaseIdx); }

    Scalar viscosity(int phaseIdx = 0) const
    { return fluidState_.viscosity(phaseIdx); }

    Scalar mobility(int phaseIdx = 0) const
    { return 1.0/fluidState_.viscosity(phaseIdx); }

    Scalar temperature() const
    { return fluidState_.temperature(); }

    const FluidState& fluidState() const
    { return fluidState_; }

    Scalar priVar(const int pvIdx) const
    { return priVars_[pvIdx]; }

    const PrimaryVariables& priVars() const
    { return priVars_; }
 
private:
    PrimaryVariables priVars_;
    FluidState fluidState_;
    PermeabilityType permeability_;
    Scalar extrusionFactor_;
    Scalar porosity_;
};
 
} // end namespace Dumux::Experimental
 
#endif