FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

scalarRanges.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::scalarRanges
00026 
00027 Description
00028     A List of scalarRange.
00029 
00030 SourceFiles
00031     scalarRanges.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef scalarRanges_H
00036 #define scalarRanges_H
00037 
00038 #include "scalarRange.H"
00039 #include <OpenFOAM/List.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 /*---------------------------------------------------------------------------*\
00047                        Class scalarRanges Declaration
00048 \*---------------------------------------------------------------------------*/
00049 
00050 class scalarRanges
00051 :
00052     public List<scalarRange>
00053 {
00054 public:
00055 
00056     // Constructors
00057 
00058         //- Construct Null
00059         scalarRanges();
00060 
00061         //- Construct from Istream.
00062         //  The list items are comma-delimited.
00063         scalarRanges(Istream&);
00064 
00065     // Member Functions
00066 
00067         //- Return true if the given value is within the ranges
00068         bool selected(const scalar&) const;
00069 
00070         //- Return the set of selected entries in the given list
00071         //  that are within the ranges
00072         List<bool> selected(const List<scalar>&) const;
00073 
00074         //- Select a list of values that are within the ranges
00075         List<scalar> select(const List<scalar>&) const;
00076 
00077         //- Select a list of values that are within the ranges
00078         void inplaceSelect(List<scalar>&) const;
00079 };
00080 
00081 
00082 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00083 
00084 } // End namespace Foam
00085 
00086 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00087 
00088 #endif
00089 
00090 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines