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:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
 
#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
// this include is guaranteed to be here for users of this header
#ifndef DUMUX_PROPERTY_SYSTEM_HH
#include <dumux/common/properties/propertysystem.hh>
#endif // DUMUX_PROPERTY_SYSTEM_HH
 
namespace Dumux::Properties {

// Basic properties of numeric models:
DUMUX_DEFINE_PROPERTY(Scalar)                 
DUMUX_DEFINE_PROPERTY(Grid)                   
DUMUX_DEFINE_PROPERTY(PrimaryVariables)       
DUMUX_DEFINE_PROPERTY(ModelTraits)            
DUMUX_DEFINE_PROPERTY(BaseModelTraits)        
DUMUX_DEFINE_PROPERTY(Problem)                
DUMUX_DEFINE_PROPERTY(PointSource)            
DUMUX_DEFINE_PROPERTY(PointSourceHelper)      
DUMUX_DEFINE_PROPERTY(IOFields)               
DUMUX_DEFINE_PROPERTY(BaseLocalResidual)      
DUMUX_DEFINE_PROPERTY(JacobianMatrix)         
DUMUX_DEFINE_PROPERTY(SolutionVector)         
 

DUMUX_DEFINE_PROPERTY(LocalResidual)
 

DUMUX_DEFINE_PROPERTY(Variables)
 

// Basic properties regarding balance equations
DUMUX_DEFINE_PROPERTY(UseMoles)                      
DUMUX_DEFINE_PROPERTY(ReplaceCompEqIdx)              
DUMUX_DEFINE_PROPERTY(BalanceEqOpts)                 
DUMUX_DEFINE_PROPERTY(EnableCompositionalDispersion) 
DUMUX_DEFINE_PROPERTY(EnableThermalDispersion)       
 

// Properties used by finite volume schemes:
DUMUX_DEFINE_PROPERTY(ElementBoundaryTypes)           
DUMUX_DEFINE_PROPERTY(GridGeometry)                   
DUMUX_DEFINE_PROPERTY(GridVariables)                  
DUMUX_DEFINE_PROPERTY(VolumeVariables)                
DUMUX_DEFINE_PROPERTY(GridVolumeVariables)            
DUMUX_DEFINE_PROPERTY(FluxVariables)                  
DUMUX_DEFINE_PROPERTY(FluxVariablesCache)             
DUMUX_DEFINE_PROPERTY(FluxVariablesCacheFiller)       
DUMUX_DEFINE_PROPERTY(GridFluxVariablesCache)         
 
DUMUX_DEFINE_PROPERTY(EnableGridGeometryCache)        
DUMUX_DEFINE_PROPERTY(EnableGridVolumeVariablesCache) 
DUMUX_DEFINE_PROPERTY(EnableGridFluxVariablesCache)   
 

// Additional properties used by the cell-centered mpfa schemes:
DUMUX_DEFINE_PROPERTY(PrimaryInteractionVolume)       
DUMUX_DEFINE_PROPERTY(SecondaryInteractionVolume)     
DUMUX_DEFINE_PROPERTY(DualGridNodalIndexSet)          
 

// Properties used by models involving flow in porous media:
DUMUX_DEFINE_PROPERTY(EnergyLocalResidual)                 
DUMUX_DEFINE_PROPERTY(AdvectionType)                       
DUMUX_DEFINE_PROPERTY(SolutionDependentAdvection)          
DUMUX_DEFINE_PROPERTY(MolecularDiffusionType)              
DUMUX_DEFINE_PROPERTY(DispersionFluxType)                  
DUMUX_DEFINE_PROPERTY(SolutionDependentMolecularDiffusion) 
DUMUX_DEFINE_PROPERTY(HeatConductionType)                  
DUMUX_DEFINE_PROPERTY(CompositionalDispersionModel)        
DUMUX_DEFINE_PROPERTY(ThermalDispersionModel)              
DUMUX_DEFINE_PROPERTY(SolutionDependentHeatConduction)     
 
DUMUX_DEFINE_PROPERTY(SpatialParams)                       
DUMUX_DEFINE_PROPERTY(FluidSystem)                         
DUMUX_DEFINE_PROPERTY(FluidState)                          
DUMUX_DEFINE_PROPERTY(SolidSystem)                         
DUMUX_DEFINE_PROPERTY(SolidState)                          
DUMUX_DEFINE_PROPERTY(EffectiveDiffusivityModel)           
DUMUX_DEFINE_PROPERTY(ThermalConductivityModel)            
DUMUX_DEFINE_PROPERTY(VelocityOutput)                      
DUMUX_DEFINE_PROPERTY(Formulation)                         
// TODO: is this useful? -> everything is a constraint solver just a different type
DUMUX_DEFINE_PROPERTY(UseConstraintSolver)                 
 
// When using the box method in a multi-phase context, an interface solver might be necessary
DUMUX_DEFINE_PROPERTY(EnableBoxInterfaceSolver)
 

// Additional properties used by the 2pnc and 2pncmin models:
DUMUX_DEFINE_PROPERTY(Chemistry)                      
DUMUX_DEFINE_PROPERTY(SetMoleFractionsForFirstPhase)  
// Additional properties used by the 3pwateroil model:
DUMUX_DEFINE_PROPERTY(OnlyGasPhaseCanDisappear)       
 

// Properties used by geomechanical models:
DUMUX_DEFINE_PROPERTY(StressType)                     
 

// Properties used by the staggered-grid discretization method
DUMUX_DEFINE_PROPERTY(NumEqCellCenter)                  
DUMUX_DEFINE_PROPERTY(NumEqFace)                        
DUMUX_DEFINE_PROPERTY(CellCenterSolutionVector)         
DUMUX_DEFINE_PROPERTY(FaceSolutionVector)               
DUMUX_DEFINE_PROPERTY(GridFaceVariables)                
DUMUX_DEFINE_PROPERTY(CellCenterPrimaryVariables)       
DUMUX_DEFINE_PROPERTY(FacePrimaryVariables)             
DUMUX_DEFINE_PROPERTY(IntersectionMapper)               
DUMUX_DEFINE_PROPERTY(StaggeredPrimaryVariables)        
DUMUX_DEFINE_PROPERTY(BaseEpsilon)                      
DUMUX_DEFINE_PROPERTY(FaceVariables)                    
DUMUX_DEFINE_PROPERTY(BoundaryValues)                   
DUMUX_DEFINE_PROPERTY(StaggeredFaceSolution)            
DUMUX_DEFINE_PROPERTY(EnableGridFaceVariablesCache)     
DUMUX_DEFINE_PROPERTY(UpwindSchemeOrder)                
 

// Properties used by the mpnc model
DUMUX_DEFINE_PROPERTY(PressureFormulation)              
 

// Properties used by the nonequilibrium model
DUMUX_DEFINE_PROPERTY(EquilibriumModelTraits)
DUMUX_DEFINE_PROPERTY(EquilibriumLocalResidual)
DUMUX_DEFINE_PROPERTY(EquilibriumIndices)
DUMUX_DEFINE_PROPERTY(EquilibriumIOFields)
DUMUX_DEFINE_PROPERTY(NumEqBalance)
DUMUX_DEFINE_PROPERTY(EnableThermalNonEquilibrium)
DUMUX_DEFINE_PROPERTY(EnableChemicalNonEquilibrium)
DUMUX_DEFINE_PROPERTY(NumEnergyEqFluid)
DUMUX_DEFINE_PROPERTY(NumEnergyEqSolid)
 
DUMUX_DEFINE_PROPERTY(NusseltFormulation)
DUMUX_DEFINE_PROPERTY(SherwoodFormulation)
 

// Properties used by free flow models
 
DUMUX_DEFINE_PROPERTY(NormalizePressure) 
DUMUX_DEFINE_PROPERTY(ViscousFluxType)   
 

// Properties used by multidomain simulations
DUMUX_DEFINE_PROPERTY(CouplingManager)
 

// Basic properties of by old/deprecated sequential models:
// Do not use this unless you are dealing with such old code
DUMUX_DEFINE_PROPERTY(TimeManager)
 
} // end namespace Dumux::Properties
 
namespace Dumux::Properties::Transition {

template<class TypeTag, class MyTypeTag>
struct UseVariables { using type = UndefinedProperty; };
 
} // end namespace Dumux::Properties::Transition
 
namespace Dumux::Properties {
 
#ifndef DOXYGEN
template<class ...Args>
struct PropertyAlias<Transition::UseVariables<Args...>>
{
    template <class MyTypeTag> using Alias = typename MyTypeTag::UseVariables;
    template <class MyTypeTag, class TypeTag> using TemplateAlias = typename MyTypeTag::template UseVariables<TypeTag>;
};
#endif // DOXYGEN
 
} // end namespace Dumux::Properties
 
#endif