FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net. Fast, secure and Free Open Source software downloads
Public Member Functions | Static Public Attributes

JobInfo Class Reference

Helper class for recording information about run/finished jobs. More...

#include <OpenFOAM/JobInfo.H>

Detailed Description

Helper class for recording information about run/finished jobs.

Writes the following files:

  • FOAM_JOB_DIR/runningJobs
  • FOAM_JOB_DIR/finishedJobs where FOAM_JOB_DIR is the first of the following options that applies:
  • $FREEFOAM_JOB_DIR if the environment variable is defined
  • $FOAM_JOB_DIR if the environment variable is defined (for backward compatibility)
  • The value of the entry "foamJobDir" in the global controlDict if the entry is present
  • $HOME/.FreeFOAM/jobControl
Source files

Definition at line 60 of file JobInfo.H.

Inheritance diagram for JobInfo:
Collaboration diagram for JobInfo:

List of all members.

Public Member Functions

 JobInfo ()
 Construct null.
 ~JobInfo ()
void  write () const
void  end ()
void  exit ()
void  abort ()
void  signalEnd () const

Static Public Attributes

static bool  constructed
static bool  writeJobInfo

Constructor & Destructor Documentation

JobInfo (  )

Construct null.

Definition at line 41 of file JobInfo.C.

References JobInfo::constructed, Foam::debug::controlDict(), Foam::env(), JobInfo::exit(), Foam::FatalError, FatalErrorIn, dictionary::found(), Foam::getEnv(), Foam::home(), Foam::hostName(), Foam::isDir(), dictionary::lookup(), Pstream::master(), Foam::mkDir(), dictionaryName::name(), Foam::pid(), and JobInfo::writeJobInfo.

~JobInfo (  )

Definition at line 105 of file JobInfo.C.

References Pstream::master(), and Foam::mv().

Member Function Documentation

void write (  ) const

Definition at line 139 of file JobInfo.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, and Pstream::master().

void end (  )

Reimplemented from DLListBase.

Definition at line 175 of file JobInfo.C.

void exit (  )

Definition at line 181 of file JobInfo.C.

Referenced by IOerror::exit(), error::exit(), and JobInfo::JobInfo().

void abort (  )

Definition at line 187 of file JobInfo.C.

Referenced by IOerror::abort(), and error::abort().

void signalEnd (  ) const

Definition at line 193 of file JobInfo.C.

References Pstream::master(), and Foam::mv().

Member Data Documentation

bool constructed [static]

Definition at line 77 of file JobInfo.H.

Referenced by IOerror::abort(), error::abort(), IOerror::exit(), error::exit(), and JobInfo::JobInfo().

bool writeJobInfo [static]

Definition at line 78 of file JobInfo.H.

Referenced by JobInfo::JobInfo().

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