Base class for boundary condition. More...

#include <Base.hpp>

Inheritance diagram for OpenMPCD::CUDA::BoundaryCondition::Base:

Public Member Functions
virtual	~Base ()
	The destructor. More...

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

Protected Member Functions
	Base ()
	The constructor. More...

Detailed Description

Base class for boundary condition.

Definition at line 26 of file CUDA/BoundaryCondition/Base.hpp.

Constructor & Destructor Documentation

◆ Base()

OpenMPCD::CUDA::BoundaryCondition::Base::Base ( )

inlineprotected

The constructor.

Definition at line 32 of file CUDA/BoundaryCondition/Base.hpp.

◆ ~Base()

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

inlinevirtual

The destructor.

Definition at line 40 of file CUDA/BoundaryCondition/Base.hpp.

Member Function Documentation

◆ getTotalAvailableVolume()

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

pure 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 \).

Implemented in OpenMPCD::CUDA::BoundaryCondition::LeesEdwards.

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

CUDA/BoundaryCondition/Base.hpp