gradingDescriptors.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::gradingDescriptors
26 
27 Description
28  List of gradingDescriptor for the sections of a block with additional IO
29  functionality
30 
31 SourceFiles
32  gradingDescriptors.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef gradingDescriptors_H
37 #define gradingDescriptors_H
38 
39 #include "gradingDescriptor.H"
40 #include "List.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 class Istream;
48 class Ostream;
49 
50 // Forward declaration of friend functions and operators
51 class gradingDescriptors;
52 Istream& operator>>(Istream&, gradingDescriptors&);
53 
54 /*---------------------------------------------------------------------------*\
55  Class gradingDescriptors Declaration
56 \*---------------------------------------------------------------------------*/
57 
59 :
60  public List<gradingDescriptor>
61 {
62 
63 public:
64 
65  // Constructors
66 
67  //- Default constructor
69 
70  //- Construct from a gradingDescriptor
72 
73 
74  // Member functions
75 
76  //- Return the inverse gradingDescriptors with 1/expansionRatio
77  gradingDescriptors inv() const;
78 
79 
80  // IOstream Operators
81 
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:60
gradingDescriptors inv() const
Return the inverse gradingDescriptors with 1/expansionRatio.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
gradingDescriptors()
Default constructor.
Istream & operator>>(Istream &, directionInfo &)
Handles the specification for grading within a section of a block.
friend Istream & operator>>(Istream &, gradingDescriptors &)
List of gradingDescriptor for the sections of a block with additional IO functionality.
Namespace for OpenFOAM.