GranOO  3.0
A robust and versatile workbench to build 3D dynamic simulations based on the Discrete Element Method
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
GranOO3::Math::Cycle Class Reference

#include <Cycle.hpp>

Inheritance diagram for GranOO3::Math::Cycle:
Inheritance graph
[legend]

Public Types

enum  Mode { UP = 1 , DOWN =-1 }
 

Public Member Functions

 Cycle (unsigned int varNumber, const std::string &symbol, const std::string desc="")
 
 Cycle (const double &x, double lim, double peak, double rate)
 
 ~Cycle ()
 
double operator() ()
 
double operator() (const double &x, const double &lim, const double &peak, const double &rate)
 
double operator() (const double &x, const double &lim, const double &peak, const double &rate, const double &monitor)
 
- Public Member Functions inherited from GranOO3::Math::FunctionT< Cycle >
 FunctionT (unsigned int varNumber)
 
 FunctionT (unsigned int varNumber, const std::string &symbol, const std::string desc="")
 
virtual ~FunctionT ()
 
void record (const std::string &)
 
- Public Member Functions inherited from GranOO3::Math::Function
 Function (unsigned int varNumber)
 
virtual ~Function ()
 
virtual double operator() (const double &)
 
virtual double operator() (const double &, const double &)
 
virtual double operator() (const double &, const double &, const double &)
 
virtual double operator() (const double &, const double &, const double &, const double &, const double &, const double &)
 
virtual double operator() (const double &, const double &, const double &, const double &, const double &, const double &, const double &)
 
virtual double operator() (const double &, const double &, const double &, const double &, const double &, const double &, const double &, const double &)
 
- Public Member Functions inherited from exprtk::ifunction< double >
 ifunction (const std::size_t &pc)
 
virtual ~ifunction ()
 
virtual double operator() () empty_method_body(0) inline virtual double operator()(const double &) empty_method_body(1) inline virtual double operator()(const double &
 
virtual double const double & empty_method_body (2) inline virtual double operator()(const double &
 
virtual double const double const double const double & empty_method_body (3) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double & empty_method_body (4) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double & empty_method_body (5) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (6) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (7) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (8) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (9) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (10) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (11) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (12) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (13) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (14) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (15) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (16) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (17) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (18) inline virtual double operator()(const double &
 
virtual double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double const double & empty_method_body (19) inline virtual double operator()(const double &
 
- Public Member Functions inherited from exprtk::function_traits
 function_traits ()
 
bool & allow_zero_parameters ()
 
bool & has_side_effects ()
 
std::size_t & min_num_args ()
 
std::size_t & max_num_args ()
 

Static Public Member Functions

static std::string class_ID ()
 

Private Member Functions

void swap_from_up2down (double x, double val)
 
void swap_from_down2up (double x, double val)
 
 Cycle (const Cycle &)=delete
 
Cycleoperator= (const Cycle &)=delete
 

Private Attributes

const double * _x
 
double _lim
 
double _peak
 
double _rate
 
double _slope
 
double _intercept
 
double _xshift
 
Mode _mode
 
unsigned int _ncycle
 

Additional Inherited Members

- Static Protected Attributes inherited from GranOO3::Math::Function
static boost::mt11213b _generator = boost::mt11213b((uint32_t)std::time(0))
 
static std::map< std::string, Function * > _recorded_function
 

Member Enumeration Documentation

◆ Mode

Enumerator
UP 
DOWN 

Constructor & Destructor Documentation

◆ Cycle() [1/3]

GranOO3::Math::Cycle::Cycle ( unsigned int  varNumber,
const std::string &  symbol,
const std::string  desc = "" 
)

◆ Cycle() [2/3]

GranOO3::Math::Cycle::Cycle ( const double &  x,
double  lim,
double  peak,
double  rate 
)

◆ ~Cycle()

GranOO3::Math::Cycle::~Cycle ( )

◆ Cycle() [3/3]

GranOO3::Math::Cycle::Cycle ( const Cycle )
privatedelete

Member Function Documentation

◆ class_ID()

static std::string GranOO3::Math::Cycle::class_ID ( )
inlinestatic

◆ operator()() [1/3]

double GranOO3::Math::Cycle::operator() ( )
virtual

◆ operator()() [2/3]

double GranOO3::Math::Cycle::operator() ( const double &  x,
const double &  lim,
const double &  peak,
const double &  rate 
)
virtual

Reimplemented from GranOO3::Math::Function.

◆ operator()() [3/3]

double GranOO3::Math::Cycle::operator() ( const double &  x,
const double &  lim,
const double &  peak,
const double &  rate,
const double &  monitor 
)
virtual

Reimplemented from GranOO3::Math::Function.

◆ operator=()

Cycle& GranOO3::Math::Cycle::operator= ( const Cycle )
privatedelete

◆ swap_from_down2up()

void GranOO3::Math::Cycle::swap_from_down2up ( double  x,
double  val 
)
private

◆ swap_from_up2down()

void GranOO3::Math::Cycle::swap_from_up2down ( double  x,
double  val 
)
private

Member Data Documentation

◆ _intercept

double GranOO3::Math::Cycle::_intercept
private

◆ _lim

double GranOO3::Math::Cycle::_lim
private

◆ _mode

Mode GranOO3::Math::Cycle::_mode
private

◆ _ncycle

unsigned int GranOO3::Math::Cycle::_ncycle
private

◆ _peak

double GranOO3::Math::Cycle::_peak
private

◆ _rate

double GranOO3::Math::Cycle::_rate
private

◆ _slope

double GranOO3::Math::Cycle::_slope
private

◆ _x

const double* GranOO3::Math::Cycle::_x
private

◆ _xshift

double GranOO3::Math::Cycle::_xshift
private

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