stormm::namelist::NiceControls Class Reference

Object to encapsulate job control and restraint information. Like other namelist encapsualtors, this object can take input file data as part of its construction, or by a series of setters. Validation of each piece of data is handled as it appears either in the contructor or via setters. Getter functions dispense the internal information to any application using STORMM libraries. More...

#include <nml_nice.h>

Public Member Functions
std::string	getWorkdayStart () const
	Get the workday start time as string recording hours:minutes:00 (workdays are rounded.
std::string	getWorkdayEnd () const
	Get the workday end time as a real value in seconds after midnight.
std::string	getWorkWeek () const
	Get a list of the working days of the week, codified into a string.
bool	isWorkTimeNow () const
	Get a verdict on whether the workday is happening now.
void	setGpuEffortLevel (double workday_effort_level_in)
	Set the GPU effort level to undertake during working hours.
void	setRunningCheckInterval (double running_check_interval_in)
	Set the interval at which to check for competing processes while the STORMM process is in operation.
void	setResumeCheckInterval (double resume_check_interval_in)
	Set the interval at which to check for competing processes after pausing the STORMM process..
void	setWorkTimeStart (const std::string &work_time_start_in)
	Set the start of the workday. The string will be interpreted first as an hour, or as an hour and a minute if there is a ':' character separating two numbers. Modifiers such as 'am' and 'pm' will also be detected and handled appropriately.
void	setWorkTimeEnd (const std::string &work_time_end_in)
	Set the end of the workday. The string will be interpreted as it is in the function setWorkTimeStart(), above.
	NiceControls (ExceptionResponse policy_in=ExceptionResponse::DIE)
	The constructor can prepare an object with default settings or read the corresponding namelist to accept user input.
	NiceControls (const TextFile &tf, int *start_line, bool *found_nml, ExceptionResponse policy_in=ExceptionResponse::DIE, WrapTextSearch wrap=WrapTextSearch::NO)
	NiceControls (const NiceControls &original)=default
	As with other control objects, copy and move constructors, plus copy and move assignment operators, can all take their default forms.
	NiceControls (NiceControls &&original)=default
NiceControls &	operator= (const NiceControls &original)=default
NiceControls &	operator= (NiceControls &&original)=default

Detailed Description

Object to encapsulate job control and restraint information. Like other namelist encapsualtors, this object can take input file data as part of its construction, or by a series of setters. Validation of each piece of data is handled as it appears either in the contructor or via setters. Getter functions dispense the internal information to any application using STORMM libraries.

Constructor & Destructor Documentation

NiceControls()

stormm::namelist::NiceControls::NiceControls

(

ExceptionResponse

policy_in = ExceptionResponse::DIE

)

The constructor can prepare an object with default settings or read the corresponding namelist to accept user input.

Parameters

tf	Input file translated into RAM
start_line	Line of the input file to begin searching for the &solvent namelist
found_nml	Indicator that the namelist was found in the input file
policy_in	Requested error handling behavior
wrap	Indicate that the search for a &dynamics namelist should carry on from the beginning of an input file if no such namelist is found starting from the original starting point

Member Function Documentation

setGpuEffortLevel()

void stormm::namelist::NiceControls::setGpuEffortLevel

(

double

workday_effort_level_in

)

Set the GPU effort level to undertake during working hours.

Parameters

workday_effort_level_in

The proportion of the GPU to utilize

setResumeCheckInterval()

void stormm::namelist::NiceControls::setResumeCheckInterval

(

double

resume_check_interval_in

)

Set the interval at which to check for competing processes after pausing the STORMM process..

Parameters

resume_check_interval_in

The chosen interval in wall clock seconds

setRunningCheckInterval()

void stormm::namelist::NiceControls::setRunningCheckInterval

(

double

running_check_interval_in

)

Set the interval at which to check for competing processes while the STORMM process is in operation.

Parameters

running_check_interval_in

The chosen interval in wall clock seconds

---

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

• src/Namelists/nml_nice.h
• src/Namelists/nml_nice.cpp