MercuryDPM  Trunk
CGCoordinates::X Class Reference

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

#include <X.h>

Inheritance diagram for CGCoordinates::X:

## 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...

void setX (Mdouble x)
Returns the position of the current CGPoint, in the non-averaged directions. More...

Mdouble getX () const

Mdouble getINormal (const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards I. More...

Mdouble getPNormal (const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards P. More...

Mdouble getCNormal (const BaseInteraction &c, const Vec3D &normal) const
For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards the contact point. 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 Mdouble getLength (const Vec3D &p)
Returns the length of the input vector in the non-averaged directions. More...

static bool isResolvedIn (unsigned i)

static std::string getName ()

Static Public Member Functions inherited from CGCoordinates::Base_X_Y_Z
static Mdouble getGaussPrefactor (Mdouble width, Mdouble cutoff)
Computes the prefactor of the Gauss CGFunction, which is dependent on the number of non-averaged dimensions. More...

static Mdouble getGaussIntegralPrefactor (Mdouble distance, Mdouble width, Mdouble cutoff)
Computes the prefactor of the Gauss line integral, which is dependent on the number of non-averaged dimensions. 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 Public Member Functions inherited from CGCoordinates::BaseCoordinates
static Mdouble getDomainVolume (const Vec3D &min, const Vec3D &max)

Mdouble x_

## Detailed Description

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

See XYZ for details.

Definition at line 50 of file X.h.

## Member Function Documentation

 Mdouble X::getCNormal ( const BaseInteraction & c, const Vec3D & normal ) const

For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards the contact point.

Definition at line 85 of file X.cc.

References BaseInteraction::getContactPoint(), Vec3D::X, and x_.

86 {
87  return (c.getContactPoint().X - x_) * normal.X;
88 }
Mdouble X
the vector components
Definition: Vector.h:65
const Vec3D & getContactPoint() const
Gets constant reference to contact point (vector).
Mdouble x_
Definition: X.h:119
 Mdouble X::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 60 of file X.cc.

References mathsFunc::square(), Vec3D::X, and x_.

61 {
62  return mathsFunc::square(p.X - x_);
63 }
Mdouble X
the vector components
Definition: Vector.h:65
T square(const T val)
squares a number
Definition: ExtendedMath.h:104
Mdouble x_
Definition: X.h:119
 Mdouble X::getINormal ( const BaseInteraction & c, const Vec3D & normal ) const

For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards I.

Todo:
change from normal.X to sign(normal.X)

Definition at line 75 of file X.cc.

References BaseInteraction::getI(), BaseInteractable::getPosition(), Vec3D::X, and x_.

76 {
77  return (c.getI()->getPosition().X - x_) * normal.X;
78 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
BaseInteractable * getI()
Returns a pointer to the second object involved in the interaction (often a wall or a particle)...
Mdouble x_
Definition: X.h:119
 Mdouble X::getLength ( const Vec3D & p )
static

Returns the length of the input vector in the non-averaged directions.

Parameters
 [in] p vector whose length should be determined
Returns
length of the vector in the non-averaged directions

Definition at line 69 of file X.cc.

References Vec3D::X.

70 {
71  return fabs(p.X);
72 }
Mdouble X
the vector components
Definition: Vector.h:65
 std::string X::getName ( )
static

Definition at line 90 of file X.cc.

91 {
92  return "X";
93 }
 Mdouble X::getPNormal ( const BaseInteraction & c, const Vec3D & normal ) const

For the Interaction between particles/walls P and I, this function returns the dot product between the normal vector of the interaction and the branch vector from the current CGPoint towards P.

Definition at line 80 of file X.cc.

References BaseInteraction::getP(), BaseInteractable::getPosition(), Vec3D::X, and x_.

81 {
82  return (c.getP()->getPosition().X - x_) * normal.X;
83 }
const Vec3D & getPosition() const
Returns the position of this BaseInteractable.
Mdouble X
the vector components
Definition: Vector.h:65
BaseInteractable * getP()
Returns a pointer to first object involved in the interaction (normally a particle).
Mdouble x_
Definition: X.h:119
 Mdouble X::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 44 of file X.cc.

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

45 {
46  return (max.Y - min.Y) * (max.Z - min.Z);
47 }
Mdouble Y
Definition: Vector.h:65
Mdouble Z
Definition: Vector.h:65
 Mdouble X::getX ( ) const

Definition at line 54 of file X.cc.

References x_.

55 {
56  return x_;
57 }
Mdouble x_
Definition: X.h:119
 static bool CGCoordinates::X::isResolvedIn ( unsigned i )
inlinestatic

Definition at line 110 of file X.h.

110 {return i==0?true:false;}
 void X::setX ( Mdouble x )

Returns the position of the current CGPoint, in the non-averaged directions.

Definition at line 49 of file X.cc.

References x_.

50 {
51  x_ = x;
52 }
Mdouble x_
Definition: X.h:119
 void X::write ( std::ostream & os ) const

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

Definition at line 37 of file X.cc.

References x_.

38 {
39  os << x_ << ' ';
40 }
Mdouble x_
Definition: X.h:119
 void X::writeNames ( std::ostream & os )
static

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

Definition at line 32 of file X.cc.

33 {
34  os << "x ";
35 }

## Member Data Documentation

 Mdouble CGCoordinates::X::x_
protected

The x-position of the current CGPoint.

Definition at line 119 of file X.h.

Referenced by getCNormal(), getDistanceSquared(), getINormal(), getPNormal(), getX(), setX(), and write().

The documentation for this class was generated from the following files:
• CG/Coordinates/X.h
• CG/Coordinates/X.cc