IOField.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2017 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 valid);
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  //- Construct by transferring the Field contents
77  IOField(const IOobject&, const Xfer<Field<Type>>&);
78 
79 
80  //- Destructor
81  virtual ~IOField();
82 
83 
84  // Member functions
85 
86  bool writeData(Ostream&) const;
87 
88 
89  // Member operators
90 
91  void operator=(const IOField<Type>&);
92 
93  void operator=(const Field<Type>&);
94 };
95 
96 
97 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98 
99 } // End namespace Foam
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 #ifdef NoRepository
104  #include "IOField.C"
105 #endif
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 #endif
110 
111 // ************************************************************************* //
IOField(const IOobject &)
Construct from IOobject.
Definition: IOField.C:31
A simple container for copying or transferring objects of type <T>.
Definition: Xfer.H:85
bool writeData(Ostream &) const
Pure virtual writaData function.
Definition: IOField.C:178
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
void operator=(const IOField< Type > &)
Definition: IOField.C:187
Pre-declare SubField and related Field type.
Definition: Field.H:57
TypeName("Field")
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:65
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
virtual ~IOField()
Destructor.
Definition: IOField.C:172
label size() const
Return the number of elements in the UList.
Definition: ListI.H:170
A primitive field of type <T> with automated input and output.
Definition: IOField.H:50
Namespace for OpenFOAM.