All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
IOField.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-2022 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::IOField
26 
27 Description
28  A primitive field of type <Type> with automated input and output.
29 
30 SourceFiles
31  IOField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef IOField_H
36 #define IOField_H
37 
38 #include "IOList.H"
39 #include "Field.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class IOField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class IOField
52 :
53  public IOListBase<Field, IOField, Type>
54 {
55 
56 public:
57 
58  //- Runtime type information
59  TypeName("Field");
60 
61 
62  // Constructors
63 
64  //- Inherit constructors
66 
67  //- Move construct by transferring the Container contents
68  IOField(const IOobject&, const tmp<Field<Type>>&);
69 
70 
71  // Member Operators
72 
73  //- Inherit assignment operators
75 };
76 
77 
78 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
79 
80 } // End namespace Foam
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 #ifdef NoRepository
85  #include "IOField.C"
86 #endif
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Pre-declare SubField and related Field type.
Definition: Field.H:83
A primitive field of type <Type> with automated input and output.
Definition: IOField.H:53
IOField(const IOobject &, const tmp< Field< Type >> &)
Move construct by transferring the Container contents.
Definition: IOField.C:32
TypeName("Field")
Runtime type information.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.