RadialDistributionFunction Class Reference
[Radial Distribution Functions]

Radial distribution function. More...

#include <radialDistributionFunction.h>

List of all members.

Public Member Functions
Constructors and Destructor.
	RadialDistributionFunction () throw ()
	Default constructor.
	RadialDistributionFunction (const RadialDistributionFunction &rdf) throw ()
	Copy constructor.
	RadialDistributionFunction (const PiecewisePolynomial &polynomial) throw ()
	Detailed constructor.
virtual	~RadialDistributionFunction () throw ()
	Destructor.
Assignment.
const RadialDistributionFunction &	operator= (const RadialDistributionFunction &rdf) throw ()
	Assignment operator.
virtual void	clear () throw ()
	Clear function.
Accessors.
void	setRepresentation (const PiecewisePolynomial &polynomial) throw ()
	Set the representing PiecewisePolynomial.
const PiecewisePolynomial &	getRepresentation () const throw ()
	Get the representation of the RDF.
const Interval &	getRange () const throw ()
	Get the range of the representing function.
virtual double	operator() (double x) const throw ()
	Compute the value of the distribution function at a given x.
Predicates.
bool	isInRange (double x) const throw ()
	Check, whether a given x is in the range of the RDF.
bool	isValid () const throw ()
	Check validity.
bool	operator== (const RadialDistributionFunction &rdf) const throw ()
	Equality operator.
virtual void	dump (std::ostream &s=std::cout, Size depth=0) const throw ()
	Dumps the whole content of the object.
Protected Attributes
PiecewisePolynomial	representation_
bool	valid_

---

Detailed Description

Radial distribution function.

This class provides an interface for the use of radial distribution functions. These functions describe the deviation of the number density in a real fluid from the ideal (isotropic) case. The representation of such a function is a piecewise polynomial obtained by smoothing spline fit from molecular dynamics simulation.

---

Constructor & Destructor Documentation

RadialDistributionFunction::RadialDistributionFunction (   )  throw ()

Default constructor.

RadialDistributionFunction::RadialDistributionFunction (  const RadialDistributionFunction &  rdf  )  throw ()

Copy constructor.

RadialDistributionFunction::RadialDistributionFunction (  const PiecewisePolynomial &  polynomial  )  throw ()

Detailed constructor.

virtual RadialDistributionFunction::~RadialDistributionFunction (   )  throw () [virtual]

Destructor.

---

Member Function Documentation

virtual void RadialDistributionFunction::clear (   )  throw () [virtual]

Clear function.

virtual void RadialDistributionFunction::dump (  std::ostream &  s = std::cout, Size  depth = 0 )  const throw () [virtual]

Dumps the whole content of the object.

const Interval& RadialDistributionFunction::getRange (   )  const throw ()

Get the range of the representing function.

const PiecewisePolynomial& RadialDistributionFunction::getRepresentation (   )  const throw ()

Get the representation of the RDF.

bool RadialDistributionFunction::isInRange (  double  x  )  const throw ()

Check, whether a given x is in the range of the RDF.

bool RadialDistributionFunction::isValid (   )  const throw ()

Check validity.

virtual double RadialDistributionFunction::operator() (  double  x  )  const throw () [virtual]

Compute the value of the distribution function at a given x.

const RadialDistributionFunction& RadialDistributionFunction::operator= (  const RadialDistributionFunction &  rdf  )  throw ()

Assignment operator.

bool RadialDistributionFunction::operator== (  const RadialDistributionFunction &  rdf  )  const throw ()

Equality operator.

void RadialDistributionFunction::setRepresentation (  const PiecewisePolynomial &  polynomial  )  throw ()

Set the representing PiecewisePolynomial.