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	ExactOverlap
	Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the ExactOverlap coarse-graining function (width and cutoff). More...
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::ExactOverlap< CGCoordinates::O >	ExactOverlapO
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::X >	ExactOverlapX
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::Y >	ExactOverlapY
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::Z >	ExactOverlapZ
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::YZ >	ExactOverlapYZ
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::XZ >	ExactOverlapXZ
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::XY >	ExactOverlapXY
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::XYZ >	ExactOverlapXYZ
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
typedef CGFunctions::ExactOverlap< CGCoordinates::R >	ExactOverlapR
	Defines a short notation for the ExactOverlapian CGFunction templated with a certain CGCoordinate. More...
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 class	PolynomialType : unsigned char { HEAVISIDE = 0 , LINEAR = 1 , 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 ExactOverlap for more details.

See member class Gauss for more details.

Typedef Documentation

ExactOverlapO

typedef CGFunctions::ExactOverlap<CGCoordinates::O> CGFunctions::ExactOverlapO

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

ExactOverlapR

typedef CGFunctions::ExactOverlap<CGCoordinates::R> CGFunctions::ExactOverlapR

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

ExactOverlapX

typedef CGFunctions::ExactOverlap<CGCoordinates::X> CGFunctions::ExactOverlapX

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

ExactOverlapXY

typedef CGFunctions::ExactOverlap<CGCoordinates::XY> CGFunctions::ExactOverlapXY

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

ExactOverlapXYZ

typedef CGFunctions::ExactOverlap<CGCoordinates::XYZ> CGFunctions::ExactOverlapXYZ

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

ExactOverlapXZ

typedef CGFunctions::ExactOverlap<CGCoordinates::XZ> CGFunctions::ExactOverlapXZ

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

ExactOverlapY

typedef CGFunctions::ExactOverlap<CGCoordinates::Y> CGFunctions::ExactOverlapY

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

ExactOverlapYZ

typedef CGFunctions::ExactOverlap<CGCoordinates::YZ> CGFunctions::ExactOverlapYZ

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

ExactOverlapZ

typedef CGFunctions::ExactOverlap<CGCoordinates::Z> CGFunctions::ExactOverlapZ

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

GaussO

typedef CGFunctions::Gauss<CGCoordinates::O> CGFunctions::GaussO

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

GaussR

typedef CGFunctions::Gauss<CGCoordinates::R> CGFunctions::GaussR

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

GaussX

typedef CGFunctions::Gauss<CGCoordinates::X> CGFunctions::GaussX

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

GaussXY

typedef CGFunctions::Gauss<CGCoordinates::XY> CGFunctions::GaussXY

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

GaussXYZ

typedef CGFunctions::Gauss<CGCoordinates::XYZ> CGFunctions::GaussXYZ

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

GaussXZ

typedef CGFunctions::Gauss<CGCoordinates::XZ> CGFunctions::GaussXZ

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

GaussY

typedef CGFunctions::Gauss<CGCoordinates::Y> CGFunctions::GaussY

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

GaussYZ

typedef CGFunctions::Gauss<CGCoordinates::YZ> CGFunctions::GaussYZ

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

GaussZ

typedef CGFunctions::Gauss<CGCoordinates::Z> CGFunctions::GaussZ

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

HeavisideO

typedef CGFunctions::Heaviside<CGCoordinates::O> CGFunctions::HeavisideO

HeavisideX

typedef CGFunctions::Heaviside<CGCoordinates::X> CGFunctions::HeavisideX

HeavisideXY

typedef CGFunctions::Heaviside<CGCoordinates::XY> CGFunctions::HeavisideXY

HeavisideXYZ

typedef CGFunctions::Heaviside<CGCoordinates::XYZ> CGFunctions::HeavisideXYZ

HeavisideXZ

typedef CGFunctions::Heaviside<CGCoordinates::XZ> CGFunctions::HeavisideXZ

HeavisideY

typedef CGFunctions::Heaviside<CGCoordinates::Y> CGFunctions::HeavisideY

HeavisideYZ

typedef CGFunctions::Heaviside<CGCoordinates::YZ> CGFunctions::HeavisideYZ

HeavisideZ

typedef CGFunctions::Heaviside<CGCoordinates::Z> CGFunctions::HeavisideZ

LinearO

typedef CGFunctions::Linear<CGCoordinates::O> CGFunctions::LinearO

LinearX

typedef CGFunctions::Linear<CGCoordinates::X> CGFunctions::LinearX

LinearXY

typedef CGFunctions::Linear<CGCoordinates::XY> CGFunctions::LinearXY

LinearXYZ

typedef CGFunctions::Linear<CGCoordinates::XYZ> CGFunctions::LinearXYZ

LinearXZ

typedef CGFunctions::Linear<CGCoordinates::XZ> CGFunctions::LinearXZ

LinearY

typedef CGFunctions::Linear<CGCoordinates::Y> CGFunctions::LinearY

LinearYZ

typedef CGFunctions::Linear<CGCoordinates::YZ> CGFunctions::LinearYZ

LinearZ

typedef CGFunctions::Linear<CGCoordinates::Z> CGFunctions::LinearZ

LucyO

typedef CGFunctions::Lucy<CGCoordinates::O> CGFunctions::LucyO

LucyX

typedef CGFunctions::Lucy<CGCoordinates::X> CGFunctions::LucyX

LucyXY

typedef CGFunctions::Lucy<CGCoordinates::XY> CGFunctions::LucyXY

LucyXYZ

typedef CGFunctions::Lucy<CGCoordinates::XYZ> CGFunctions::LucyXYZ

LucyXZ

typedef CGFunctions::Lucy<CGCoordinates::XZ> CGFunctions::LucyXZ

LucyY

typedef CGFunctions::Lucy<CGCoordinates::Y> CGFunctions::LucyY

LucyYZ

typedef CGFunctions::Lucy<CGCoordinates::YZ> CGFunctions::LucyYZ

LucyZ

typedef CGFunctions::Lucy<CGCoordinates::Z> CGFunctions::LucyZ

Enumeration Type Documentation

PolynomialType

enum CGFunctions::PolynomialType : unsigned char

strong

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

Todo:

add user-defined PolynomialType USER

Enumerator
HEAVISIDE
LINEAR
LUCY

{
    HEAVISIDE = 0,
    LINEAR = 1,
    LUCY = 2
};

Function Documentation

operator<<()

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

operator>>()

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