Public Types | Public Member Functions | List of all members
processorRunTimes Class Reference

Public Types

enum class  nProcsFrom { decomposeParDict , fileHandler }
 Enumeration for how the number of processors is determined. More...
 

Public Member Functions

 processorRunTimes (const word &name, const argList &args, const bool enableFunctionObjects=true, const nProcsFrom=nProcsFrom::decomposeParDict)
 Construct from name and arguments. More...
 
 processorRunTimes (const word &name, const fileName &rootPath, const fileName &caseName, const bool enableFunctionObjects=true, const nProcsFrom=nProcsFrom::decomposeParDict)
 Construct from name and directories. More...
 
 ~processorRunTimes ()
 Destructor. More...
 
const Time & completeTime () const
 Access the complete run time. More...
 
const PtrList< Time > & procTimes () const
 Access the processor run times. More...
 
label nProcs () const
 Return the number of processors. More...
 
const Time & proc0Time () const
 Access the processor0 run time. More...
 
void setTime (const instant &inst, const label newIndex)
 Set the time. More...
 
instantList selectComplete (const argList &args)
 Select the time. More...
 
instantList selectProc (const argList &args)
 Select the time. More...
 

Detailed Description

Source files

Definition at line 48 of file processorRunTimes.H.

Member Enumeration Documentation

◆ nProcsFrom

enum nProcsFrom
strong

Enumeration for how the number of processors is determined.

Enumerator
decomposeParDict 
fileHandler 

Definition at line 55 of file processorRunTimes.H.

Constructor & Destructor Documentation

◆ processorRunTimes() [1/2]

processorRunTimes ( const word &  name,
const argList &  args,
const bool  enableFunctionObjects = true,
const nProcsFrom  npf = nProcsFrom::decomposeParDict 
)

Construct from name and arguments.

Definition at line 103 of file processorRunTimes.C.

◆ processorRunTimes() [2/2]

processorRunTimes ( const word &  name,
const fileName &  rootPath,
const fileName &  caseName,
const bool  enableFunctionObjects = true,
const nProcsFrom  npf = nProcsFrom::decomposeParDict 
)

Construct from name and directories.

Definition at line 117 of file processorRunTimes.C.

◆ ~processorRunTimes()

~processorRunTimes ( )

Destructor.

Definition at line 134 of file processorRunTimes.C.

Member Function Documentation

◆ completeTime()

const Time& completeTime ( ) const
inline

Access the complete run time.

Definition at line 131 of file processorRunTimes.H.

◆ procTimes()

const PtrList<Time>& procTimes ( ) const
inline

Access the processor run times.

Definition at line 137 of file processorRunTimes.H.

◆ nProcs()

label nProcs ( ) const
inline

Return the number of processors.

Definition at line 143 of file processorRunTimes.H.

References UPtrList< T >::size().

Referenced by domainDecomposition::nProcs(), and multiDomainDecomposition::nProcs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ proc0Time()

const Time& proc0Time ( ) const
inline

Access the processor0 run time.

Definition at line 149 of file processorRunTimes.H.

References autoPtr< T >::valid().

Here is the call graph for this function:

◆ setTime()

void setTime ( const instant &  inst,
const label  newIndex 
)

Set the time.

Definition at line 140 of file processorRunTimes.C.

◆ selectComplete()

Foam::instantList selectComplete ( const argList &  args)

Select the time.

Definition at line 157 of file processorRunTimes.C.

References args, timeSelector::selectIfPresent(), and timeDirs.

Here is the call graph for this function:

◆ selectProc()

Foam::instantList selectProc ( const argList &  args)

Select the time.

Definition at line 173 of file processorRunTimes.C.

References args, timeSelector::select0(), and timeDirs.

Here is the call graph for this function:
The documentation for this class was generated from the following files: