MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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.

Definition at line 50 of file O.h.

Member Function Documentation

const unsigned O::countVariables ( )
static

returns the number of variables (in this case three)

Definition at line 56 of file O.cc.

57 {
58  return 0;
59 }
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.

Definition at line 47 of file O.cc.

48 {
49  return 0.0;
50 }
static Mdouble CGCoordinates::O::getGaussPrefactor ( Mdouble  width,
Mdouble  cutoff 
)
inlinestatic

Definition at line 87 of file O.h.

88  { return 1.0; }
std::string O::getName ( )
static

Definition at line 61 of file O.cc.

62 {
63  return "O";
64 }
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

Definition at line 41 of file O.cc.

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

42 {
43  Vec3D dim = max - min;
44  return dim.X * dim.Y * dim.Z;
45 }
Mdouble X
the vector components
Definition: Vector.h:65
Mdouble Y
Definition: Vector.h:65
Definition: Vector.h:49
Mdouble Z
Definition: Vector.h:65
static bool CGCoordinates::O::isResolvedIn ( unsigned  dim)
inlinestatic

Definition at line 90 of file O.h.

90 {return false;}
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.

Definition at line 52 of file O.cc.

53 {
54 }
void O::write ( std::ostream &  os) const

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

Definition at line 36 of file O.cc.

37 {
38 }
void O::writeNames ( std::ostream &  os)
static

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

Definition at line 32 of file O.cc.

33 {
34 }

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