opm-simulators
fvbaseconstraints.hh
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
28 #ifndef EWOMS_FV_BASE_CONSTRAINTS_HH
29 #define EWOMS_FV_BASE_CONSTRAINTS_HH
30 
31 #include <opm/material/common/Valgrind.hpp>
32 
35 
36 namespace Opm {
37 
46 template <class TypeTag>
47 class FvBaseConstraints : public GetPropType<TypeTag, Properties::PrimaryVariables>
48 {
50 
51 public:
52  FvBaseConstraints() = default;
53  FvBaseConstraints(const FvBaseConstraints&) = default;
54 
56 
59  FvBaseConstraints &operator=(const FvBaseConstraints&) = default;
61 
65  bool isActive() const
66  { return isActive_; }
67 
71  void setActive(bool yesno)
72  { isActive_ = yesno; }
73 
74 private:
75  bool isActive_{false};
76 };
77 
78 } // namespace Opm
79 
80 #endif
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(...))
Definition: propertysystem.hh:233
void setActive(bool yesno)
Specify whether the constraints should be enforced or not.
Definition: fvbaseconstraints.hh:71
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition: blackoilbioeffectsmodules.hh:45
Declare the properties used by the infrastructure code of the finite volume discretizations.
Class to specify constraints for a finite volume spatial discretization.
Definition: fvbaseconstraints.hh:47
bool isActive() const
Returns true if the constraints are enforced.
Definition: fvbaseconstraints.hh:65
The Opm property system, traits with inheritance.