Simpatico  v1.10
List of all members | Public Member Functions | Protected Member Functions
McMd::McSystemInterface Class Reference

Detailed Description

An interface to an McSystem.

Definition at line 30 of file McSystemInterface.h.

#include <McSystemInterface.h>

Inheritance diagram for McMd::McSystemInterface:
McMd::SystemInterface

Public Member Functions

 McSystemInterface (McSystem &mcSystem)
 Constructor. More...
 
virtual ~McSystemInterface ()
 Destructor. More...
 
- Public Member Functions inherited from McMd::SystemInterface
 SystemInterface (System &parent)
 Constructor. More...
 
virtual ~SystemInterface ()
 Destructor. More...
 
Systemsystem () const
 Get the parent System by reference. More...
 

Protected Member Functions

McPairPotentialpairPotential () const
 Get the McPairPotential. More...
 
BondPotentialbondPotential () const
 Get the BondPotential. More...
 
AnglePotentialanglePotential () const
 Get the AnglePotential. More...
 
DihedralPotentialdihedralPotential () const
 Get the DihedralPotential. More...
 
ExternalPotentialexternalPotential () const
 Get the ExternalPotential. More...
 
- Protected Member Functions inherited from McMd::SystemInterface
Boundaryboundary () const
 Get the Boundary by reference. More...
 
Simulationsimulation () const
 Get the parent Simulation by reference. More...
 
int nMolecule (int speciesId) const
 Get the number of molecules of one Species in this SystemInterface. More...
 
int nAtom () const
 Return the total number of atoms in this SystemInterface. More...
 
bool isEmpty () const
 Is this an empty SystemInterface (i.e., one with no molecules) ? More...
 
void begin (int speciesId, System::MoleculeIterator &iterator)
 Initialize an iterator for molecules of one species in this SystemInterface. More...
 
void begin (int speciesId, System::ConstMoleculeIterator &iterator) const
 Initialize a const iterator for molecules of one species in this SystemInterface. More...
 
bool hasBonds () const
 Does a bond potential exist? More...
 
bool hasAngles () const
 Does an angle potential exist? More...
 
bool hasDihedrals () const
 Does a dihedral potential exist? More...
 
bool hasLinks () const
 Does a link potential exist? More...
 
bool hasExternal () const
 Does an external potential exist? More...
 

Constructor & Destructor Documentation

McMd::McSystemInterface::McSystemInterface ( McSystem mcSystem)
McMd::McSystemInterface::~McSystemInterface ( )
virtual

Destructor.

Definition at line 67 of file McSystemInterface.cpp.

Member Function Documentation

McPairPotential & McMd::McSystemInterface::pairPotential ( ) const
inlineprotected

Get the McPairPotential.

Definition at line 114 of file McSystemInterface.h.

BondPotential & McMd::McSystemInterface::bondPotential ( ) const
inlineprotected

Get the BondPotential.

Definition at line 122 of file McSystemInterface.h.

AnglePotential & McMd::McSystemInterface::anglePotential ( ) const
inlineprotected

Get the AnglePotential.

Definition at line 130 of file McSystemInterface.h.

DihedralPotential & McMd::McSystemInterface::dihedralPotential ( ) const
inlineprotected

Get the DihedralPotential.

Definition at line 138 of file McSystemInterface.h.

ExternalPotential & McMd::McSystemInterface::externalPotential ( ) const
inlineprotected

Get the ExternalPotential.

Definition at line 146 of file McSystemInterface.h.


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