CGFunctions::ExactOverlap< Coordinates > Class Template Reference

Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the ExactOverlap coarse-graining function (width and cutoff). More...

#include <ExactOverlap.h>

Public Types
typedef Coordinates	CoordinatesType

Public Member Functions
	ExactOverlap ()
	Default constructor, it simply creates an empty ExactOverlapCoordinates. More...
	ExactOverlap (const ExactOverlap &c)=default
	Copy constructor. It copies the ExactOverlapCoordinates and all objects it contains. More...
	~ExactOverlap ()=default
	Destructor, does nothing, as no new'ed objects are used. More...
void	write (std::ostream &os) const
	Writes class content into an output stream, usually a stat file. More...
void	setWidth (Mdouble width)
	Sets the width of the coarse-graining function. More...
Mdouble	getWidth () const
	Returns the width of the coarse-graining function. More...
void	setStandardDeviation (Mdouble std)
	Sets the standard deviation of the coarse-graining function. More...
void	setWidthAndCutoff (Mdouble width, Mdouble cutoff)
	Sets the width and cutoff of the coarse-graining function. More...
Mdouble	getCutoff () const
	Returns the cutoff of the coarse-graining function. More...
Vec3D	getCutoffVector (Mdouble radius, Vec3D cellSize) const
	Returns the cutoff of the coarse-graining function along each direction. More...
void	setEps (Mdouble eps)
	Returns the finite difference step size used to evaluate derivatives of the CG function. More...
Mdouble	evaluateCGFunction (const Vec3D &position, const Coordinates r)
	Evaluates the coarse-graining function. More...
Mdouble	evaluateCGFunction (const Vec3D &position, const Mdouble rad, const Coordinates r)
	Evaluates the coarse-graining function. More...
Vec3D	evaluateCGFunctionDerivatives (const Vec3D &position, const Coordinates &r)
Mdouble	evaluateCGIntegral (const BaseInteraction &i, const Coordinates r, IntegralType type=IntegralType::I_TO_P)
	Evaluates the line integral needed for the calculation of stresses. More...

Detailed Description

template<class Coordinates>
class CGFunctions::ExactOverlap< Coordinates >

Defines the position of the CGPoint (e.g. x, y, z) and the parameters of the ExactOverlap coarse-graining function (width and cutoff).

The class is derived from a CGCoordinates class, thus it contains the position of the CGPoint in the non-averaged directions. It also contains the parameters of the ExactOverlap coarse-graining function (width and cutoff), as well as internal variables (not user-defined, but set by the code), like the prefactor of the ExactOverlap function (which depends on width, cutoff, and the coordinate type). It also contains all functions that only depend on the coordinate and function type; e.g. evaluateCGFunction and evaluateCGIntegral.

See CGFunctions for more details.

Member Typedef Documentation

CoordinatesType

template<class Coordinates >

typedef Coordinates CGFunctions::ExactOverlap< Coordinates >::CoordinatesType

Constructor & Destructor Documentation

ExactOverlap() [1/2]

template<class Coordinates >

CGFunctions::ExactOverlap< Coordinates >::ExactOverlap

(

)

Default constructor, it simply creates an empty ExactOverlapCoordinates.

ExactOverlap() [2/2]

template<class Coordinates >

CGFunctions::ExactOverlap< Coordinates >::ExactOverlap ( const ExactOverlap< Coordinates > &  c )

default

Copy constructor. It copies the ExactOverlapCoordinates and all objects it contains.

~ExactOverlap()

template<class Coordinates >

CGFunctions::ExactOverlap< Coordinates >::~ExactOverlap ( )

default

Destructor, does nothing, as no new'ed objects are used.

Member Function Documentation

evaluateCGFunction() [1/2]

template<class Coordinates >

Mdouble CGFunctions::ExactOverlap< Coordinates >::evaluateCGFunction ( const Vec3D &  position, const Coordinates  r  )

inline

Evaluates the coarse-graining function.

{ return constants::NaN; }

References constants::NaN.

evaluateCGFunction() [2/2]

template<class Coordinates >

Mdouble CGFunctions::ExactOverlap< Coordinates >::evaluateCGFunction	(	const Vec3D &	position,
		const Mdouble	rad,
		const Coordinates	r
	)

Evaluates the coarse-graining function.

evaluateCGFunctionDerivatives()

template<class Coordinates >

Vec3D CGFunctions::ExactOverlap< Coordinates >::evaluateCGFunctionDerivatives ( const Vec3D &  position, const Coordinates &  r  )

inline

    { return Vec3D(constants::NaN, constants::NaN, constants::NaN); }

References constants::NaN.

evaluateCGIntegral()

template<class Coordinates >

Mdouble CGFunctions::ExactOverlap< Coordinates >::evaluateCGIntegral ( const BaseInteraction &  i, const Coordinates  r, IntegralType  type = IntegralType::I_TO_P  )

inline

Evaluates the line integral needed for the calculation of stresses.

    { return constants::NaN; }

References constants::NaN.

getCutoff()

template<class Coordinates >

Mdouble CGFunctions::ExactOverlap< Coordinates >::getCutoff ( ) const

inline

Returns the cutoff of the coarse-graining function.

{ return constants::NaN; }

References constants::NaN.

getCutoffVector()

template<class Coordinates >

Vec3D CGFunctions::ExactOverlap< Coordinates >::getCutoffVector ( Mdouble  radius, Vec3D  cellSize  ) const

inline

Returns the cutoff of the coarse-graining function along each direction.

{ return cellSize + Vec3D(radius, radius, radius); }

References UniformPSDSelfTest::radius.

getWidth()

template<class Coordinates >

Mdouble CGFunctions::ExactOverlap< Coordinates >::getWidth ( ) const

inline

Returns the width of the coarse-graining function.

{ return constants::NaN; }

References constants::NaN.

setEps()

template<class Coordinates >

void CGFunctions::ExactOverlap< Coordinates >::setEps ( Mdouble  eps )

inline

Returns the finite difference step size used to evaluate derivatives of the CG function.

Sets the finite difference step size used to evaluate derivatives of the CG function.

{};

setStandardDeviation()

template<class Coordinates >

void CGFunctions::ExactOverlap< Coordinates >::setStandardDeviation ( Mdouble  std )

inline

Sets the standard deviation of the coarse-graining function.

{};

setWidth()

template<class Coordinates >

void CGFunctions::ExactOverlap< Coordinates >::setWidth ( Mdouble  width )

inline

Sets the width of the coarse-graining function.

{};

setWidthAndCutoff()

template<class Coordinates >

void CGFunctions::ExactOverlap< Coordinates >::setWidthAndCutoff ( Mdouble  width, Mdouble  cutoff  )

inline

Sets the width and cutoff of the coarse-graining function.

{};

write()

template<class Coordinates >

void CGFunctions::ExactOverlap< Coordinates >::write

(

std::ostream &

os

)

const

Writes class content into an output stream, usually a stat file.

---

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

• ExactOverlap.h