KIM API V2
Public Member Functions | List of all members
KIM::ModelDriverCreate Class Reference

#include <KIM_ModelDriverCreate.hpp>

Public Member Functions

void GetNumberOfParameterFiles (int *const numberOfParameterFiles) const
 
int GetParameterFileName (int const index, std::string *const parameterFileName) const
 
int SetModelNumbering (Numbering const numbering)
 
void SetInfluenceDistancePointer (double const *const influenceDistance)
 
void SetNeighborListCutoffsPointer (int const numberOfCutoffs, double const *const cutoffs)
 
int SetRefreshPointer (LanguageName const languageName, func *const fptr)
 
int SetDestroyPointer (LanguageName const languageName, func *const fptr)
 
int SetComputePointer (LanguageName const languageName, func *const fptr)
 
int SetSpeciesCode (SpeciesName const speciesName, int const code)
 
int SetArgumentSupportStatus (ArgumentName const argumentName, SupportStatus const supportStatus)
 
int SetCallbackSupportStatus (CallbackName const callbackName, SupportStatus const supportStatus)
 
int SetParameterPointer (int const extent, int *const ptr, std::string const &description)
 
int SetParameterPointer (int const extent, double *const ptr, std::string const &description)
 
void SetModelBufferPointer (void *const ptr)
 
int SetUnits (LengthUnit const lengthUnit, EnergyUnit const energyUnit, ChargeUnit const chargeUnit, TemperatureUnit const temperatureUnit, TimeUnit const timeUnit)
 
int ConvertUnit (LengthUnit const fromLengthUnit, EnergyUnit const fromEnergyUnit, ChargeUnit const fromChargeUnit, TemperatureUnit const fromTemperatureUnit, TimeUnit const fromTimeUnit, LengthUnit const toLengthUnit, EnergyUnit const toEnergyUnit, ChargeUnit const toChargeUnit, TemperatureUnit const toTemperatureUnit, TimeUnit const toTimeUnit, double const lengthExponent, double const energyExponent, double const chargeExponent, double const temperatureExponent, double const timeExponent, double *const conversionFactor) const
 
void LogEntry (LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const
 
std::string String () const
 

Detailed Description

Definition at line 61 of file KIM_ModelDriverCreate.hpp.

Member Function Documentation

◆ ConvertUnit()

int KIM::ModelDriverCreate::ConvertUnit ( LengthUnit const  fromLengthUnit,
EnergyUnit const  fromEnergyUnit,
ChargeUnit const  fromChargeUnit,
TemperatureUnit const  fromTemperatureUnit,
TimeUnit const  fromTimeUnit,
LengthUnit const  toLengthUnit,
EnergyUnit const  toEnergyUnit,
ChargeUnit const  toChargeUnit,
TemperatureUnit const  toTemperatureUnit,
TimeUnit const  toTimeUnit,
double const  lengthExponent,
double const  energyExponent,
double const  chargeExponent,
double const  temperatureExponent,
double const  timeExponent,
double *const  conversionFactor 
) const

◆ GetNumberOfParameterFiles()

void KIM::ModelDriverCreate::GetNumberOfParameterFiles ( int *const  numberOfParameterFiles) const

◆ GetParameterFileName()

int KIM::ModelDriverCreate::GetParameterFileName ( int const  index,
std::string *const  parameterFileName 
) const

◆ LogEntry()

void KIM::ModelDriverCreate::LogEntry ( LogVerbosity const  logVerbosity,
std::string const &  message,
int const  lineNumber,
std::string const &  fileName 
) const

◆ SetArgumentSupportStatus()

int KIM::ModelDriverCreate::SetArgumentSupportStatus ( ArgumentName const  argumentName,
SupportStatus const  supportStatus 
)

◆ SetCallbackSupportStatus()

int KIM::ModelDriverCreate::SetCallbackSupportStatus ( CallbackName const  callbackName,
SupportStatus const  supportStatus 
)

◆ SetComputePointer()

int KIM::ModelDriverCreate::SetComputePointer ( LanguageName const  languageName,
func *const  fptr 
)

◆ SetDestroyPointer()

int KIM::ModelDriverCreate::SetDestroyPointer ( LanguageName const  languageName,
func *const  fptr 
)

◆ SetInfluenceDistancePointer()

void KIM::ModelDriverCreate::SetInfluenceDistancePointer ( double const *const  influenceDistance)

◆ SetModelBufferPointer()

void KIM::ModelDriverCreate::SetModelBufferPointer ( void *const  ptr)

◆ SetModelNumbering()

int KIM::ModelDriverCreate::SetModelNumbering ( Numbering const  numbering)

◆ SetNeighborListCutoffsPointer()

void KIM::ModelDriverCreate::SetNeighborListCutoffsPointer ( int const  numberOfCutoffs,
double const *const  cutoffs 
)

◆ SetParameterPointer() [1/2]

int KIM::ModelDriverCreate::SetParameterPointer ( int const  extent,
int *const  ptr,
std::string const &  description 
)

◆ SetParameterPointer() [2/2]

int KIM::ModelDriverCreate::SetParameterPointer ( int const  extent,
double *const  ptr,
std::string const &  description 
)

◆ SetRefreshPointer()

int KIM::ModelDriverCreate::SetRefreshPointer ( LanguageName const  languageName,
func *const  fptr 
)

◆ SetSpeciesCode()

int KIM::ModelDriverCreate::SetSpeciesCode ( SpeciesName const  speciesName,
int const  code 
)

◆ SetUnits()

int KIM::ModelDriverCreate::SetUnits ( LengthUnit const  lengthUnit,
EnergyUnit const  energyUnit,
ChargeUnit const  chargeUnit,
TemperatureUnit const  temperatureUnit,
TimeUnit const  timeUnit 
)

◆ String()

std::string KIM::ModelDriverCreate::String ( ) const

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