All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
32 #include <opm/common/Valgrind.hpp>
33 
34 namespace Ewoms {
35 namespace Properties {
36 NEW_PROP_TAG(PrimaryVariables);
37 }
38 
47 template <class TypeTag>
48 class FvBaseConstraints : public GET_PROP_TYPE(TypeTag, PrimaryVariables)
49 {
50  typedef typename GET_PROP_TYPE(TypeTag, PrimaryVariables) ParentType;
51 
52 public:
54  { setActive(false); }
55 
57 
60  using ParentType::operator=;
62 
66  bool isActive() const
67  { return isActive_; }
68 
72  void setActive(bool yesno)
73  { isActive_ = yesno; }
74 
75 private:
76  bool isActive_;
77 };
78 
79 } // namespace Ewoms
80 
81 #endif
bool isActive() const
Returns true if the constraints are enforced.
Definition: fvbaseconstraints.hh:66
#define GET_PROP_TYPE(TypeTag, PropTagName)
Access the type attribute of a property for a type tag.
Definition: propertysystem.hh:486
void setActive(bool yesno)
Specify whether the constraints should be enforced or not.
Definition: fvbaseconstraints.hh:72
Class to specify constraints for a finite volume spatial discretization.
Definition: fvbaseconstraints.hh:48
Provides the magic behind the eWoms property system.
#define NEW_PROP_TAG(PTagName)
Define a property tag.
Definition: propertysystem.hh:247