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-2019 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 <T> 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 "regIOobject.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 regIOobject,
54  public Field<Type>
55 {
56 
57 public:
58 
59  TypeName("Field");
60 
61 
62  // Constructors
63 
64  //- Construct from IOobject
65  IOField(const IOobject&);
66 
67  //- Construct from IOobject; does local processor require reading?
68  IOField(const IOobject&, const bool read);
69 
70  //- Construct from IOobject and size (does not set values)
71  IOField(const IOobject&, const label size);
72 
73  //- Construct from components
74  IOField(const IOobject&, const Field<Type>&);
75 
76  //- Move construct by transferring the Field contents
77  IOField(const IOobject&, Field<Type>&&);
78 
79  //- Move construct by transferring the Field contents
80  IOField(const IOobject&, const tmp<Field<Type>>&);
81 
82  //- Move constructor
84 
85 
86  //- Destructor
87  virtual ~IOField();
88 
89 
90  // Member Functions
91 
92  bool writeData(Ostream&) const;
93 
94 
95  // Member Operators
96 
97  void operator=(const IOField<Type>&);
98  void operator=(IOField<Type>&&);
99 
100  void operator=(const Field<Type>&);
101  void operator=(Field<Type>&&);
102  void operator=(const tmp<Field<Type>>&);
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #ifdef NoRepository
113  #include "IOField.C"
114 #endif
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************************************************************* //
IOField(const IOobject &)
Construct from IOobject.
Definition: IOField.C:31
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOField.C:206
virtual bool read()
Read object.
void operator=(const IOField< Type > &)
Definition: IOField.C:215
Pre-declare SubField and related Field type.
Definition: Field.H:56
TypeName("Field")
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:54
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:52
A class for managing temporary objects.
Definition: PtrList.H:53
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:98
virtual ~IOField()
Destructor.
Definition: IOField.C:200
label size() const
Return the number of elements in the UList.
Definition: ListI.H:171
A primitive field of type <T> with automated input and output.
Definition: IOField.H:50
Namespace for OpenFOAM.