Gromacs  2020.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
gmx::SimulatorBuilder Class Reference

#include <gromacs/mdrun/simulatorbuilder.h>

Description

Class preparing the creation of Simulator objects.

Objects of this class build Simulator objects, which in turn are used to run molecular simulations. Currently, this only has a single public build function which takes all arguments needed to build the LegacySimulator.

Public Member Functions

template<typename... Args>
std::unique_ptr< ISimulator > build (bool inputIsCompatibleWithModularSimulator, Args &&...args)
 Build a Simulator object based on input data. More...
 

Member Function Documentation

template<typename... Args>
std::unique_ptr< ISimulator > gmx::SimulatorBuilder::build ( bool  inputIsCompatibleWithModularSimulator,
Args &&...  args 
)

Build a Simulator object based on input data.

Build a Simulator object.

Return a pointer to a simulation object. The use of a parameter pack insulates the builder from changes to the arguments of the Simulator objects.

Returns
Unique pointer to a Simulator object

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