MCPcopy Create free account
hub / github.com/OpenFOAM/OpenFOAM-dev / timeSelector

Class timeSelector

src/OpenFOAM/db/Time/timeSelector.H:90–174  ·  view source on GitHub ↗

Source from the content-addressed store, hash-verified

88\*---------------------------------------------------------------------------*/
89
90class timeSelector
91:
92 public scalarRanges
93{
94public:
95
96 // Constructors
97
98 //- Construct Null
99 timeSelector();
100
101 //- Construct from Istream
102 timeSelector(Istream&);
103
104
105 // Member Functions
106
107 //- Return true if the given instant is within the ranges
108 bool selected(const instant&) const;
109
110 //- Return the set of selected instants in the given list that are
111 // within the ranges
112 List<bool> selected(const instantList&) const;
113
114 //- Select a list of Time values that are within the ranges
115 instantList select(const instantList&) const;
116
117 //- Select a list of Time values that are within the ranges
118 void inplaceSelect(instantList&) const;
119
120 //- Add the options handled by timeSelector to argList::validOptions
121 //
122 // \param constant
123 // Add the \b -constant option to include the \c constant/ directory
124 //
125 // \param withZero
126 // Enable the \b -withZero option and alter the normal time selection
127 // behaviour (and \b -latestTime behaviour) to exclude the \c 0/
128 // directory. The \c 0/ directory will only be included when
129 // \b -withZero is specified.
130 // The \b -noZero option has precedence over the @b -withZero option.
131 static void addOptions
132 (
133 const bool constant=true,
134 const bool withZero=false
135 );
136
137 //- Return the set of times selected based on the argList options
138 static instantList select
139 (
140 const instantList&,
141 const argList& args,
142 const word& constantName = "constant"
143 );
144
145 //- Return the set of times selected based on the argList options
146 // also set the runTime to the first instance or the
147 // \c constant/ directory if no instances are specified or available

Callers 4

mainFunction · 0.85
mainFunction · 0.85
mainFunction · 0.85
timeSelector.CFile · 0.85

Calls

no outgoing calls

Tested by

no test coverage detected