VirtualFluids 0.2.0
Parallel CFD LBM Solver
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
UbScheduler Class Reference
basics » Utilities

A class implements scheduling. More...

#include <UbScheduler.h>

Classes

class  UbSchedule
 

Public Member Functions

 UbScheduler ()
 
 UbScheduler (const double &step, const double &begin=0, const double &end=ub_math::inf)
 
 UbScheduler (const UbSchedule &schedule)
 
virtual ~UbScheduler ()=default
 
void addSchedule (const UbSchedule &schedule)
 
bool addSchedule (const double &step, const double &begin, double end)
 
bool hasSchedules () const
 
double getLastDueTime () const
 
double getNextDueTime () const
 
double getMaxDueTime () const
 
bool isDue (const double &t)
 
double getMinBegin () const
 
double getMaxBegin () const
 
double getMinEnd () const
 
double getMaxEnd () const
 
double getMinStep () const
 
double getMaxStep () const
 
std::string toString () const
 

Protected Member Functions

void initVals ()
 
bool calcNextDueTimeForSchedule (const UbSchedule &schedule, const double &searchStart, double &nextDueTime)
 

Protected Attributes

double lastUsedT
 
double lastDueTime
 
double nextDueTime
 
double maxT
 
std::vector< UbSchedule > schedules
 

Friends

std::ostream & operator<< (std::ostream &os, const UbScheduler &scheduler)
 

Detailed Description

A class implements scheduling.

This class is not thread save.

Definition at line 57 of file UbScheduler.h.

Constructor & Destructor Documentation

◆ UbScheduler() [1/3]

UbScheduler::UbScheduler ( )
inline

Definition at line 94 of file UbScheduler.h.

◆ UbScheduler() [2/3]

UbScheduler::UbScheduler ( const double &  step,
const double &  begin = 0,
const double &  end = ub_math::inf 
)
inline

Definition at line 96 of file UbScheduler.h.

◆ UbScheduler() [3/3]

UbScheduler::UbScheduler ( const UbSchedule &  schedule)
inline

Definition at line 102 of file UbScheduler.h.

◆ ~UbScheduler()

virtual UbScheduler::~UbScheduler ( )
virtualdefault

Member Function Documentation

◆ addSchedule() [1/2]

bool UbScheduler::addSchedule ( const double &  step,
const double &  begin,
double  end 
)
inline

Definition at line 115 of file UbScheduler.h.

◆ addSchedule() [2/2]

void UbScheduler::addSchedule ( const UbSchedule &  schedule)
inline

Definition at line 110 of file UbScheduler.h.

◆ calcNextDueTimeForSchedule()

bool UbScheduler::calcNextDueTimeForSchedule ( const UbSchedule &  schedule,
const double &  searchStart,
double &  nextDueTime 
)
inlineprotected

Definition at line 302 of file UbScheduler.h.

◆ getLastDueTime()

double UbScheduler::getLastDueTime ( ) const
inline

Definition at line 161 of file UbScheduler.h.

◆ getMaxBegin()

double UbScheduler::getMaxBegin ( ) const
inline

Definition at line 232 of file UbScheduler.h.

◆ getMaxDueTime()

double UbScheduler::getMaxDueTime ( ) const
inline

Definition at line 167 of file UbScheduler.h.

◆ getMaxEnd()

double UbScheduler::getMaxEnd ( ) const
inline

Definition at line 248 of file UbScheduler.h.

◆ getMaxStep()

double UbScheduler::getMaxStep ( ) const
inline

Definition at line 264 of file UbScheduler.h.

◆ getMinBegin()

double UbScheduler::getMinBegin ( ) const
inline

Definition at line 224 of file UbScheduler.h.

◆ getMinEnd()

double UbScheduler::getMinEnd ( ) const
inline

Definition at line 240 of file UbScheduler.h.

◆ getMinStep()

double UbScheduler::getMinStep ( ) const
inline

Definition at line 256 of file UbScheduler.h.

◆ getNextDueTime()

double UbScheduler::getNextDueTime ( ) const
inline

Definition at line 164 of file UbScheduler.h.

◆ hasSchedules()

bool UbScheduler::hasSchedules ( ) const
inline

Definition at line 158 of file UbScheduler.h.

◆ initVals()

void UbScheduler::initVals ( )
inlineprotected

Definition at line 292 of file UbScheduler.h.

◆ isDue()

bool UbScheduler::isDue ( const double &  t)
inline

Definition at line 169 of file UbScheduler.h.

◆ toString()

std::string UbScheduler::toString ( ) const
inline

Definition at line 272 of file UbScheduler.h.

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  os,
const UbScheduler &  scheduler 
)
friend

Definition at line 279 of file UbScheduler.h.

Member Data Documentation

◆ lastDueTime

double UbScheduler::lastDueTime
protected

Definition at line 319 of file UbScheduler.h.

◆ lastUsedT

double UbScheduler::lastUsedT
protected

Definition at line 318 of file UbScheduler.h.

◆ maxT

double UbScheduler::maxT
protected

Definition at line 321 of file UbScheduler.h.

◆ nextDueTime

double UbScheduler::nextDueTime
protected

Definition at line 320 of file UbScheduler.h.

◆ schedules

std::vector<UbSchedule> UbScheduler::schedules
protected

Definition at line 323 of file UbScheduler.h.

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