My Project
Loading...
Searching...
No Matches
EnsureFinalized.hpp
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*/
27#ifndef OPM_MATERIAL_ENSURE_FINALIZED_HPP
28#define OPM_MATERIAL_ENSURE_FINALIZED_HPP
29
30#include <cassert>
31#include <stdexcept>
32
33#include <opm/common/utility/gpuDecorators.hpp>
34
35// TODO: move this variable to config.h
36#define OPM_CHECK_PARAM_FINALIZED 1
37
38#if ! defined(NDEBUG) && OPM_CHECK_PARAM_FINALIZED
39#define USE_OPM_CHECK_PARAM_FINALIZED 1
40#endif
41
42namespace Opm {
43
49{
50#if USE_OPM_CHECK_PARAM_FINALIZED
51 bool finalized_;
52#endif
53
54protected:
58 OPM_HOST_DEVICE EnsureFinalized()
59#if USE_OPM_CHECK_PARAM_FINALIZED
60 : finalized_( false )
61#endif
62 {
63 }
64
65 OPM_HOST_DEVICE void check() const
66 {
67#if USE_OPM_CHECK_PARAM_FINALIZED
68 if (!finalized_){
69#if OPM_IS_INSIDE_DEVICE_FUNCTION
70 assert(false && "Parameter class has not been finalized before usage!");
71#else
72 throw std::runtime_error("Parameter class has not been finalized before usage!");
73#endif
74 }
75#endif
76 }
77
78public:
82 OPM_HOST_DEVICE void finalize()
83 {
84#if USE_OPM_CHECK_PARAM_FINALIZED
85 finalized_ = true;
86#endif
87 }
88};
89
90#undef USE_OPM_CHECK_PARAM_FINALIZED
91
92} // namespace Opm
93#endif
Default implementation for asserting finalization of parameter objects.
Definition EnsureFinalized.hpp:49
OPM_HOST_DEVICE EnsureFinalized()
The default constructor.
Definition EnsureFinalized.hpp:58
OPM_HOST_DEVICE void finalize()
Mark the object as finalized.
Definition EnsureFinalized.hpp:82
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30