kim-api
2.3.1-git+v2.3.0-git-2-g378406f9.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Extension routine. More...
#include <KIM_ModelExtension.hpp>
Public Member Functions | |
void | GetExtensionID (std::string const **const extensionID) const |
Get the extension identification string. More... | |
KIM::Model * | Model () |
Convert the ModelExtension interface to the Model object to a Model interface. More... | |
KIM::ModelCompute * | ModelCompute () |
Convert the ModelExtension interface to the Model object to a ModelCompute interface. More... | |
KIM::ModelCreate * | ModelCreate () |
Convert the ModelExtension interface to the Model object to a ModelCreate interface. More... | |
KIM::ModelDestroy * | ModelDestroy () |
Convert the ModelExtension interface to the Model object to a ModelDestroy interface. More... | |
KIM::ModelDriverCreate * | ModelDriverCreate () |
Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface. More... | |
KIM::ModelRefresh * | ModelRefresh () |
Convert the ModelExtension interface to the Model object to a ModelRefresh interface. More... | |
KIM::ModelWriteParameterizedModel * | ModelWriteParameterizedModel () |
Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface. More... | |
KIM::ModelComputeArguments * | ModelComputeArguments (ComputeArguments *const computeArguments) const |
Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface. More... | |
KIM::ModelComputeArgumentsCreate * | ModelComputeArgumentsCreate (ComputeArguments *const computeArguments) const |
Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface. More... | |
KIM::ModelComputeArgumentsDestroy * | ModelComputeArgumentsDestroy (ComputeArguments *const computeArguments) const |
Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface. More... | |
void | GetModelBufferPointer (void **const ptr) const |
Get the Model's buffer pointer within the Model object. More... | |
void | LogEntry (LogVerbosity const logVerbosity, std::string const &message, int const lineNumber, std::string const &fileName) const |
Write a log entry into the log file. More... | |
void | LogEntry (LogVerbosity const logVerbosity, std::stringstream const &message, int const lineNumber, std::string const &fileName) const |
std::string const & | ToString () const |
Get a string representing the internal state of the Model object. More... | |
Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Extension routine.
Definition at line 62 of file KIM_ModelExtension.hpp.
void KIM::ModelExtension::GetExtensionID | ( | std::string const **const | extensionID | ) | const |
Get the extension identification string.
[out] | extensionID | The extension identification string. |
void KIM::ModelExtension::GetModelBufferPointer | ( | void **const | ptr | ) | const |
Get the Model's buffer pointer within the Model object.
The model buffer pointer may be used by the Model to associate a memory buffer with the Model object.
[out] | ptr | The model buffer data pointer. |
ptr == NULL
if the model has not previously called ModelCreate::SetModelBufferPointer or ModelDriverCreate::SetModelBufferPointer.void KIM::ModelExtension::LogEntry | ( | LogVerbosity const | logVerbosity, |
std::string const & | message, | ||
int const | lineNumber, | ||
std::string const & | fileName | ||
) | const |
Write a log entry into the log file.
This results in a no-op if logVerbosity
is LOG_VERBOSITY::silent or if logVerbosity
is greater-than the Log object's top LogVerbosity on its stack.
[in] | logVerbosity | The LogVerbosity level for the entry. |
[in] | message | The body text of the log entry. |
[in] | lineNumber | The source code file line number. |
[in] | fileName | The source code file name. |
void KIM::ModelExtension::LogEntry | ( | LogVerbosity const | logVerbosity, |
std::stringstream const & | message, | ||
int const | lineNumber, | ||
std::string const & | fileName | ||
) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
KIM::Model* KIM::ModelExtension::Model | ( | ) |
Convert the ModelExtension interface to the Model object to a Model interface.
KIM::ModelCompute* KIM::ModelExtension::ModelCompute | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelCompute interface.
KIM::ModelComputeArguments* KIM::ModelExtension::ModelComputeArguments | ( | ComputeArguments *const | computeArguments | ) | const |
Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface.
KIM::ModelComputeArgumentsCreate* KIM::ModelExtension::ModelComputeArgumentsCreate | ( | ComputeArguments *const | computeArguments | ) | const |
Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface.
KIM::ModelComputeArgumentsDestroy* KIM::ModelExtension::ModelComputeArgumentsDestroy | ( | ComputeArguments *const | computeArguments | ) | const |
Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface.
KIM::ModelCreate* KIM::ModelExtension::ModelCreate | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelCreate interface.
KIM::ModelDestroy* KIM::ModelExtension::ModelDestroy | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelDestroy interface.
KIM::ModelDriverCreate* KIM::ModelExtension::ModelDriverCreate | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface.
KIM::ModelRefresh* KIM::ModelExtension::ModelRefresh | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelRefresh interface.
KIM::ModelWriteParameterizedModel* KIM::ModelExtension::ModelWriteParameterizedModel | ( | ) |
Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface.
std::string const& KIM::ModelExtension::ToString | ( | ) | const |
Get a string representing the internal state of the Model object.
This string is primarily meant for use as a debugging tool. The string may be quite long. It begins and ends with lines consisting only of ='s
.