empty implementation of particle insertion (no particle insertion/removal). More...

Inheritance diagram for coupling::NoParticleInsertion< LinkedCell, dim >:

Collaboration diagram for coupling::NoParticleInsertion< LinkedCell, dim >:

Public Member Functions
virtual coupling::ParticleInsertion< LinkedCell, dim >::Action	insertDeleteMass (coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > &cell, const tarch::la::Vector< dim, double > &couplingCellPosition, const tarch::la::Vector< dim, double > &couplingCellSize, const tarch::la::Vector< dim, double > &meanVelocity, const double &temperature, const coupling::BoundaryForceController< LinkedCell, dim > &boundaryForceController)
	dummy function, doesn't change or do something

virtual bool	requiresPotentialEnergyLandscape ()
	returns false, since no energy landscape is needed in the dummy class

	NoParticleInsertion ()
	a simple constructor

virtual	~NoParticleInsertion ()
	a simple destructor

Public Member Functions inherited from coupling::ParticleInsertion< LinkedCell, dim >
	ParticleInsertion (unsigned int insertDeleteMassEveryTimestep)
	a simple constructor

virtual	~ParticleInsertion ()
	a simple destructor

bool	insertDeleteMassAtTimestep (unsigned int t) const
	returns true if mass needs to be inserted or removed in a time step t

Additional Inherited Members
Public Types inherited from coupling::ParticleInsertion< LinkedCell, dim >
enum	Action { NoAction = 0 , Insertion = 1 , Deletion = 2 }

Detailed Description

template<class LinkedCell, unsigned int dim>
class coupling::NoParticleInsertion< LinkedCell, dim >

empty implementation of particle insertion (no particle insertion/removal).

Template Parameters

LinkedCell	the LinkedCell class is given by the implementation of linked cells in the molecular dynamics simulation
dim	refers to the spacial dimension of the simulation, can be 1, 2, or 3

Member Function Documentation

template<class LinkedCell, unsigned int dim>

virtual coupling::ParticleInsertion< LinkedCell, dim >::Action coupling::NoParticleInsertion< LinkedCell, dim >::insertDeleteMass	(	coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > &	cell,
		const tarch::la::Vector< dim, double > &	couplingCellPosition,
		const tarch::la::Vector< dim, double > &	couplingCellSize,
		const tarch::la::Vector< dim, double > &	meanVelocity,
		const double &	temperature,
		const coupling::BoundaryForceController< LinkedCell, dim > &	boundaryForceController )

inlinevirtual

dummy function, doesn't change or do something

Returns: coupling::ParticleInsertion::NoAction since no mass is deleted or inserted

template<class LinkedCell, unsigned int dim>

virtual bool coupling::NoParticleInsertion< LinkedCell, dim >::requiresPotentialEnergyLandscape ( )

inlinevirtual

returns false, since no energy landscape is needed in the dummy class

Returns: a bool that indicates if a potential energy landscape is neccessary (true) or not (false)

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