CGCoordinates::XY Class Reference

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

#include <XY.h>

Inheritance diagram for CGCoordinates::XY:

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	setXY (Mdouble x, Mdouble y)
	Returns the position of the current CGPoint, in the non-averaged directions. More...
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...
Mdouble	getTangentialSquared (const BaseInteraction &c, Mdouble pNormal) const
	For the Interaction between particles/walls P and I, this function returns the square of the minimum distance between the the current CGPoint and the branch vector between P and I. 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_XY_XZ_YZ
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)

Protected Attributes
Mdouble	x_
Mdouble	y_

Detailed Description

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

See XYZ for details.

Member Function Documentation

getCNormal()

Mdouble XY::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.

{
    return (c.getContactPoint().X - x_) * normal.X
           + (c.getContactPoint().Y - y_) * normal.Y;
}

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

getDistanceSquared()

Mdouble XY::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 mathsFunc::square(p.X - x_) + mathsFunc::square(p.Y - y_);
}

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

getINormal()

Mdouble XY::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.

{
    return (c.getI()->getPosition().X - x_) * normal.X
           + (c.getI()->getPosition().Y - y_) * normal.Y;
}

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

getLength()

Mdouble XY::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

Todo:

{
    return sqrt(p.X * p.X + p.Y * p.Y);
}

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

getName()

std::string XY::getName ( )

static

{
    return "XY";
}

getPNormal()

Mdouble XY::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.

{
    return (c.getP()->getPosition().X - x_) * normal.X
           + (c.getP()->getPosition().Y - y_) * normal.Y;
}

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

getTangentialSquared()

Mdouble XY::getTangentialSquared	(	const BaseInteraction &	c,
		Mdouble	pNormal
	)		const

For the Interaction between particles/walls P and I, this function returns the square of the minimum distance between the the current CGPoint and the branch vector between P and I.

{
    return mathsFunc::square(c.getP()->getPosition().X - x_)
           + mathsFunc::square(c.getP()->getPosition().Y - y_)
           - mathsFunc::square(pNormal);
}

References BaseInteraction::getP(), BaseInteractable::getPosition(), mathsFunc::square(), Vec3D::X, x_, Vec3D::Y, and y_.

getVolumeOfAveragedDimensions()

Mdouble XY::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

{
    return max.Z - min.Z;
}

References Vec3D::Z.

isResolvedIn()

static bool CGCoordinates::XY::isResolvedIn ( unsigned  i )

inlinestatic

{return i==2?false:true;}

References constants::i.

setXY()

void XY::setXY	(	Mdouble	x,
		Mdouble	y
	)

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

{
    x_ = x;
    y_ = y;
}

References x_, and y_.

write()

void XY::write

(

std::ostream &

os

)

const

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

{
    os << x_ << ' ' << y_ << ' ';
}

References x_, and y_.

writeNames()

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

static

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

{
    os << "x y ";
}

Member Data Documentation

x_

Mdouble CGCoordinates::XY::x_

protected

The x-position of the current CGPoint.

Referenced by getCNormal(), getDistanceSquared(), getINormal(), getPNormal(), getTangentialSquared(), setXY(), and write().

y_

Mdouble CGCoordinates::XY::y_

protected

The y-position of the current CGPoint.

Referenced by getCNormal(), getDistanceSquared(), getINormal(), getPNormal(), getTangentialSquared(), setXY(), and write().

---

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

• XY.h
• XY.cc