mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-01-06 14:33:02 -06:00
281 lines
8.9 KiB
C++
281 lines
8.9 KiB
C++
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
// vi: set et ts=4 sw=4 sts=4:
|
|
/*
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM 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 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OPM 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 OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Consult the COPYING file in the top-level source directory of this
|
|
module for the precise wording of the license and the list of
|
|
copyright holders.
|
|
*/
|
|
/*!
|
|
* \file
|
|
*
|
|
* \brief Defines a type tags and some fundamental properties all models.
|
|
*/
|
|
#ifndef EWOMS_BASIC_PROPERTIES_HH
|
|
#define EWOMS_BASIC_PROPERTIES_HH
|
|
|
|
#include <dune/common/parametertree.hh>
|
|
|
|
#include <opm/models/utils/propertysystem.hh>
|
|
#include <opm/models/utils/parametersystem.hh>
|
|
|
|
#if HAVE_DUNE_FEM
|
|
#include <dune/fem/gridpart/adaptiveleafgridpart.hh>
|
|
#endif
|
|
|
|
#include <string>
|
|
|
|
namespace Opm::Properties {
|
|
|
|
///////////////////////////////////
|
|
// Type tag definitions:
|
|
//
|
|
// NumericModel
|
|
// |
|
|
// +-> ImplicitModel
|
|
///////////////////////////////////
|
|
|
|
// Create new type tags
|
|
namespace TTag {
|
|
//! Type tag for all models.
|
|
struct NumericModel { using InheritsFrom = std::tuple<ParameterSystem>; };
|
|
|
|
//! Type tag for all fully coupled models.
|
|
struct ImplicitModel { using InheritsFrom = std::tuple<NumericModel>; };
|
|
} // end namespace TTag
|
|
|
|
///////////////////////////////////
|
|
// Property names which are always available:
|
|
//
|
|
// Scalar
|
|
///////////////////////////////////
|
|
|
|
//! Property to specify the type of scalar values.
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct Scalar { using type = UndefinedProperty; };
|
|
|
|
//! Number of equations in the system of PDEs
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct NumEq { using type = UndefinedProperty; };
|
|
|
|
//! Property which provides a Dune::ParameterTree.
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct ParameterTree { using type = UndefinedProperty; };
|
|
|
|
//! The type of the model
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct Model { using type = UndefinedProperty; };
|
|
|
|
//! Property which defines the group that is queried for parameters by default
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct ModelParameterGroup { using type = UndefinedProperty; };
|
|
|
|
//! Property which provides a Vanguard (manages grids)
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct Vanguard { using type = UndefinedProperty; };
|
|
|
|
//! The type of the DUNE grid
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct Grid { using type = UndefinedProperty; };
|
|
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct GridView { using type = UndefinedProperty; };
|
|
|
|
#if HAVE_DUNE_FEM
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct GridPart { using type = UndefinedProperty; };
|
|
#endif
|
|
|
|
//! Property which tells the Vanguard how often the grid should be refined
|
|
//! after creation.
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct GridGlobalRefinements { using type = UndefinedProperty; };
|
|
|
|
//! Property provides the name of the file from which the additional runtime
|
|
//! parameters should to be loaded from
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct ParameterFile { using type = UndefinedProperty; };
|
|
|
|
/*!
|
|
* \brief Print all properties on startup?
|
|
*
|
|
* 0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The
|
|
* default is 2.
|
|
*/
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct PrintProperties { using type = UndefinedProperty; };
|
|
|
|
/*!
|
|
* \brief Print all parameters on startup?
|
|
*
|
|
* 0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The
|
|
* default is 2.
|
|
*/
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct PrintParameters { using type = UndefinedProperty; };
|
|
|
|
//! The default value for the simulation's end time
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct EndTime { using type = UndefinedProperty; };
|
|
|
|
//! The default value for the simulation's initial time step size
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct InitialTimeStepSize { using type = UndefinedProperty; };
|
|
|
|
//! The default value for the simulation's restart time
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct RestartTime { using type = UndefinedProperty; };
|
|
|
|
//! The name of the file with a number of forced time step lengths
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct PredeterminedTimeStepsFile { using type = UndefinedProperty; };
|
|
|
|
//! domain size
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct DomainSizeX { using type = UndefinedProperty; };
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct DomainSizeY { using type = UndefinedProperty; };
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct DomainSizeZ { using type = UndefinedProperty; };
|
|
|
|
//! grid resolution
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct CellsX { using type = UndefinedProperty; };
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct CellsY { using type = UndefinedProperty; };
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct CellsZ { using type = UndefinedProperty; };
|
|
|
|
//! name of the grid file
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct GridFile { using type = UndefinedProperty; };
|
|
|
|
//! level of the grid view
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct GridViewLevel { using type = UndefinedProperty; };
|
|
|
|
//! Manages the simulation time
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct Simulator { using type = UndefinedProperty; };
|
|
|
|
/*!
|
|
* \brief The class which marks the border indices associated with the
|
|
* degrees of freedom on a process boundary.
|
|
*
|
|
* This is required for the algebraic overlap stuff.
|
|
*/
|
|
template<class TypeTag, class MyTypeTag>
|
|
struct BorderListCreator { using type = UndefinedProperty; };
|
|
|
|
///////////////////////////////////
|
|
// Values for the properties
|
|
///////////////////////////////////
|
|
|
|
//! Set the default type of scalar values to double
|
|
template<class TypeTag>
|
|
struct Scalar<TypeTag, TTag::NumericModel> { using type = double; };
|
|
|
|
//! Set the ParameterTree property
|
|
template<class TypeTag>
|
|
struct ParameterTree<TypeTag, TTag::NumericModel>
|
|
{
|
|
using type = Dune::ParameterTree;
|
|
|
|
static Dune::ParameterTree& tree()
|
|
{
|
|
static Dune::ParameterTree obj_;
|
|
return obj_;
|
|
}
|
|
};
|
|
|
|
//! use the global group as default for the model's parameter group
|
|
template<class TypeTag>
|
|
struct ModelParameterGroup<TypeTag, TTag::NumericModel> { static constexpr auto value = ""; };
|
|
|
|
//! Set a value for the GridFile property
|
|
template<class TypeTag>
|
|
struct GridFile<TypeTag, TTag::NumericModel> { static constexpr auto value = ""; };
|
|
|
|
#if HAVE_DUNE_FEM
|
|
template<class TypeTag>
|
|
struct GridPart<TypeTag, TTag::NumericModel>
|
|
{
|
|
using Grid = GetPropType<TypeTag, Properties::Grid>;
|
|
using type = Dune::Fem::AdaptiveLeafGridPart<Grid>;
|
|
};
|
|
|
|
template<class TypeTag>
|
|
struct GridView<TypeTag, TTag::NumericModel> { using type = typename GetPropType<TypeTag, Properties::GridPart>::GridViewType; };
|
|
#else
|
|
//! Use the leaf grid view by default.
|
|
//!
|
|
//! Except for spatial refinement, there is rarly a reason to use
|
|
//! anything else...
|
|
template<class TypeTag>
|
|
struct GridView<TypeTag, TTag::NumericModel> { using type = typename GetPropType<TypeTag, Properties::Grid>::LeafGridView; };
|
|
#endif
|
|
|
|
//! Set a value for the ParameterFile property
|
|
template<class TypeTag>
|
|
struct ParameterFile<TypeTag, TTag::NumericModel> { static constexpr auto value = ""; };
|
|
|
|
//! Set the number of refinement levels of the grid to 0. This does not belong
|
|
//! here, strictly speaking.
|
|
template<class TypeTag>
|
|
struct GridGlobalRefinements<TypeTag, TTag::NumericModel> { static constexpr int value = 0; };
|
|
|
|
//! By default, print the properties on startup
|
|
template<class TypeTag>
|
|
struct PrintProperties<TypeTag, TTag::NumericModel> { static constexpr int value = 2; };
|
|
|
|
//! By default, print the values of the run-time parameters on startup
|
|
template<class TypeTag>
|
|
struct PrintParameters<TypeTag, TTag::NumericModel> { static constexpr int value = 2; };
|
|
|
|
//! The default value for the simulation's end time
|
|
template<class TypeTag>
|
|
struct EndTime<TypeTag, TTag::NumericModel>
|
|
{
|
|
using type = GetPropType<TypeTag, Scalar>;
|
|
static constexpr type value = -1e35;
|
|
};
|
|
|
|
//! The default value for the simulation's initial time step size
|
|
template<class TypeTag>
|
|
struct InitialTimeStepSize<TypeTag, TTag::NumericModel>
|
|
{
|
|
using type = GetPropType<TypeTag, Scalar>;
|
|
static constexpr type value = -1e35;
|
|
};
|
|
|
|
//! The default value for the simulation's restart time
|
|
template<class TypeTag>
|
|
struct RestartTime<TypeTag, TTag::NumericModel>
|
|
{
|
|
using type = GetPropType<TypeTag, Scalar>;
|
|
static constexpr type value = -1e35;
|
|
};
|
|
|
|
//! By default, do not force any time steps
|
|
template<class TypeTag>
|
|
struct PredeterminedTimeStepsFile<TypeTag, TTag::NumericModel> { static constexpr auto value = ""; };
|
|
|
|
|
|
} // namespace Opm::Properties
|
|
|
|
#endif
|