#include <OpenMPCD/Types.hpp>
#include <OpenMPCD/Vector3D.hpp>

Include dependency graph for LeesEdwardsBoundaryConditions.hpp:

This graph shows which files directly or indirectly include this file:

Functions
const Vector3D< MPCParticlePositionType >	OpenMPCD::getImageUnderLeesEdwardsBoundaryConditions (const Vector3D< MPCParticlePositionType > &position, const FP mpcTime, const FP shearRate, const unsigned int simBoxX, const unsigned int simBoxY, const unsigned int simBoxZ, MPCParticleVelocityType *const velocityCorrection)
	Returns the image of the given particle position under Lees-Edwards boundary conditions. More...

Detailed Description

Defines Host functions for Lees-Edwards boundary conditions.

Function Documentation

const OpenMPCD::Vector3D< OpenMPCD::MPCParticlePositionType > OpenMPCD::getImageUnderLeesEdwardsBoundaryConditions	(	const Vector3D< MPCParticlePositionType > &	position,
		const FP	mpcTime,
		const FP	shearRate,
		const unsigned int	simBoxX,
		const unsigned int	simBoxY,
		const unsigned int	simBoxZ,
		MPCParticleVelocityType *const	velocityCorrection
	)

Returns the image of the given particle position under Lees-Edwards boundary conditions.

Exceptions

OpenMPCD::NULLPointerException If OPENMPCD_DEBUG is defined, throws if velocityCorrection == nullptr.

Parameters

[in]	position	The particle position.
[in]	mpcTime	The simulation time for the MPC steps.
[in]	shearRate	The applied shear rate.
[in]	simBoxX	The size of the primary simulation box along the x direction.
[in]	simBoxY	The size of the primary simulation box along the y direction.
[in]	simBoxZ	The size of the primary simulation box along the z direction.
[out]	velocityCorrection	Set to the velocity along the x direction that needs to be added to the particle's velocity.