clustersim.cpp File Reference

Include dependency graph for clustersim.cpp:

Go to the source code of this file.

Functions
string	createCluster (Cluster &cluster, const ConfigurationDatabase &conf)
void	interactiveRun (ConfigurationDatabase &conf, Cluster &cluster)
int	main (int argc, char *argv[])
void	nonInteractiveRun (ConfigurationDatabase &conf, ConfigurationDatabase runSetup, Cluster &cluster)
string	selectSimulation (Cluster &cluster, string prevName, const ConfigurationDatabase &conf)

---

Function Documentation

string createCluster (  Cluster &  cluster, const ConfigurationDatabase &  conf )

Creates a cluster selected by the users that is then ready for a simulation. Parameters: cluster  has the atoms arranged as the user has chosen. conf  contains the default configuration values. Returns: The base name of the current run file. Definition at line 149 of file clustersim.cpp. References Menu::addMenuItem(), FCC_Lattice::createLattice(), ConfigurationDatabase::doubleValue(), Menu::draw(), ConfigurationDatabase::intValue(), Menu::MENU_EXIT, Menu::menuItem(), Menu::selectMenuItem(), and Cluster::write(). Referenced by interactiveRun(). Here is the call graph for this function:

void interactiveRun (  ConfigurationDatabase &  conf, Cluster &  cluster )

This will run the programme in an interactive mode. Parameters: conf  contains the default configuratione values. cluster  is the cluster to perform the simulation on. Definition at line 265 of file clustersim.cpp. References Menu::addMenuItem(), Cluster::clear(), createCluster(), Menu::draw(), Menu::MENU_EXIT, Menu::menuItem(), Cluster::read(), Menu::selectMenuItem(), selectSimulation(), Menu::setFeedback(), Cluster::size(), and Cluster::write(). Referenced by main(). Here is the call graph for this function:

int main (  int  argc, char *  argv[] )

This is the starting location for the programme. Parameters: argc  is the number of arguments passed into the programme. argv[]  is the optional paramaters for the programme. Valid options are: -v for the version. -c for using a configuration file from a different location, followed by the configuration file. -n for running the programme in non-interactive mode, followed by the simulation configuration file. -h for displaying the list of available arguments. If an invailid option is passed an error message is printed, and then the programme quits. Returns: the success or failure of the programme. Author: John Schneiderman Definition at line 83 of file clustersim.cpp. References interactiveRun(), and nonInteractiveRun(). Here is the call graph for this function:

void nonInteractiveRun (  ConfigurationDatabase &  conf, ConfigurationDatabase  runSetup, Cluster &  cluster )

This will run the programme in a non-interactive mode. Parameters: conf  contains the default configuratione values. runSetup  is the setup values for each run. cluster  is the cluster to perform the simulation on. Definition at line 334 of file clustersim.cpp. References Cluster::clear(), ConfigurationDatabase::doubleValue(), ConfigurationDatabase::headers(), ConfigurationDatabase::intValue(), Cluster::read(), BaseSimulation::run(), BaseSimulation::setChangeInStep(), BaseSimulation::setPrintInterval(), BaseSimulation::setRunSteps(), MC_Simulation::setTemperature(), ConfigurationDatabase::stringValue(), and Cluster::write(). Referenced by main(). Here is the call graph for this function:

string selectSimulation (  Cluster &  cluster, string  prevName, const ConfigurationDatabase &  conf )

Runs the simulations that the user chooses. Parameters: cluster  is the cluster to perform the simulation on. prevName  is the base name of the 1previous run file. conf  contains the default configuration values. Returns: The name of the new base name for the current run file. Definition at line 185 of file clustersim.cpp. References Menu::addMenuItem(), ConfigurationDatabase::doubleValue(), Menu::draw(), ConfigurationDatabase::intValue(), Menu::MENU_EXIT, Menu::menuItem(), BaseSimulation::run(), Menu::selectMenuItem(), BaseSimulation::setChangeInStep(), Menu::setFeedback(), BaseSimulation::setPrintInterval(), BaseSimulation::setRunSteps(), MC_Simulation::setTemperature(), and Cluster::size(). Referenced by interactiveRun(). Here is the call graph for this function:

---