Determines if two groups are separated beyond the cutoff distance. More...

#include <energy.h>

Public Member Functions
bool	cut (const Group &group1, const Group &group2)
	Determines if two groups are separated beyond the cutoff distance. More...

double	getCutoff (size_t id1, size_t id2) const

template<typename... Args>
auto	operator() (Args &&... args)
	A functor alias for cut(). More...

	GroupCutoff (Space::GeometryType &geometry)
	Sets the geometry. More...

Friends
void	from_json (const json &, GroupCutoff &)

void	to_json (json &, const GroupCutoff &)

Detailed Description

Determines if two groups are separated beyond the cutoff distance.

The distance between centers of mass is considered. The cutoff distance can be specified independently for each group pair to override the default value.

See also: GroupPairingPolicy

Constructor & Destructor Documentation

◆ GroupCutoff()

Faunus::Energy::GroupCutoff::GroupCutoff ( Space::GeometryType & geometry )

explicit

Sets the geometry.

Parameters

geometry geometry to compute the inter group distance with

Member Function Documentation

◆ cut()

bool Faunus::Energy::GroupCutoff::cut	(	const Group &	group1,
		const Group &	group2
	)

inline

Determines if two groups are separated beyond the cutoff distance.

Returns: true if the group-to-group distance is beyond the cutoff distance, false otherwise

◆ operator()()

template<typename... Args>

auto Faunus::Energy::GroupCutoff::operator() ( Args &&... args )

inline

A functor alias for cut().

See also: cut()

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

src/energy.h
src/energy.cpp