mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
de2ca522ff
Minimize changes compared to master. Avoid having the one and only file for property tag definitions.
243 lines
6.6 KiB
C++
243 lines
6.6 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>
|
|
|
|
// explicitly guard the include so that the property system
|
|
// header doesn't need to be opened and checked all the time
|
|
#ifndef OPM_PROPERTY_SYSTEM_HH
|
|
#include <opm/models/utils/propertysystem.hh>
|
|
|
|
// remove this after release 3.1 to disable macros per default
|
|
#ifndef OPM_ENABLE_OLD_PROPERTY_MACROS
|
|
#define OPM_ENABLE_OLD_PROPERTY_MACROS 1
|
|
#endif
|
|
|
|
// remove this after release 3.2 to remove macros completely
|
|
#if OPM_ENABLE_OLD_PROPERTY_MACROS
|
|
#include <opm/models/utils/propertysystemmacros.hh>
|
|
#endif // OPM_ENABLE_OLD_PROPERTY_MACROS
|
|
#endif // OPM_PROPERTY_SYSTEM_HH
|
|
|
|
#include <opm/models/utils/parametersystem.hh>
|
|
|
|
#if HAVE_DUNE_FEM
|
|
#include <dune/fem/gridpart/adaptiveleafgridpart.hh>
|
|
#endif
|
|
|
|
#include <string>
|
|
|
|
|
|
BEGIN_PROPERTIES
|
|
|
|
// type tag which is supposed to spliced in or inherited from if the
|
|
// parameter system is to be used
|
|
NEW_TYPE_TAG(ParameterSystem);
|
|
|
|
///////////////////////////////////
|
|
// Type tag definitions:
|
|
//
|
|
// NumericModel
|
|
// |
|
|
// +-> ImplicitModel
|
|
///////////////////////////////////
|
|
|
|
//! Type tag for all models.
|
|
NEW_TYPE_TAG(NumericModel, INHERITS_FROM(ParameterSystem));
|
|
|
|
//! Type tag for all fully coupled models.
|
|
NEW_TYPE_TAG(ImplicitModel, INHERITS_FROM(NumericModel));
|
|
|
|
///////////////////////////////////
|
|
// Property names which are always available:
|
|
//
|
|
// Scalar
|
|
///////////////////////////////////
|
|
|
|
//! Property to specify the type of scalar values.
|
|
NEW_PROP_TAG(Scalar);
|
|
|
|
//! Number of equations in the system of PDEs
|
|
NEW_PROP_TAG(NumEq);
|
|
|
|
//! Property which provides a Dune::ParameterTree.
|
|
NEW_PROP_TAG(ParameterTree);
|
|
|
|
//! The type of the model
|
|
NEW_PROP_TAG(Model);
|
|
|
|
//! Property which defines the group that is queried for parameters by default
|
|
NEW_PROP_TAG(ModelParameterGroup);
|
|
|
|
//! Property which provides a Vanguard (manages grids)
|
|
NEW_PROP_TAG(Vanguard);
|
|
|
|
//! The type of the DUNE grid
|
|
NEW_PROP_TAG(Grid);
|
|
|
|
NEW_PROP_TAG(GridView);
|
|
|
|
#if HAVE_DUNE_FEM
|
|
NEW_PROP_TAG(GridPart);
|
|
#endif
|
|
|
|
//! Property which tells the Vanguard how often the grid should be refined
|
|
//! after creation.
|
|
NEW_PROP_TAG(GridGlobalRefinements);
|
|
|
|
//! Property provides the name of the file from which the additional runtime
|
|
//! parameters should to be loaded from
|
|
NEW_PROP_TAG(ParameterFile);
|
|
|
|
/*!
|
|
* \brief Print all properties on startup?
|
|
*
|
|
* 0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The
|
|
* default is 2.
|
|
*/
|
|
NEW_PROP_TAG(PrintProperties);
|
|
|
|
/*!
|
|
* \brief Print all parameters on startup?
|
|
*
|
|
* 0 means 'no', 1 means 'yes', 2 means 'print only to logfiles'. The
|
|
* default is 2.
|
|
*/
|
|
NEW_PROP_TAG(PrintParameters);
|
|
|
|
//! The default value for the simulation's end time
|
|
NEW_PROP_TAG(EndTime);
|
|
|
|
//! The default value for the simulation's initial time step size
|
|
NEW_PROP_TAG(InitialTimeStepSize);
|
|
|
|
//! The default value for the simulation's restart time
|
|
NEW_PROP_TAG(RestartTime);
|
|
|
|
//! The name of the file with a number of forced time step lengths
|
|
NEW_PROP_TAG(PredeterminedTimeStepsFile);
|
|
|
|
//! domain size
|
|
NEW_PROP_TAG(DomainSizeX);
|
|
NEW_PROP_TAG(DomainSizeY);
|
|
NEW_PROP_TAG(DomainSizeZ);
|
|
|
|
//! grid resolution
|
|
NEW_PROP_TAG(CellsX);
|
|
NEW_PROP_TAG(CellsY);
|
|
NEW_PROP_TAG(CellsZ);
|
|
|
|
//! name of the grid file
|
|
NEW_PROP_TAG(GridFile);
|
|
|
|
//! level of the grid view
|
|
NEW_PROP_TAG(GridViewLevel);
|
|
|
|
//! Manages the simulation time
|
|
NEW_PROP_TAG(Simulator);
|
|
|
|
/*!
|
|
* \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.
|
|
*/
|
|
NEW_PROP_TAG(BorderListCreator);
|
|
|
|
///////////////////////////////////
|
|
// Values for the properties
|
|
///////////////////////////////////
|
|
|
|
//! Set the default type of scalar values to double
|
|
SET_TYPE_PROP(NumericModel, Scalar, double);
|
|
|
|
//! Set the ParameterTree property
|
|
SET_PROP(NumericModel, ParameterTree)
|
|
{
|
|
typedef Dune::ParameterTree type;
|
|
|
|
static Dune::ParameterTree& tree()
|
|
{
|
|
static Dune::ParameterTree obj_;
|
|
return obj_;
|
|
}
|
|
};
|
|
|
|
//! use the global group as default for the model's parameter group
|
|
SET_STRING_PROP(NumericModel, ModelParameterGroup, "");
|
|
|
|
//! Set a value for the GridFile property
|
|
SET_STRING_PROP(NumericModel, GridFile, "");
|
|
|
|
#if HAVE_DUNE_FEM
|
|
SET_PROP(NumericModel, GridPart)
|
|
{
|
|
typedef typename GET_PROP_TYPE(TypeTag, Grid) Grid;
|
|
typedef Dune::Fem::AdaptiveLeafGridPart<Grid> type;
|
|
};
|
|
|
|
SET_TYPE_PROP(NumericModel, GridView, typename GET_PROP_TYPE(TypeTag, GridPart)::GridViewType);
|
|
#else
|
|
//! Use the leaf grid view by default.
|
|
//!
|
|
//! Except for spatial refinement, there is rarly a reason to use
|
|
//! anything else...
|
|
SET_TYPE_PROP(NumericModel, GridView, typename GET_PROP_TYPE(TypeTag, Grid)::LeafGridView);
|
|
#endif
|
|
|
|
//! Set a value for the ParameterFile property
|
|
SET_STRING_PROP(NumericModel, ParameterFile, "");
|
|
|
|
//! Set the number of refinement levels of the grid to 0. This does not belong
|
|
//! here, strictly speaking.
|
|
SET_INT_PROP(NumericModel, GridGlobalRefinements, 0);
|
|
|
|
//! By default, print the properties on startup
|
|
SET_INT_PROP(NumericModel, PrintProperties, 2);
|
|
|
|
//! By default, print the values of the run-time parameters on startup
|
|
SET_INT_PROP(NumericModel, PrintParameters, 2);
|
|
|
|
//! The default value for the simulation's end time
|
|
SET_SCALAR_PROP(NumericModel, EndTime, -1e35);
|
|
|
|
//! The default value for the simulation's initial time step size
|
|
SET_SCALAR_PROP(NumericModel, InitialTimeStepSize, -1e35);
|
|
|
|
//! The default value for the simulation's restart time
|
|
SET_SCALAR_PROP(NumericModel, RestartTime, -1e35);
|
|
|
|
//! By default, do not force any time steps
|
|
SET_STRING_PROP(NumericModel, PredeterminedTimeStepsFile, "");
|
|
|
|
END_PROPERTIES
|
|
|
|
#endif
|