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

dummy class. Empty momentum insertion mechanism. Doesn't change anything. More...

#include <NoMomentumInsertion.h>

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

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

Public Member Functions
	NoMomentumInsertion (coupling::interface::MDSolverInterface< LinkedCell, dim > *const mdSolverInterface)
	a simple constructor
virtual	~NoMomentumInsertion ()
	a simple destructor
unsigned int	getTimeIntervalPerMomentumInsertion () const override
	returns the number of MD steps between subsequent momentum insertions
void	insertMomentum (coupling::datastructures::CouplingCellWithLinkedCells< LinkedCell, dim > &cell, I02 idx) const override
	a dummy function, which doesn't do anything
void	setInnerImposition (bool enable) override
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::NoMomentumInsertion< LinkedCell, dim >

dummy class. Empty momentum insertion mechanism. Doesn't change anything.

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

NoMomentumInsertion()

template<class LinkedCell, unsigned int dim>

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

inline

a simple constructor

Parameters

mdSolverInterface

interface to the md solver

Member Function Documentation

getTimeIntervalPerMomentumInsertion()

template<class LinkedCell, unsigned int dim>

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

inlineoverridevirtual

returns the number of MD steps between subsequent momentum insertions

Todo

We could set this to be zero? Since it does anything

Returns

the time step interval for momentum insertion

Implements coupling::MomentumInsertion< LinkedCell, dim >.

insertMomentum()

template<class LinkedCell, unsigned int dim>

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

inlineoverridevirtual

a dummy function, which doesn't do anything

Parameters

cell	the coupling cell to not change

Implements coupling::MomentumInsertion< LinkedCell, dim >.

setInnerImposition()

template<class LinkedCell, unsigned int dim>

void coupling::NoMomentumInsertion< LinkedCell, dim >::setInnerImposition ( bool enable )

inlineoverridevirtual

Used to activate / deactivate momentum insertion also on inner cell layers

Implements coupling::MomentumInsertion< LinkedCell, dim >.

---

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

• coupling/NoMomentumInsertion.h