kim-api  2.1.4-git+v2.1.3-git-1-g7847914a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Public Member Functions | List of all members
KIM::ModelCompute Class Reference

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Compute routine. More...

#include <KIM_ModelCompute.hpp>

Public Member Functions

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...
 

Detailed Description

Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::Compute routine.

See also
KIM_ModelCompute, kim_model_compute_module::kim_model_compute_handle_type
Since
2.0

Definition at line 54 of file KIM_ModelCompute.hpp.

Member Function Documentation

◆ GetModelBufferPointer()

void KIM::ModelCompute::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.

Parameters
[out]ptrThe model buffer data pointer.
Note
ptr == NULL if the model has not previously called ModelCreate::SetModelBufferPointer or ModelDriverCreate::SetModelBufferPointer.
See also
KIM_ModelCompute_GetModelBufferPointer, kim_model_compute_module::kim_get_model_buffer_pointer
Since
2.0

◆ LogEntry() [1/2]

void KIM::ModelCompute::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.

Parameters
[in]logVerbosityThe LogVerbosity level for the entry.
[in]messageThe body text of the log entry.
[in]lineNumberThe source code file line number.
[in]fileNameThe source code file name.
See also
KIM_ModelCompute_LogEntry, kim_model_compute_module::kim_log_entry
Since
2.0

◆ LogEntry() [2/2]

void KIM::ModelCompute::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.

◆ ToString()

std::string const& KIM::ModelCompute::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.

See also
KIM_ModelCompute_ToString, kim_model_compute_module::kim_to_string
Since
2.0

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