MercuryDPM  Trunk
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
CGFunctions Namespace Reference

Contains base classes of CGPoint; CGPoint is always templated with one of these classes; these classes contain the position of the CGPoint and the parameters of the coarse-graining function (width, cutoff, ...). More...

Classes

class  Gauss
 Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the Gauss coarse-graining function (width and cutoff). More...
 
class  Heaviside
 A specialisation of Polynomials for PolynomialType::Heaviside. See Polynomial for details. More...
 
class  Linear
 A specialisation of Polynomials for PolynomialType::Linear. See Polynomial for details. More...
 
class  Lucy
 A specialisation of Polynomials for PolynomialType::Lucy. See Polynomial for details. More...
 
class  Polynomial
 Defines the position of the CGPoint (e.g. x, y, z) and the parameters of a polynomial coarse-graining function (width and cutoff). More...
 

Typedefs

typedef CGFunctions::Gauss
< CGCoordinates::O
GaussO
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::X
GaussX
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::Y
GaussY
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::Z
GaussZ
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::YZ
GaussYZ
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::XZ
GaussXZ
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::XY
GaussXY
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::XYZ
GaussXYZ
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Gauss
< CGCoordinates::R
GaussR
 Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate. More...
 
typedef CGFunctions::Heaviside
< CGCoordinates::O
HeavisideO
 
typedef CGFunctions::Heaviside
< CGCoordinates::X
HeavisideX
 
typedef CGFunctions::Heaviside
< CGCoordinates::Y
HeavisideY
 
typedef CGFunctions::Heaviside
< CGCoordinates::Z
HeavisideZ
 
typedef CGFunctions::Heaviside
< CGCoordinates::YZ
HeavisideYZ
 
typedef CGFunctions::Heaviside
< CGCoordinates::XZ
HeavisideXZ
 
typedef CGFunctions::Heaviside
< CGCoordinates::XY
HeavisideXY
 
typedef CGFunctions::Heaviside
< CGCoordinates::XYZ
HeavisideXYZ
 
typedef CGFunctions::Linear
< CGCoordinates::O
LinearO
 
typedef CGFunctions::Linear
< CGCoordinates::X
LinearX
 
typedef CGFunctions::Linear
< CGCoordinates::Y
LinearY
 
typedef CGFunctions::Linear
< CGCoordinates::Z
LinearZ
 
typedef CGFunctions::Linear
< CGCoordinates::YZ
LinearYZ
 
typedef CGFunctions::Linear
< CGCoordinates::XZ
LinearXZ
 
typedef CGFunctions::Linear
< CGCoordinates::XY
LinearXY
 
typedef CGFunctions::Linear
< CGCoordinates::XYZ
LinearXYZ
 
typedef CGFunctions::Lucy
< CGCoordinates::O
LucyO
 
typedef CGFunctions::Lucy
< CGCoordinates::X
LucyX
 
typedef CGFunctions::Lucy
< CGCoordinates::Y
LucyY
 
typedef CGFunctions::Lucy
< CGCoordinates::Z
LucyZ
 
typedef CGFunctions::Lucy
< CGCoordinates::YZ
LucyYZ
 
typedef CGFunctions::Lucy
< CGCoordinates::XZ
LucyXZ
 
typedef CGFunctions::Lucy
< CGCoordinates::XY
LucyXY
 
typedef CGFunctions::Lucy
< CGCoordinates::XYZ
LucyXYZ
 

Enumerations

enum  PolynomialType : unsigned char { PolynomialType::HEAVISIDE = 0, PolynomialType::LINEAR = 1, PolynomialType::LUCY = 2 }
 PolynomialType is used to define how files are opened random fixed-particle bottom. More...
 

Functions

std::ostream & operator<< (std::ostream &os, PolynomialType type)
 
std::istream & operator>> (std::istream &is, PolynomialType &type)
 

Detailed Description

Contains base classes of CGPoint; CGPoint is always templated with one of these classes; these classes contain the position of the CGPoint and the parameters of the coarse-graining function (width, cutoff, ...).

See member class Gauss for more details.

Typedef Documentation

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 228 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 244 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 230 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 240 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 242 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 238 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 232 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 236 of file Gauss.h.

Defines a short notation for the Gaussian CGFunction templated with a certain CGCoordinate.

Definition at line 234 of file Gauss.h.

Definition at line 52 of file Lucy.h.

Definition at line 53 of file Lucy.h.

Definition at line 58 of file Lucy.h.

Definition at line 59 of file Lucy.h.

Definition at line 57 of file Lucy.h.

Definition at line 54 of file Lucy.h.

Definition at line 56 of file Lucy.h.

Definition at line 55 of file Lucy.h.

Enumeration Type Documentation

PolynomialType is used to define how files are opened random fixed-particle bottom.

Todo:
add user-defined PolynomialType USER
Enumerator
HEAVISIDE 
LINEAR 
LUCY 

Definition at line 48 of file Polynomial.h.

48  : unsigned char
49 {
50  HEAVISIDE = 0,
51  LINEAR = 1,
52  LUCY = 2
53 };

Function Documentation

std::ostream& CGFunctions::operator<< ( std::ostream &  os,
PolynomialType  type 
)
std::istream& CGFunctions::operator>> ( std::istream &  is,
PolynomialType &  type 
)