Files
openfoam/src/OpenFOAM/db/scalarRange/scalarRanges.H

92 lines
2.7 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd.
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
for more details.
You should have received a copy of the GNU General Public License
along with OpenFOAM; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Class
Foam::scalarRanges
Description
A List of scalarRange.
SourceFiles
scalarRanges.C
\*---------------------------------------------------------------------------*/
#ifndef scalarRanges_H
#define scalarRanges_H
#include "scalarRange.H"
#include "List.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class scalarRanges Declaration
\*---------------------------------------------------------------------------*/
class scalarRanges
:
public List<scalarRange>
{
public:
// Constructors
//- Construct Null
scalarRanges();
//- Construct from Istream.
// The list items are comma-delimited.
scalarRanges(Istream&);
// Member Functions
//- Return true if the given value is within the ranges
bool selected(const scalar) const;
//- Return the set of selected entries in the given list
// that are within the ranges
List<bool> selected(const List<scalar>&) const;
//- Select a list of values that are within the ranges
List<scalar> select(const List<scalar>&) const;
//- Select a list of values that are within the ranges
void inplaceSelect(List<scalar>&) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //