coupling::SetGivenVelocity4MomentumInsertion< LinkedCell, dim > Class Template Reference

#include <SetGivenVelocity4MomentumInsertion.h>

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

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

Public Member Functions
	SetGivenVelocity4MomentumInsertion (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	a simple constructor
virtual	~SetGivenVelocity4MomentumInsertion ()
	a simple destructor
unsigned int	getTimeIntervalPerMomentumInsertion () const override
	returns 1, since momentum insertions will be applied in every md timestep
void	insertMomentum (coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > &cell, I02 idx) const override
	updates the momentum based on the microscopic momentum
Public Member Functions inherited from coupling::MomentumInsertion< LinkedCell, dim >
	MomentumInsertion (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	a simple constructor
virtual	~MomentumInsertion ()
	a simple destructor

Additional Inherited Members
Protected Attributes inherited from coupling::MomentumInsertion< LinkedCell, dim >
coupling::interface::MDSolverInterface< LinkedCell, dim > *const	_mdSolverInterface

Detailed Description

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

interpretes the microscopicMomentum-buffer as velocity and sets this value in the respective coupling cell.

Author

Philipp Neumann

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

Constructor & Destructor Documentation

SetGivenVelocity4MomentumInsertion()

template<class LinkedCell, unsigned int dim>

coupling::SetGivenVelocity4MomentumInsertion< LinkedCell, dim >::SetGivenVelocity4MomentumInsertion ( coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface )

inline

a simple constructor

Parameters

mdSolverInterface

interface for the md solver

Member Function Documentation

getTimeIntervalPerMomentumInsertion()

template<class LinkedCell, unsigned int dim>

unsigned int coupling::SetGivenVelocity4MomentumInsertion< LinkedCell, dim >::getTimeIntervalPerMomentumInsertion ( ) const

inlineoverridevirtual

returns 1, since momentum insertions will be applied in every md timestep

Returns

the time step interval for momentum insertion

Implements coupling::MomentumInsertion< LinkedCell, dim >.

insertMomentum()

template<class LinkedCell, unsigned int dim>

void coupling::SetGivenVelocity4MomentumInsertion< LinkedCell, dim >::insertMomentum ( coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > & cell, I02 idx ) const

inlineoverridevirtual

updates the momentum based on the microscopic momentum

This method does not conserve the kinetic energy of the respective coupling cell. To conserve the energy as well, see the description of MomentumController on details how to do that.

Parameters

cell	coupling cell

Implements coupling::MomentumInsertion< LinkedCell, dim >.

---

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

• coupling/SetGivenVelocity4MomentumInsertion.h