File size: 5,720 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 OpenFOAM Foundation
\\/ 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 3 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, see <http://www.gnu.org/licenses/>.
Class
Foam::timeSelector
Description
A List of scalarRange for selecting times.
The timeSelector provides a convenient means of selecting multiple
times. A typical use would be the following:
\verbatim
timeSelector::addOptions();
// add other options
#include "setRootCaseFunctionObjects.H"
#include "createTime.H"
const instantList timeDirs = timeSelector::select0(runTime, args);
...
forAll(timeDirs, timeI)
{
...
}
\endverbatim
The result program would receive \b -time, @b -latestTime, @b -constant
and \b -noZero options. The @b -constant option explicitly includes the
\c constant/ directory in the time list and the \b -noZero option
explicitly excludes the \c 0/ directory from the time list.
There may however also be many cases in which neither the \c constant/
directory nor the \c 0/ directory contain particularly relevant
information. This might occur, for example, when post-processing
results. In this case, addOptions is called with optional boolean
arguments.
\verbatim
timeSelector::addOptions(false, true);
\endverbatim
The first argument avoids adding the \b -constant option. The second
argument adds an additional \b -withZero option and also prevents the
\c 0/ directory from being included in the default time range and in the
\b -latestTime selection.
SourceFiles
timeSelector.C
\*---------------------------------------------------------------------------*/
#ifndef timeSelector_H
#define timeSelector_H
#include "scalarRanges.H"
#include "instantList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class argList;
class Time;
/*---------------------------------------------------------------------------*\
Class timeSelector Declaration
\*---------------------------------------------------------------------------*/
class timeSelector
:
public scalarRanges
{
public:
// Constructors
//- Construct Null
timeSelector();
//- Construct from Istream
timeSelector(Istream&);
// Member Functions
//- Return true if the given instant is within the ranges
bool selected(const instant&) const;
//- Return the set of selected instants in the given list that are
// within the ranges
List<bool> selected(const instantList&) const;
//- Select a list of Time values that are within the ranges
instantList select(const instantList&) const;
//- Select a list of Time values that are within the ranges
void inplaceSelect(instantList&) const;
//- Add the options handled by timeSelector to argList::validOptions
//
// \param constant
// Add the \b -constant option to include the \c constant/ directory
//
// \param withZero
// Enable the \b -withZero option and alter the normal time selection
// behaviour (and \b -latestTime behaviour) to exclude the \c 0/
// directory. The \c 0/ directory will only be included when
// \b -withZero is specified.
// The \b -noZero option has precedence over the @b -withZero option.
static void addOptions
(
const bool constant=true,
const bool withZero=false
);
//- Return the set of times selected based on the argList options
static instantList select
(
const instantList&,
const argList& args,
const word& constantName = "constant"
);
//- Return the set of times selected based on the argList options
// also set the runTime to the first instance or the
// \c constant/ directory if no instances are specified or available
static instantList select0
(
Time& runTime,
const argList& args
);
//- If any time option provided return the set of times (as select0)
// otherwise return just the current time.
// Also set the runTime to the first instance
static instantList selectIfPresent
(
Time& runTime,
const argList& args
);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|