sigWriteNow Class Reference

Signal handler to write when the writeNowSignal is sent. More...

Public Member Functions

 sigWriteNow ()
 Construct null. More...
 
 sigWriteNow (const bool verbose, Time &runTime)
 Construct from components. More...
 
 ~sigWriteNow ()
 Destructor. More...
 
bool active () const
 Is active? More...
 

Static Public Member Functions

static void set (const bool verbose)
 (re)set signal catcher More...
 

Friends

class sigStopAtWriteNow
 
class addwriteNowSignalToOpt
 wip. Have setter have access to signal_ More...
 

Detailed Description

Signal handler to write when the writeNowSignal is sent.

writeNowSignal is set in etc/controlDict::OptimisationSwitches, e.g.

OptimisationSwitches
{
    .
    .
    // Force dumping (at next timestep) upon signal (-1 to disable)
    writeNowSignal              10; // SIGUSR1
    .
    .
}
Source files

Definition at line 63 of file sigWriteNow.H.

Constructor & Destructor Documentation

◆ sigWriteNow() [1/2]

Construct null.

Definition at line 65 of file sigWriteNow.C.

◆ sigWriteNow() [2/2]

sigWriteNow ( const bool  verbose,
Time runTime 
)

Construct from components.

Definition at line 69 of file sigWriteNow.C.

◆ ~sigWriteNow()

Destructor.

Definition at line 80 of file sigWriteNow.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Function Documentation

◆ set()

void set ( const bool  verbose)
static

(re)set signal catcher

Definition at line 97 of file sigWriteNow.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::Info.

Here is the call graph for this function:

◆ active()

bool active ( ) const

Is active?

Definition at line 122 of file sigWriteNow.C.

Friends And Related Function Documentation

◆ sigStopAtWriteNow

friend class sigStopAtWriteNow
friend

Definition at line 84 of file sigWriteNow.H.

◆ addwriteNowSignalToOpt

friend class addwriteNowSignalToOpt
friend

wip. Have setter have access to signal_

Definition at line 87 of file sigWriteNow.H.


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