A List of scalarRange for selecting times. More...

Public Member Functions
	timeSelector () noexcept=default
	Default construct. More...

	timeSelector (const std::string &str)
	Construct by parsing string for time ranges. More...

bool	contains (const scalar value) const
	True if value is within any of the ranges. More...

bool	contains (const instant &t) const
	True if value of the instant is within any of the ranges. More...

bool	selected (const instant &t) const
	True if value of the instant is within any of the ranges. More...

List< bool >	selected (const instantList &times) const
	Return the set of selected instants in the given list that are within the ranges. More...

instantList	select (const instantList &times) const
	Select a list of Time values that are within the ranges. More...

void	inplaceSelect (instantList &times) const
	Select a list of Time values that are within the ranges. More...

Static Public Member Functions
static void	addOptions (const bool constant=true, const bool withZero=false)
	Add timeSelector options to argList::validOptions. More...

static instantList	select (const instantList &times, const argList &args, const word &constantName="constant")
	Return the set of times selected based on the argList options. More...

static instantList	select0 (Time &runTime, const argList &args)
	Return the set of times selected based on the argList options and also set the runTime to the first instance or the `constant/` directory if no instances are specified or available. More...

static instantList	selectIfPresent (Time &runTime, const argList &args)
	If any time option provided return the set of times (as select0) otherwise return just the current time. More...

Detailed 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:

timeSelector::addOptions();
// add other options
#include "setRootCase.H"
#include "createTime.H"
instantList timeDirs = timeSelector::select0(runTime, args);
...
forAll(timeDirs, timei)
{
    ...
}

The result program would receive -time, -latestTime, -constant and -noZero options. The -constant option explicitly includes the constant/ directory in the time list and the -noZero option explicitly excludes the 0/ directory from the time list.

There may however also be many cases in which neither the constant/ directory nor the 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.

timeSelector::addOptions(false, true);

The first argument avoids adding the -constant option. The second argument adds an additional -withZero option and also prevents the 0/ directory from being included in the default time range and in the -latestTime selection.

Source files

Definition at line 88 of file timeSelector.H.

Constructor & Destructor Documentation

◆ timeSelector() [1/2]

timeSelector ( )

defaultnoexcept

Default construct.

◆ timeSelector() [2/2]

timeSelector ( const std::string & str )

explicit

Construct by parsing string for time ranges.

Definition at line 29 of file timeSelector.C.

Member Function Documentation

◆ contains() [1/2]

bool contains ( const scalar value ) const

True if value is within any of the ranges.

Definition at line 37 of file timeSelector.C.

Referenced by timeSelector::selected().

Here is the caller graph for this function:

◆ contains() [2/2]

bool contains ( const instant & t ) const

True if value of the instant is within any of the ranges.

Definition at line 43 of file timeSelector.C.

References Instant< T >::value().

Here is the call graph for this function:

◆ selected() [1/2]

bool selected ( const instant & t ) const

inline

True if value of the instant is within any of the ranges.

Definition at line 128 of file timeSelector.H.

References timeSelector::contains().

Referenced by timeSelector::select().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selected() [2/2]

Foam::List< bool > selected ( const instantList & times ) const

Return the set of selected instants in the given list that are within the ranges.

Definition at line 49 of file timeSelector.C.

References TimePaths::findClosestTimeIndex(), forAll, range, and UList< T >::size().

Here is the call graph for this function:

◆ select() [1/2]

Foam::instantList select ( const instantList & times ) const

Select a list of Time values that are within the ranges.

Definition at line 88 of file timeSelector.C.

References Foam::subset().

Referenced by timeSelector::select0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inplaceSelect()

void inplaceSelect ( instantList & times ) const

Select a list of Time values that are within the ranges.

Definition at line 94 of file timeSelector.C.

References Foam::inplaceSubset().

Here is the call graph for this function:

◆ addOptions()

void addOptions	(	const bool	constant = `true`,
		const bool	withZero = `false`
	)

static

Add timeSelector options to argList::validOptions.

Parameters

constant	Add the -constant option to include the `constant/` directory
withZero	Enable the -withZero option and alter the normal time selection behaviour (and -latestTime behaviour) to exclude the `0/` directory. The `0/` directory will only be included when -withZero is specified. The -noZero option has precedence over the -withZero option.

Definition at line 101 of file timeSelector.C.

References argList::addBoolOption(), and argList::addOption().

Referenced by if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ select() [2/2]

Foam::instantList select	(	const instantList &	times,
		const argList &	args,
		const word &	constantName = `"constant"`
	)

static

Return the set of times selected based on the argList options.

Definition at line 147 of file timeSelector.C.

References args, forAll, found, argList::found(), Foam::name(), timeSelector::selected(), UList< T >::size(), Foam::subset(), and argList::validOptions.

Here is the call graph for this function:

◆ select0()

Foam::instantList select0	(	Time &	runTime,
		const argList &	args
	)

static

Return the set of times selected based on the argList options and also set the runTime to the first instance or the constant/ directory if no instances are specified or available.

Definition at line 234 of file timeSelector.C.

References args, TimePaths::constant(), UList< T >::empty(), Foam::endl(), UList< T >::front(), List< T >::push_back(), runTime, timeSelector::select(), Time::setTime(), TimePaths::times(), and WarningInFunction.

Referenced by if().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectIfPresent()

Foam::instantList selectIfPresent	(	Time &	runTime,
		const argList &	args
	)

static

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

Definition at line 265 of file timeSelector.C.

References args, argList::found(), runTime, Time::timeName(), and dimensioned< Type >::value().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/OpenFOAM/db/Time/timeSelector.H
src/OpenFOAM/db/Time/timeSelector.C

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ timeSelector() [1/2]

◆ timeSelector() [2/2]

Member Function Documentation

◆ contains() [1/2]

◆ contains() [2/2]

◆ selected() [1/2]

◆ selected() [2/2]

◆ select() [1/2]

◆ inplaceSelect()

◆ addOptions()

◆ select() [2/2]

◆ select0()

◆ selectIfPresent()