Lees-Edwards boundary conditions. More...

#include <LeesEdwards.hpp>

Inheritance diagram for OpenMPCD::CUDA::BoundaryCondition::LeesEdwards:

Collaboration diagram for OpenMPCD::CUDA::BoundaryCondition::LeesEdwards:

Public Member Functions
	LeesEdwards (const Configuration::Setting &config, const unsigned int simulationBoxSizeX, const unsigned int simulationBoxSizeY, const unsigned int simulationBoxSizeZ)
	The constructor. More...

virtual	~LeesEdwards ()
	The destructor. More...

virtual FP	getTotalAvailableVolume () const
	Returns the total available volume. More...

FP	getShearRate () const
	Returns the Lees-Edwards shear rate \( \dot{\gamma} \). More...

Detailed Description

Lees-Edwards boundary conditions.

See also: LeesEdwardsBoundaryConditions

The configuration group given in the constructor is expected to have exactly one child setting, called shearRate and of floating-point type, that specifies the Lees-Edwards shear rate \( \dot{\gamma} \).

Definition at line 31 of file LeesEdwards.hpp.

Constructor & Destructor Documentation

◆ LeesEdwards()

OpenMPCD::CUDA::BoundaryCondition::LeesEdwards::LeesEdwards	(	const Configuration::Setting &	config,
		const unsigned int	simulationBoxSizeX,
		const unsigned int	simulationBoxSizeY,
		const unsigned int	simulationBoxSizeZ
	)

The constructor.

Exceptions

OpenMPCD::InvalidConfigurationException Throws if the configuration is invalid.

Parameters

[in]	config	The configuration group that holds the Lees-Edwards boundary condition configuration.
[in]	simulationBoxSizeX	The size of the primary simulation volume along the `x` direction.
[in]	simulationBoxSizeY	The size of the primary simulation volume along the `y` direction.
[in]	simulationBoxSizeZ	The size of the primary simulation volume along the `z` direction.

◆ ~LeesEdwards()

virtual OpenMPCD::CUDA::BoundaryCondition::LeesEdwards::~LeesEdwards ( )

inlinevirtual

The destructor.

Definition at line 62 of file LeesEdwards.hpp.

Member Function Documentation

◆ getShearRate()

FP OpenMPCD::CUDA::BoundaryCondition::LeesEdwards::getShearRate ( ) const

inline

Returns the Lees-Edwards shear rate \( \dot{\gamma} \).

Definition at line 72 of file LeesEdwards.hpp.

◆ getTotalAvailableVolume()

virtual FP OpenMPCD::CUDA::BoundaryCondition::LeesEdwards::getTotalAvailableVolume ( ) const

virtual

Returns the total available volume.

The total available volume is here understood to be the volume of the primary simulation volume, reduced by the volume that is excluded by the boundary conditions.

The volume returned is in units of the MPC collision cell volume, where the MPC collision cell is assumed to be cubic and of side length \( 1 \).

Implements OpenMPCD::CUDA::BoundaryCondition::Base.

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

LeesEdwards.hpp