demandDrivenData.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) 2011-2023 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 Description
25  Template functions to aid in the implementation of demand driven data.
26 
27 \*---------------------------------------------------------------------------*/
28 
29 #ifndef demandDrivenData_H
30 #define demandDrivenData_H
31 
32 #include "nullObject.H"
33 
34 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
35 
36 namespace Foam
37 {
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 template<class DataType>
42 inline void deleteDemandDrivenData(DataType*& dataPtr)
43 {
44  if (dataPtr && notNull(dataPtr))
45  {
46  delete dataPtr;
47  }
48  dataPtr = 0;
49 }
50 
51 
52 template<class DataType>
53 inline void nullDemandDrivenData(DataType*& dataPtr)
54 {
55  if (dataPtr && notNull(dataPtr))
56  {
57  delete dataPtr;
58  }
59  dataPtr = NullObjectPtr<DataType>();
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 } // End namespace Foam
66 
67 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
68 
69 #endif
70 
71 // ************************************************************************* //
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.H:214
Foam::deleteDemandDrivenData
void deleteDemandDrivenData(DataType *&dataPtr)
Definition: demandDrivenData.H:42
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::nullDemandDrivenData
void nullDemandDrivenData(DataType *&dataPtr)
Definition: demandDrivenData.H:53