common/properties.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_PROPERTIES_HH
#define DUMUX_PROPERTIES_HH
 
// explicitly guard the include so that the property system
// header doesn't need to be opened and checked all the time
#ifndef DUMUX_PROPERTY_SYSTEM_HH
#include <dumux/common/properties/propertysystem.hh>
 
// remove this after release 3.1 to disable macros per default
#ifndef DUMUX_ENABLE_OLD_PROPERTY_MACROS
#define DUMUX_ENABLE_OLD_PROPERTY_MACROS 1
#endif
 
// remove this after release 3.2 to remove macros completely
#if DUMUX_ENABLE_OLD_PROPERTY_MACROS
#include <dumux/common/properties/propertysystemmacros.hh>
#endif // DUMUX_ENABLE_OLD_PROPERTY_MACROS
#endif // DUMUX_PROPERTY_SYSTEM_HH
 
namespace Dumux {
namespace Properties {
 
// Basic properties of numeric models:
template<class TypeTag, class MyTypeTag>
struct Scalar { using type = UndefinedProperty; };                 
template<class TypeTag, class MyTypeTag>
struct ModelDefaultParameters { using type = UndefinedProperty; }; 
template<class TypeTag, class MyTypeTag>
struct Grid { using type = UndefinedProperty; };                   
template<class TypeTag, class MyTypeTag>
struct PrimaryVariables { using type = UndefinedProperty; };       
template<class TypeTag, class MyTypeTag>
struct NumEqVector { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct GridView { using type = UndefinedProperty; };               
template<class TypeTag, class MyTypeTag>
struct ModelTraits { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct BaseModelTraits { using type = UndefinedProperty; };        
template<class TypeTag, class MyTypeTag>
struct Problem { using type = UndefinedProperty; };                
template<class TypeTag, class MyTypeTag>
struct PointSource { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct PointSourceHelper { using type = UndefinedProperty; };      
// TODO: Remove deprecated property VtkOutputFields
template<class TypeTag, class MyTypeTag>
struct VtkOutputFields { using type = UndefinedProperty; };        
template<class TypeTag, class MyTypeTag>
struct IOFields { using type = UndefinedProperty; };               
template<class TypeTag, class MyTypeTag>
struct BaseLocalResidual { using type = UndefinedProperty; };      
template<class TypeTag, class MyTypeTag>
struct JacobianMatrix { using type = UndefinedProperty; };         
template<class TypeTag, class MyTypeTag>
struct SolutionVector { using type = UndefinedProperty; };         
template<class TypeTag, class MyTypeTag>
struct BoundaryTypes { using type = UndefinedProperty; };          
 
template<class TypeTag, class MyTypeTag>
struct LocalResidual { using type = UndefinedProperty; };
 
template<class TypeTag, class MyTypeTag>
struct LinearSolver { using type = UndefinedProperty; };
 
// Basic properties regarding balance equations
// TODO: Integrate UseMoles into BalanceEqOpts
template<class TypeTag, class MyTypeTag>
struct UseMoles { using type = UndefinedProperty; };               
template<class TypeTag, class MyTypeTag>
struct ReplaceCompEqIdx { using type = UndefinedProperty; };       
template<class TypeTag, class MyTypeTag>
struct BalanceEqOpts { using type = UndefinedProperty; };          
 
// Properties used by finite volume schemes:
template<class TypeTag, class MyTypeTag>
struct ElementBoundaryTypes { using type = UndefinedProperty; };                
 
#if defined(__clang__) && !defined(DONT_EMIT_CLANG_GRIDGEOMETRY_WARNING)
#warning "The properties `FVGridGeometry` and `EnableFVGridGeometryCache` \
are deprecated in favor of `GridGeometry` and `EnableGridGeometryCache`. \
The old properties will be removed after release 3.1. \
If clang is used, no deprecation warnings are emitted. \
We recommend to use gcc for getting rid of the warnings. \
You can suppress this message by defining the preprocessor variable \
DONT_EMIT_CLANG_GRIDGEOMETRY_WARNING."
#endif
// TODO: Remove deprecated property FVGridGeometry after 3.1
template<class TypeTag, class MyTypeTag>
struct [[deprecated("Use GridGeometry instead.")]] FVGridGeometry { using type = UndefinedProperty; }; 
 
// TODO: Remove deprecated property EnableFVGridGeometryCache after 3.1
template<class TypeTag, class MyTypeTag>
struct [[deprecated("Use EnableGridGeometryCache instead.")]] EnableFVGridGeometryCache { using type = UndefinedProperty; };           
 
// Dumux 3.1 changes the property `FVGridGeometry` to `GridGeometry`.
// For ensuring backward compatibility, it is necessary to set the default value
// of the new property to the old one, see the discussion in MR 1647.
// Use diagnostic pragmas to prevent the emission of a warning message.
// TODO after 3.1: change default vale to `UndefinedProperty`, remove pragmas
// and comment.
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 
template<class TypeTag, class T>
struct GridGeometryHelper
{ using type = GetPropType<TypeTag, Properties::FVGridGeometry>; };
 
template<class TypeTag>
struct GridGeometryHelper<TypeTag, UndefinedProperty>
{ using type = UndefinedProperty; };
 
template<class TypeTag, class MyTypeTag>
struct GridGeometry
{
    using type = typename GridGeometryHelper<TypeTag, typename FVGridGeometry<TypeTag, MyTypeTag>::type>::type;
};
 
template<class TypeTag, bool hasParentTypeTag>
struct EnableGridGeometryCacheHelper
{ using type = UndefinedProperty; };
 
template<class TypeTag>
struct EnableGridGeometryCacheHelper<TypeTag, false>
{
    // fallback
    static constexpr bool value = getPropValue<TypeTag, Properties::EnableFVGridGeometryCache>();
};
 
// only use the fallback (EnableFVGridGeometryCache) if none
// of the TypeTags define EnableGridGeometryCache
template <class TypeTag, class MyTypeTag>
struct EnableGridGeometryCache : public EnableGridGeometryCacheHelper<TypeTag, Detail::hasParentTypeTag<MyTypeTag>(int{})>
{};
 
#pragma GCC diagnostic pop
 
template<class TypeTag, class MyTypeTag>
struct VolumeVariables { using type = UndefinedProperty; };                     
template<class TypeTag, class MyTypeTag>
struct GridVolumeVariables { using type = UndefinedProperty; };                 
template<class TypeTag, class MyTypeTag>
struct EnableGridVolumeVariablesCache { using type = UndefinedProperty; };      
template<class TypeTag, class MyTypeTag>
struct FluxVariables { using type = UndefinedProperty; };                       
template<class TypeTag, class MyTypeTag>
struct FluxVariablesCache { using type = UndefinedProperty; };                  
template<class TypeTag, class MyTypeTag>
struct FluxVariablesCacheFiller { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct GridFluxVariablesCache { using type = UndefinedProperty; };              
template<class TypeTag, class MyTypeTag>
struct EnableGridFluxVariablesCache { using type = UndefinedProperty; };        
template<class TypeTag, class MyTypeTag>
struct GridVariables { using type = UndefinedProperty; };                       
 
// Additional properties used by the cell-centered mpfa schemes:
template<class TypeTag, class MyTypeTag>
struct PrimaryInteractionVolume { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct SecondaryInteractionVolume { using type = UndefinedProperty; };          
template<class TypeTag, class MyTypeTag>
struct DualGridNodalIndexSet { using type = UndefinedProperty; };               
 
// Properties used by models involving flow in porous media:
template<class TypeTag, class MyTypeTag>
struct EnergyLocalResidual { using type = UndefinedProperty; };                 
template<class TypeTag, class MyTypeTag>
struct AdvectionType { using type = UndefinedProperty; };                       
template<class TypeTag, class MyTypeTag>
struct SolutionDependentAdvection { using type = UndefinedProperty; };          
template<class TypeTag, class MyTypeTag>
struct MolecularDiffusionType { using type = UndefinedProperty; };              
template<class TypeTag, class MyTypeTag>
struct SolutionDependentMolecularDiffusion { using type = UndefinedProperty; }; 
template<class TypeTag, class MyTypeTag>
struct HeatConductionType { using type = UndefinedProperty; };                  
template<class TypeTag, class MyTypeTag>
struct SolutionDependentHeatConduction { using type = UndefinedProperty; };     
 
template<class TypeTag, class MyTypeTag>
struct SpatialParams { using type = UndefinedProperty; };                       
template<class TypeTag, class MyTypeTag>
struct FluidSystem { using type = UndefinedProperty; };                         
template<class TypeTag, class MyTypeTag>
struct FluidState { using type = UndefinedProperty; };                          
template<class TypeTag, class MyTypeTag>
struct SolidSystem { using type = UndefinedProperty; };                         
template<class TypeTag, class MyTypeTag>
struct SolidState { using type = UndefinedProperty; };                           
template<class TypeTag, class MyTypeTag>
struct EffectiveDiffusivityModel { using type = UndefinedProperty; };           
template<class TypeTag, class MyTypeTag>
struct ThermalConductivityModel { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct VelocityOutput { using type = UndefinedProperty; };                      
template<class TypeTag, class MyTypeTag>
struct Formulation { using type = UndefinedProperty; };                         
// TODO: is this useful? -> everything is a constraint solver just a different type
template<class TypeTag, class MyTypeTag>
struct UseConstraintSolver { using type = UndefinedProperty; };                 
 
// When using the box method in a multi-phase context, an interface solver might be necessary
template<class TypeTag, class MyTypeTag>
struct EnableBoxInterfaceSolver { using type = UndefinedProperty; };
 
// Additional properties used by the 2pnc and 2pncmin models:
template<class TypeTag, class MyTypeTag>
struct Chemistry { using type = UndefinedProperty; };                           
template<class TypeTag, class MyTypeTag>
struct SetMoleFractionsForFirstPhase { using type = UndefinedProperty; };       
 
// Additional properties used by the richards model
template<class TypeTag, class MyTypeTag>
struct EnableWaterDiffusionInAir { using type = UndefinedProperty; }; 
 
// Additional properties used by the 3pwateroil model:
template<class TypeTag, class MyTypeTag>
struct OnlyGasPhaseCanDisappear { using type = UndefinedProperty; }; 
 
// Properties used by geomechanical models:
template<class TypeTag, class MyTypeTag>
struct StressType { using type = UndefinedProperty; };       
 
// Properties used by the staggered-grid discretization method
 
template<class TypeTag, class MyTypeTag>
struct NumEqCellCenter { using type = UndefinedProperty; };                     
template<class TypeTag, class MyTypeTag>
struct NumEqFace { using type = UndefinedProperty; };                           
template<class TypeTag, class MyTypeTag>
struct CellCenterSolutionVector { using type = UndefinedProperty; };            
template<class TypeTag, class MyTypeTag>
struct FaceSolutionVector { using type = UndefinedProperty; };                  
template<class TypeTag, class MyTypeTag>
struct GridFaceVariables { using type = UndefinedProperty; };                   
template<class TypeTag, class MyTypeTag>
struct CellCenterPrimaryVariables { using type = UndefinedProperty; };          
template<class TypeTag, class MyTypeTag>
struct FacePrimaryVariables { using type = UndefinedProperty; };                
template<class TypeTag, class MyTypeTag>
struct IntersectionMapper { using type = UndefinedProperty; };                  
template<class TypeTag, class MyTypeTag>
struct StaggeredPrimaryVariables { using type = UndefinedProperty; };           
template<class TypeTag, class MyTypeTag>
struct BaseEpsilon { using type = UndefinedProperty; };                         
template<class TypeTag, class MyTypeTag>
struct FaceVariables { using type = UndefinedProperty; };                       
template<class TypeTag, class MyTypeTag>
struct BoundaryValues { using type = UndefinedProperty; };                      
template<class TypeTag, class MyTypeTag>
struct StaggeredFaceSolution { using type = UndefinedProperty; };               
template<class TypeTag, class MyTypeTag>
struct EnableGridFaceVariablesCache { using type = UndefinedProperty; };        
template<class TypeTag, class MyTypeTag>
struct UpwindSchemeOrder { using type = UndefinedProperty; };                   
 
// Properties used by the mpnc model
 
template<class TypeTag, class MyTypeTag>
struct PressureFormulation { using type = UndefinedProperty; }; 
 
// Properties used by the nonequilibrium model
template<class TypeTag, class MyTypeTag>
struct EquilibriumModelTraits { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EquilibriumLocalResidual { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EquilibriumIndices { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EquilibriumIOFields { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct NumEqBalance { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EnableThermalNonEquilibrium { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct EnableChemicalNonEquilibrium { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct NumEnergyEqFluid { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct NumEnergyEqSolid { using type = UndefinedProperty; };
 
template<class TypeTag, class MyTypeTag>
struct NusseltFormulation { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct SherwoodFormulation { using type = UndefinedProperty; };
 
// Properties used by free flow models
 
template<class TypeTag, class MyTypeTag>
struct NormalizePressure { using type = UndefinedProperty; }; 
 
// Properties used by multidomain simulations
template<class TypeTag, class MyTypeTag>
struct CouplingManager { using type = UndefinedProperty; };
 
// Basic properties of sequential models:
template<class TypeTag, class MyTypeTag>
struct TimeManager { using type = UndefinedProperty; };
 
} // end namespace Properties
} // end namespace Dumux
 
#endif // DUMUX_PROPERTIES_HH