All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
PLMD::SwitchingFunction Class Reference

Small class to compure switching functions in the form In the future we might extend it so as to be set using a string: void set(std::string); which can then be parsed for more complex stuff, e.g. More...

#include <SwitchingFunction.h>

Public Member Functions

 SwitchingFunction ()
 
void set (int nn, int mm, double r_0, double d_0)
 
void set (const std::string &definition, std::string &errormsg)
 
std::string description () const
 
double calculate (double x, double &df) const
 
double get_d0 () const
 
double get_r0 () const
 

Static Public Member Functions

static void registerKeywords (Keywords &keys)
 

Private Types

enum  { spline, exponential, gaussian, smap }
 

Private Attributes

bool init
 
enum PLMD::SwitchingFunction:: { ... }  type
 
int nn
 
int mm
 
int a
 
int b
 
double invr0
 
double d0
 
double dmax
 
double c
 
double d
 

Detailed Description

Small class to compure switching functions in the form In the future we might extend it so as to be set using a string: void set(std::string); which can then be parsed for more complex stuff, e.g.

exponentials tabulated functions from file, matheval, etc...

Definition at line 39 of file SwitchingFunction.h.

Constructor & Destructor Documentation

PLMD::SwitchingFunction::SwitchingFunction ( )

Definition at line 217 of file SwitchingFunction.cpp.

Member Function Documentation

double PLMD::SwitchingFunction::calculate ( double  x,
double &  df 
) const

Definition at line 164 of file SwitchingFunction.cpp.

std::string PLMD::SwitchingFunction::description ( ) const

Definition at line 141 of file SwitchingFunction.cpp.

double PLMD::SwitchingFunction::get_d0 ( ) const

Definition at line 242 of file SwitchingFunction.cpp.

double PLMD::SwitchingFunction::get_r0 ( ) const

Definition at line 238 of file SwitchingFunction.cpp.

void PLMD::SwitchingFunction::registerKeywords ( Keywords keys)
static

Definition at line 93 of file SwitchingFunction.cpp.

void PLMD::SwitchingFunction::set ( int  nn,
int  mm,
double  r_0,
double  d_0 
)

Definition at line 228 of file SwitchingFunction.cpp.

void PLMD::SwitchingFunction::set ( const std::string &  definition,
std::string &  errormsg 
)

Definition at line 103 of file SwitchingFunction.cpp.

Member Data Documentation

int PLMD::SwitchingFunction::a
private

Definition at line 42 of file SwitchingFunction.h.

int PLMD::SwitchingFunction::b
private

Definition at line 42 of file SwitchingFunction.h.

double PLMD::SwitchingFunction::c
private

Definition at line 43 of file SwitchingFunction.h.

double PLMD::SwitchingFunction::d
private

Definition at line 43 of file SwitchingFunction.h.

double PLMD::SwitchingFunction::d0
private

Definition at line 43 of file SwitchingFunction.h.

double PLMD::SwitchingFunction::dmax
private

Definition at line 43 of file SwitchingFunction.h.

bool PLMD::SwitchingFunction::init
private

Definition at line 40 of file SwitchingFunction.h.

double PLMD::SwitchingFunction::invr0
private

Definition at line 43 of file SwitchingFunction.h.

int PLMD::SwitchingFunction::mm
private

Definition at line 42 of file SwitchingFunction.h.

int PLMD::SwitchingFunction::nn
private

Definition at line 42 of file SwitchingFunction.h.

enum { ... } PLMD::SwitchingFunction::type

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