CUBY logo

Interfaces

In Cuby, all calculations of potential and molecular properties are accessed via interfaces - modules of the code that provide unified access to the calculation. These modules are loaded at runtime by Calculation class only when they are needed. Source code of the interfaces is located at directory /classes/interfaces.

The interfaces are listed in file /classes/interfaces/interfaces.yaml. Cuby looks up the record here to find how to call the interface and what types of calculations it provides.

Parallelization

There are two ways how to run parallel jobs in Cuby. The first one is to ask the program that's being called to run parallel. Some interfaces have this option, look for keyword parallel in the description of the interface. Some jobs consisting of multiple calculations can be parallelized by running these calculations at the same time. Cuby manages this parallelization itself, more details can be found on page Parallelization.

Currently, these interfaces are implemented:

Calculation

These interfaces provide a standalone calculation of potential, mostly using external software to perform the calculation.

AMBERMolecular mechanics in AMBER.
AMBER_NABMolecular mechanics NAB program, a part of free suite AmberTools.
CHARMMMolecular mechanics in CHARMM.
deMonDFT calculation in deMon.
DFTB+Calculation using SCC-DFTB(-D) method.
GaussianCalculations in Gaussiang G03 package.
MetainterfaceMetainterface provides access to more external codes with simple input and output, using instructions from data file to prepare the calculation and read the results.
MolproCalculations in Molpro 2009 package.
MOPACCalculations in MOPAC 2009 package.
NWChemQM calculations in NWChem.
PQSQM calculations in PQS.
TurbomoleInterface to QM calculations in Turbomole.
VoidThis interface does not perform any calculation, but returns zeroes as the result.
Water_FFWater-only forcefield integrated in cuby.

Modifiers

These interfaces provide calculations that modify potential calculated using another method. The implementation has the same form as other interfaces, and can thus be used alone when calculation of the correction only is needed.

Modifiers are added to a calculation using the keyword modifiers. More than one modifiers can be used.

DispersionDispersion correction to be used with DFT and other methods.
H-bonds for PM6Correction of hydrogen bonds in PM6 method.
WaterballSpherical boundary conditions for MD in water
RestraintsHarmonic restraints in internal coordinates
Cartesian restraintsRestraints in cartesian coordinates
Simple restraintsSimple atomwise restraints in cartesian coordinates
Dispersion3Third generation dispersion correction (-D3) implemented in cuby.
Dftd3Third generation dispersion correction (-D3) using external program.
Friesner DFT correctionEmpirical dispersion and H-bond corrections for B3LYP.

Virtual interfaces

Virtual interfaces implement methods that are composed of more separate calculations. Virtual interface takes care of all the underlying calculations and provides the final results. The input usually defines the separate calculations in their own subsections, which are parsed as described here.

CompositeUser-defined combination of multiple calculations.
Counterpoise correctionProvides counterpoise correction of basis set superposition error (BSSE) in complexes.
Fragmented calculationsProvides calculation of large systems by decomposing them to small fragments and reconstructing the final results from them.
MFBAMulti-level Fragment-Based Approach
MixerPotential mixer
QM/MMTwo-level calculations

Interface functionality

Following table summarizes available functions of the interfaces:

Interface Energy Gradient Hessian Atomic
charges
External
charges
Ghost
atoms
Solvent
AMBER YES YES YES YES YES
AMBER_NAB YES YES
deMon YES YES YES YES YES
DFTB+ YES YES YES YES
Gaussian YES YES YES
Metainterface YES YES YES YES
Molpro YES YES YES
Mopac YES YES YES
NWChem YES YES YES
PQS YES YES
Turbomole YES YES YES YES YES YES YES
Void YES YES YES YES
Water_FF YES YES
Dispersion YES YES YES YES
Friesner correction YES YES
H-bonds for PM6 YES YES
Waterball YES YES
Restraints YES YES
Cartesian restraints YES YES
Composite YES YES
Counterpoise correction YES YES
Fragmented calculations YES YES YES
MFBA YES YES YES
QM/MMYES YES YES
MixerYES YES