genericFieldBase.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) 2019-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 Class
25  Foam::genericFieldBase
26 
27 Description
28  Base class for generic field types. Facilitates down-casting so that the
29  actual type can be queried.
30 
31 SourceFiles
32  genericFieldBase.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef genericFieldBase_H
37 #define genericFieldBase_H
38 
39 #include "typeInfo.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class genericFieldBase Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class genericFieldBase
51 {
52  // Private Data
53 
54  //- Actual field type name
55  word actualTypeName_;
56 
57 
58 public:
59 
60  //- Runtime type information
61  TypeName("generic");
62 
63 
64  // Constructors
65 
66  //- Construct null
68 
69  //- Construct from actual type name
71 
72 
73  //- Destructor
74  virtual ~genericFieldBase();
75 
76 
77  // Member Functions
78 
79  //- Return the actual type name
80  inline const word& actualTypeName() const
81  {
82  return actualTypeName_;
83  }
84 };
85 
86 
87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
88 
89 } // End namespace Foam
90 
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 
93 #endif
94 
95 // ************************************************************************* //
Base class for generic field types. Facilitates down-casting so that the actual type can be queried.
TypeName("generic")
Runtime type information.
virtual ~genericFieldBase()
Destructor.
const word & actualTypeName() const
Return the actual type name.
genericFieldBase()
Construct null.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
Basic run-time type information using word as the type's name. Used to enhance the standard RTTI to c...