Collaboration diagram for madness::BoxSurfaceDisplacementFilter< NDIM >:

[legend]

Public Types
using	Displacement = Key< NDIM >

using	DistanceSquaredFunc = std::function< Translation(const Displacement &)>

using	Periodicity = array_of_bools< NDIM >

using	Point = Key< NDIM >

using	PointPattern = Vector< std::optional< Translation >, NDIM >

Public Member Functions
	BoxSurfaceDisplacementFilter (const array_of_bools< NDIM > &domain_is_infinite, const array_of_bools< NDIM > &domain_is_periodic, const std::array< KernelRange, NDIM > &range, DistanceSquaredFunc default_distance_squared, Translation max_distsq_reached)

bool	operator() (const Level level, const PointPattern &dest, std::optional< Displacement > &displacement) const
	Apply filter to a displacement ending up at a point or a group of points (point pattern)

Detailed Description

template<size_t NDIM>
class madness::BoxSurfaceDisplacementFilter< NDIM >

This is used to filter out box surface displacements that

take us outside of the target domain, or
were already utilized as part of the the standard displacements list. For dealing with the lattice-summed operators the filter can adjusts the displacement to make sure that we end up in the simulation cell.

Member Typedef Documentation

template<size_t NDIM>

template<size_t NDIM>

template<size_t NDIM>

template<size_t NDIM>

template<size_t NDIM>

template<size_t NDIM>

madness::BoxSurfaceDisplacementFilter< NDIM >::BoxSurfaceDisplacementFilter	(	const array_of_bools< NDIM > &	domain_is_infinite,
		const array_of_bools< NDIM > &	domain_is_periodic,
		const std::array< KernelRange, NDIM > &	range,
		DistanceSquaredFunc	default_distance_squared,
		Translation	max_distsq_reached
	)

inline

Parameters

domain_is_infinite	whether the domain along each axis is finite (simulation cell) or infinite (the entire axis); if true for a given axis then any destination coordinate is valid, else only values in [0,2^n) are valid
domain_is_periodic	if true for a given axis, displacement to x and x+2^n are equivalent, hence will be canonicalized to end up in the simulation cell. Periodic axes imply infinite domain.
range	the kernel range for each axis
default_distance_squared	function that converts a displacement to its effective distance squared (effective may be different from the real distance squared due to periodicity)
max_distsq_reached	max effective distance squared reached by standard displacements

template<size_t NDIM>

bool madness::BoxSurfaceDisplacementFilter< NDIM >::operator()	(	const Level	level,
		const PointPattern &	dest,
		std::optional< Displacement > &	displacement
	)		const

inline

Apply filter to a displacement ending up at a point or a group of points (point pattern)

Parameters

level	the tree level
dest	the target point (when all elements are nonnull) or point pattern (when only some are). The latter is useful to skip the entire surface layer. The point coordinates are only used to determine whether we end up in or out of the domain.
displacement	the optional displacement; if given then will check if it's among the standard displacement and whether it was used as part of the standard displacement set; if it has not been used and the operator is lattice summed, the displacement will be adjusted to end up in the simulation cell.