scalarRanges.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 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::scalarRanges
26 
27 Description
28  A List of scalarRange.
29 
30 SourceFiles
31  scalarRanges.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef scalarRanges_H
36 #define scalarRanges_H
37 
38 #include "scalarRange.H"
39 #include "List.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class scalarRanges Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class scalarRanges
51 :
52  public List<scalarRange>
53 {
54 public:
55 
56  // Constructors
57 
58  //- Construct Null
59  scalarRanges();
60 
61  //- Construct from Istream.
62  // The list items are comma-delimited.
64 
65  // Member Functions
66 
67  //- Return true if the given value is within the ranges
68  bool selected(const scalar) const;
69 
70  //- Return the set of selected entries in the given list
71  // that are within the ranges
72  List<bool> selected(const List<scalar>&) const;
73 
74  //- Select a list of values that are within the ranges
75  List<scalar> select(const List<scalar>&) const;
76 
77  //- Select a list of values that are within the ranges
78  void inplaceSelect(List<scalar>&) const;
79 };
80 
81 
82 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
83 
84 } // End namespace Foam
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 #endif
89 
90 // ************************************************************************* //
void inplaceSelect(List< scalar > &) const
Select a list of values that are within the ranges.
Definition: scalarRanges.C:130
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
Namespace for OpenFOAM.
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
scalarRanges()
Construct Null.
Definition: scalarRanges.C:32
List< scalar > select(const List< scalar > &) const
Select a list of values that are within the ranges.
Definition: scalarRanges.C:121
A List of scalarRange.
Definition: scalarRanges.H:49
bool selected(const scalar) const
Return true if the given value is within the ranges.
Definition: scalarRanges.C:59