freeflow/navierstokes/model.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_NAVIERSTOKES_MODEL_HH
#define DUMUX_NAVIERSTOKES_MODEL_HH
 
#include <dumux/common/properties.hh>
#include <dumux/freeflow/properties.hh>
#include <dumux/freeflow/nonisothermal/model.hh>
#include <dumux/freeflow/nonisothermal/indices.hh>
#include <dumux/freeflow/nonisothermal/iofields.hh>
 
#include "localresidual.hh"
#include "volumevariables.hh"
#include "fluxvariables.hh"
#include "indices.hh"
#include "iofields.hh"
 
#include <dumux/material/fluidstates/immiscible.hh>
#include <dumux/discretization/method.hh>
#include <dumux/flux/fourierslaw.hh>
 
namespace Dumux {

template<int dimension>
struct NavierStokesModelTraits
{
    static constexpr int dim() { return dimension; }

    static constexpr int numEq() { return dimension+1; }

    static constexpr int numFluidPhases() { return 1; }

    static constexpr int numFluidComponents() { return 1; }

    static constexpr bool enableAdvection() { return true; }

    static constexpr bool enableMolecularDiffusion() { return false; }

    static constexpr bool enableEnergyBalance() { return false; }

    static constexpr bool usesTurbulenceModel() { return false; }

    static constexpr auto turbulenceModel()
    { return TurbulenceModel::none; }

    using Indices = NavierStokesIndices<dim()>;
};

template<class PV,
         class FSY,
         class FST,
         class MT>
struct NavierStokesVolumeVariablesTraits
{
    using PrimaryVariables = PV;
    using FluidSystem = FSY;
    using FluidState = FST;
    using ModelTraits = MT;
};
 
// \{
// properties for the single-phase Navier-Stokes model
namespace Properties {

// Type tags
 
// Create new type tags
namespace TTag {
struct NavierStokes { using InheritsFrom = std::tuple<FreeFlow>; };

struct NavierStokesNI { using InheritsFrom = std::tuple<NavierStokes>; };
} // end namespace TTag

// default property values for the isothermal single phase model
template<class TypeTag>
struct NormalizePressure<TypeTag, TTag::NavierStokes> { static constexpr bool value = true; }; 

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::NavierStokes>
{
private:
    using GridView = typename GetPropType<TypeTag, Properties::GridGeometry>::GridView;
    static constexpr auto dim = GridView::dimension;
public:
    using type = NavierStokesModelTraits<dim>;
};

template<class TypeTag>
struct FluidState<TypeTag, TTag::NavierStokes>{
private:
    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
    using FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>;
public:
    using type = Dumux::ImmiscibleFluidState<Scalar, FluidSystem>;
};

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

template<class TypeTag>
struct VolumeVariables<TypeTag, TTag::NavierStokes>
{
private:
    using PV = GetPropType<TypeTag, Properties::PrimaryVariables>;
    using FSY = GetPropType<TypeTag, Properties::FluidSystem>;
    using FST = GetPropType<TypeTag, Properties::FluidState>;
    using MT = GetPropType<TypeTag, Properties::ModelTraits>;
 
    static_assert(FSY::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid system");
    static_assert(FST::numPhases == MT::numFluidPhases(), "Number of phases mismatch between model and fluid state");
    static_assert(!FSY::isMiscible(), "The Navier-Stokes model only works with immiscible fluid systems.");
 
    using Traits = NavierStokesVolumeVariablesTraits<PV, FSY, FST, MT>;
public:
    using type = NavierStokesVolumeVariables<Traits>;
};

template<class TypeTag>
struct FluxVariables<TypeTag, TTag::NavierStokes> { using type = NavierStokesFluxVariables<TypeTag>; };

template<class TypeTag>
struct IOFields<TypeTag, TTag::NavierStokes> { using type = NavierStokesIOFields; };

// Property values for non-isothermal Navier-Stokes model

template<class TypeTag>
struct ModelTraits<TypeTag, TTag::NavierStokesNI>
{
private:
    using GridView = typename GetPropType<TypeTag, Properties::GridGeometry>::GridView;
    static constexpr auto dim = GridView::dimension;
    using IsothermalTraits = NavierStokesModelTraits<dim>;
public:
    using type = FreeflowNIModelTraits<IsothermalTraits>;
};

template<class TypeTag>
struct IOFields<TypeTag, TTag::NavierStokesNI> { using type = FreeflowNonIsothermalIOFields<NavierStokesIOFields>; };
 
 // \}
}
 
} // end namespace
 
#endif