GlobalIOField.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) 2015-2018 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::GlobalIOField
26 
27 Description
28  IOField with global data (so optionally read from master)
29 
30 SourceFiles
31  GlobalIOField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef GlobalIOField_H
36 #define GlobalIOField_H
37 
38 #include "regIOobject.H"
39 #include "Field.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class GlobalIOField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
51 class GlobalIOField
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  GlobalIOField(const IOobject&);
66 
67  //- Construct from IOobject and size (does not set values)
68  GlobalIOField(const IOobject&, const label size);
69 
70  //- Construct from components
71  GlobalIOField(const IOobject&, const Field<Type>&);
72 
73  //- Construct by transferring the Field contents
74  GlobalIOField(const IOobject&, const Xfer<Field<Type>>&);
75 
76 
77  //- Destructor
78  virtual ~GlobalIOField();
79 
80 
81  // Member functions
82 
83  //- Is object global
84  virtual bool global() const
85  {
86  return true;
87  }
88 
89  //- Return complete path + object name if the file exists
90  // either in the case/processor or case otherwise null
91  virtual fileName filePath() const
92  {
93  return globalFilePath(type());
94  }
95 
96  //- ReadData function required for regIOobject read operation
97  virtual bool readData(Istream&);
98 
99  //- WriteData function required for regIOobject write operation
100  bool writeData(Ostream&) const;
101 
102 
103  // Member operators
104 
105  void operator=(const GlobalIOField<Type>&);
106 
107  void operator=(const Field<Type>&);
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #ifdef NoRepository
118 # include "GlobalIOField.C"
119 #endif
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
A simple container for copying or transferring objects of type <T>.
Definition: Xfer.H:85
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
A class for handling file names.
Definition: fileName.H:69
virtual bool readData(Istream &)
ReadData function required for regIOobject read operation.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
void operator=(const GlobalIOField< Type > &)
bool writeData(Ostream &) const
WriteData function required for regIOobject write operation.
virtual ~GlobalIOField()
Destructor.
Definition: GlobalIOField.C:97
Pre-declare SubField and related Field type.
Definition: Field.H:57
fileName globalFilePath(const word &typeName) const
Helper for filePath that searches up if in parallel.
Definition: IOobject.C:428
IOField with global data (so optionally read from master)
Definition: GlobalIOField.H:50
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
GlobalIOField(const IOobject &)
Construct from IOobject.
Definition: GlobalIOField.C:31
fileName::Type type(const fileName &, const bool followLink=true)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:481
virtual fileName filePath() const
Return complete path + object name if the file exists.
Definition: GlobalIOField.H:90
virtual bool global() const
Is object global.
Definition: GlobalIOField.H:83
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
label size() const
Return the number of elements in the UList.
Definition: ListI.H:170
Namespace for OpenFOAM.