All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CompactIOField.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::CompactIOField
26 
27 Description
28  A Field of objects of type <Type> with automated input and output using
29  a compact storage. Behaves like IOField except when binary output in
30  case it writes a CompactListList.
31 
32  Useful for fields of small subfields e.g. in lagrangian
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef CompactIOField_H
37 #define CompactIOField_H
38 
39 #include "CompactIOList.H"
40 #include "IOField.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class CompactIOField Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Type>
52 class CompactIOField
53 :
54  public CompactIOListBase<Field, IOField, CompactIOField, Type>
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("FieldField");
60 
61 
62  // Constructors
63 
64  //- Inherit constructors
65  using
68 
69 
70  // Member Operators
71 
72  //- Inherit assignment operators
73  using
75  operator=;
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
A Field of objects of type <Type> with automated input and output using a compact storage....
TypeName("FieldField")
Runtime type information.
CompactIOListBase(const IOobject &)
Construct from IOobject.
Namespace for OpenFOAM.