File SettingPopulator.h

Copyright

This code is licensed under the 3-clause BSD license.

Copyright ETH Zurich, Laboratory for Physical Chemistry, Reiher Group.

See LICENSE.txt for details.

namespace Scine

This header file contains functions that allow for common notation for common things that can be done at a different degree of derivatives.

This header contains alias definitions defining which classes to use for the different degrees of derivatives.

namespace Utils
namespace UniversalSettings
class SettingPopulator
#include <SettingPopulator.h>

This class populates the common settings of many calculators.

These settings include molecular charge, spin multiplicity, restricted/unrestricted formalism, and SCF options. It populates a Utils::UniversalSettings::DescriptorCollection with default values.

Public Types

using SettingsCollection = Utils::UniversalSettings::DescriptorCollection

Public Static Functions

static void populateLCAOSettings(SettingsCollection &settings)

Populate Settings in the by-reference argument with default settings common to all LCAO methods.

static void populateSCFSettings(SettingsCollection &settings)

Populate Settings in the by-reference argument with default settings common to all SCF methods.

static void populateSemiEmpiricalSettings(SettingsCollection &settings, std::string defaultParameterFile = "parameter.xml")

Populate Settings in the by-reference argument with default settings common to all SemiEmpirical methods.

Here the parameter files settings are set. In order for this to work SPARROWInitializer::initialize() must already be called.

Parameters

  • defaultParameterFile: describes the default name of the parameter for a semi-empirical method. For NDDO methods it is usually parameter.xml, for DFTB it is different.

static Utils::scf_mixer_t stringToSCFMixer(const std::string &scfMixerName)

This function converts a mixer name into a mixer type.

Return

a Util::scf_mixer_t, the type of a scf mixer.

Parameters

  • scfMixerName: Name of the mixer type.

static std::string scfMixerToString(Utils::scf_mixer_t mixerType)

This function converts a mixer type into a mixer name.

Return

a std::string containing the name of the scf mixer.

Parameters

  • scfMixerType: Type of the scf mixer.

static Utils::Log::severity_level stringToLogLevel(const std::string &logVerbosityString)

This function converts a log verbosity string into a severity_level type.

Return

Utils::Log::severity_level The severity_level type corresponding to the given string.

Parameters

  • logVerbosityString: Name of the log verbosity level.

Private Static Functions

static void addMolecularCharge(SettingsCollection &settings)
static void addSpinMultiplicity(SettingsCollection &settings)
static void addUnrestrictedCalculation(SettingsCollection &settings)
static void addLogOption(SettingsCollection &settings)
static void addSelfConsistanceCriterion(SettingsCollection &settings)
static void addMaxIterations(SettingsCollection &settings)
static void addSCFMixer(SettingsCollection &settings)