nullObjectI.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2014-2024 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 \*---------------------------------------------------------------------------*/
25 
26 template<class T>
27 inline const T& Foam::NullObjectRef()
28 {
29  return *reinterpret_cast<const T*>(nullObjectPtr);
30 }
31 
32 template<class T>
33 inline T& Foam::NullObjectNonConstRef()
34 {
35  return const_cast<T&>(*reinterpret_cast<const T*>(nullObjectPtr));
36 }
37 
38 template<class T>
39 inline const T* Foam::NullObjectConstPtr()
40 {
41  return reinterpret_cast<const T*>(nullObjectPtr);
42 }
43 
44 template<class T>
45 inline T* Foam::NullObjectPtr()
46 {
47  return const_cast<T*>(reinterpret_cast<const T*>(nullObjectPtr));
48 }
49 
50 template<class T>
51 inline T&& Foam::NullObjectMove()
52 {
53  return move(const_cast<T&>(*reinterpret_cast<const T*>(nullObjectPtr)));
54 }
55 
56 
57 template<class T>
58 inline bool Foam::isNull(const T& t)
59 {
60  return &t == NullObjectPtr<T>();
61 }
62 
63 template<class T>
64 inline bool Foam::notNull(const T& t)
65 {
66  return &t != NullObjectPtr<T>();
67 }
68 
69 
70 template<class T>
71 inline bool Foam::isNull(const T* t)
72 {
73  return t == NullObjectPtr<T>();
74 }
75 
76 template<class T>
77 inline bool Foam::notNull(const T* t)
78 {
79  return t != NullObjectPtr<T>();
80 }
81 
82 
83 template<class T>
84 inline bool Foam::isNull(T* t)
85 {
86  return t == NullObjectPtr<T>();
87 }
88 
89 template<class T>
90 inline bool Foam::notNull(T* t)
91 {
92  return t != NullObjectPtr<T>();
93 }
94 
95 
96 // ************************************************************************* //
Foam::NullObjectMove
T && NullObjectMove()
Return reference to the nullObject of type T.
Definition: nullObjectI.H:51
Foam::nullObjectPtr
const NullObject * nullObjectPtr
Pointer to the unique nullObject.
Definition: nullObject.C:31
Foam::notNull
bool notNull(const T &t)
Return true if t is not a reference to the nullObject of type T.
Definition: nullObjectI.H:64
Foam::NullObjectPtr
T * NullObjectPtr()
Return pointer to the nullObject of type T.
Definition: nullObjectI.H:45
Foam::NullObjectRef
const T & NullObjectRef()
Return const reference to the nullObject of type T.
Definition: nullObjectI.H:27
Foam::NullObjectNonConstRef
T & NullObjectNonConstRef()
Return non-const reference to the nullObject of type T.
Definition: nullObjectI.H:33
Foam::NullObjectConstPtr
const T * NullObjectConstPtr()
Return const pointer to the nullObject of type T.
Definition: nullObjectI.H:39
Foam::isNull
bool isNull(const T &t)
Return true if t is a reference to the nullObject of type T.
Definition: nullObjectI.H:58
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:55