CGCoordinates::O Class Reference

Defines the non-averaged directions on which spatial coarse-graining is applied (none for O); all other directions (all for O) are averaged
over homogeneously. More...

#include <O.h>

Inheritance diagram for CGCoordinates::O:

Public Member Functions
void	write (std::ostream &os) const
	Writes the coordinates in human-readable form to an ostream. More...
Mdouble	getDistanceSquared (const Vec3D &p) const
	Returns the square of the distance between the particle p and the current CGPoint, in the non-averaged directions. More...
Public Member Functions inherited from CGCoordinates::BaseCoordinates
virtual Mdouble	getWeight ()

Static Public Member Functions
static void	writeNames (std::ostream &os)
	Writes the coordinate names in human-readable form to an ostream. More...
static Mdouble	getVolumeOfAveragedDimensions (const Vec3D &min, const Vec3D &max)
	returns the factor the CGFunction has to be divided by, due to integrating the variables over the averaged dimensions, 1.0 for XYZ. More...
static void	normalisePolynomialCoefficients (std::vector< Mdouble > &coefficients, Mdouble cutoff)
	Normalises the coefficients of Polynomial CGFunction such that the integral over all non-averaged dimensions is unity. More...
static const unsigned	countVariables ()
static Mdouble	getGaussPrefactor (Mdouble width, Mdouble cutoff)
static bool	isResolvedIn (unsigned dim)
static std::string	getName ()
Static Public Member Functions inherited from CGCoordinates::BaseCoordinates
static Mdouble	getDomainVolume (const Vec3D &min, const Vec3D &max)

Detailed Description

Defines the non-averaged directions on which spatial coarse-graining is applied (none for O); all other directions (all for O) are averaged
over homogeneously.

See XYZ for details.

Member Function Documentation

countVariables()

const unsigned O::countVariables ( )

static

returns the number of variables (in this case three)

{
    return 0;
}

getDistanceSquared()

Mdouble O::getDistanceSquared

(

const Vec3D &

p

)

const

Returns the square of the distance between the particle p and the current CGPoint, in the non-averaged directions.

{
    return 0.0;
}

getGaussPrefactor()

static Mdouble CGCoordinates::O::getGaussPrefactor ( Mdouble  width, Mdouble  cutoff  )

inlinestatic

    { return 1.0; }

getName()

std::string O::getName ( )

static

{
    return "O";
}

getVolumeOfAveragedDimensions()

Mdouble O::getVolumeOfAveragedDimensions ( const Vec3D &  min, const Vec3D &  max  )

static

returns the factor the CGFunction has to be divided by, due to integrating the variables over the averaged dimensions, 1.0 for XYZ.

Todo:

Generalise to 2D

{
    Vec3D dim = max - min;
    return dim.X * dim.Y * dim.Z;
}

References Vec3D::X, Vec3D::Y, and Vec3D::Z.

isResolvedIn()

static bool CGCoordinates::O::isResolvedIn ( unsigned  dim )

inlinestatic

{return false;}

normalisePolynomialCoefficients()

void O::normalisePolynomialCoefficients ( std::vector< Mdouble > &  coefficients, Mdouble cutoff  UNUSED  )

static

Normalises the coefficients of Polynomial CGFunction such that the integral over all non-averaged dimensions is unity.

{
}

write()

void O::write

(

std::ostream &

os

)

const

Writes the coordinates in human-readable form to an ostream.

{
}

writeNames()

void O::writeNames ( std::ostream &  os )

static

Writes the coordinate names in human-readable form to an ostream.

{
}

---

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

• O.h
• O.cc