PLMD::ves::FermiSwitchingFunction Class Reference

#include <FermiSwitchingFunction.h>

Public Member Functions
	FermiSwitchingFunction ()
	Constructor. More...
	FermiSwitchingFunction (const FermiSwitchingFunction &)
	Copy constructor. More...
	~FermiSwitchingFunction ()
	Destructor. More...
double	calculate (double x, double &df) const
std::string	description () const
double	get_r0 () const
void	set (const double, const double, const double fermi_rdist_max=-1.0)
void	set (const std::string &definition, std::string &errormsg)

Static Public Member Functions
static void	registerKeywords (Keywords &keys)

Private Types
enum	{ fermi }
	Type of function. More...

Private Member Functions
FermiSwitchingFunction &	operator= (const FermiSwitchingFunction &)

Private Attributes
double	fermi_exp_max_
double	fermi_lambda_
bool	init
	This is to check that switching function has been initialized. More...
double	invr0_
double	r0_
	Parameters for fermi function. More...
enum PLMD::ves::FermiSwitchingFunction:: { ... }	type
	Type of function. More...

Detailed Description

Small class to compute fermi switching function. kept similar to the original SwitchingFunction class.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Type of function.

Enumerator
fermi

Constructor & Destructor Documentation

FermiSwitchingFunction() [1/2]

PLMD::ves::FermiSwitchingFunction::FermiSwitchingFunction

(

)

Constructor.

~FermiSwitchingFunction()

PLMD::ves::FermiSwitchingFunction::~FermiSwitchingFunction

(

)

Destructor.

FermiSwitchingFunction() [2/2]

PLMD::ves::FermiSwitchingFunction::FermiSwitchingFunction

(

const FermiSwitchingFunction &

sf

)

Copy constructor.

Member Function Documentation

calculate()

double PLMD::ves::FermiSwitchingFunction::calculate	(	double	x,
		double &	df
	)		const

description()

std::string PLMD::ves::FermiSwitchingFunction::description

(

)

const

get_r0()

double PLMD::ves::FermiSwitchingFunction::get_r0

(

)

const

operator=()

FermiSwitchingFunction& PLMD::ves::FermiSwitchingFunction::operator= ( const FermiSwitchingFunction &  )

private

registerKeywords()

void PLMD::ves::FermiSwitchingFunction::registerKeywords ( Keywords &  keys )

static

set() [1/2]

void PLMD::ves::FermiSwitchingFunction::set	(	const double	r0,
		const double	fermi_lambda,
		const double	fermi_rdist_max = -1.0
	)

set() [2/2]

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

Member Data Documentation

fermi_exp_max_

double PLMD::ves::FermiSwitchingFunction::fermi_exp_max_

private

fermi_lambda_

double PLMD::ves::FermiSwitchingFunction::fermi_lambda_

private

init

bool PLMD::ves::FermiSwitchingFunction::init

private

This is to check that switching function has been initialized.

invr0_

double PLMD::ves::FermiSwitchingFunction::invr0_

private

r0_

double PLMD::ves::FermiSwitchingFunction::r0_

private

Parameters for fermi function.

type

enum { ... } PLMD::ves::FermiSwitchingFunction::type

Type of function.

---

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

• ves/FermiSwitchingFunction.h
• ves/FermiSwitchingFunction.cpp