src/OpenFOAM/db/scalarRange/scalarRanges.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::scalarRanges
  27
  28 Description
  29     A List of scalarRange.
  30
  31 SourceFiles
  32     scalarRanges.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef scalarRanges_H
  37 #define scalarRanges_H
  38
  39 #include "scalarRange.H"
  40 #include "List.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                        Class scalarRanges Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class scalarRanges
  52 :
  53     public List<scalarRange>
  54 {
  55 public:
  56
  57     // Constructors
  58
  59         //- Construct Null
  60         scalarRanges();
  61
  62         //- Construct from Istream.
  63         //  The list items are comma-delimited.
  64         scalarRanges(Istream&);
  65
  66     // Member Functions
  67
  68         //- Return true if the given value is within the ranges
  69         bool selected(const scalar&) const;
  70
  71         //- Return the set of selected entries in the given list
  72         //  that are within the ranges
  73         List<bool> selected(const List<scalar>&) const;
  74
  75         //- Select a list of values that are within the ranges
  76         List<scalar> select(const List<scalar>&) const;
  77
  78         //- Select a list of values that are within the ranges
  79         void inplaceSelect(List<scalar>&) const;
  80 };
  81
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 } // End namespace Foam
  86
  87 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  88
  89 #endif
  90
  91 // ************************************************************************* //