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::ModelComputeArgumentsCreate Class Reference

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

#include <KIM_ModelComputeArgumentsCreate.hpp>

Public Member Functions

int SetArgumentSupportStatus (ComputeArgumentName const computeArgumentName, SupportStatus const supportStatus)
 Set the SupportStatus of a ComputeArgumentName. More...
 
int SetCallbackSupportStatus (ComputeCallbackName const computeCallbackName, SupportStatus const supportStatus)
 Set the SupportStatus of a ComputeCallbackName. More...
 
void SetModelBufferPointer (void *const ptr)
 Set the Model's buffer pointer within the ComputeArguments 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 ComputeArguments object. More...
 

Detailed Description

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

See also
KIM_ModelComputeArgumentsCreate, kim_model_compute_arguments_create_module::kim_model_compute_arguments_create_handle_type
Since
2.0

Definition at line 58 of file KIM_ModelComputeArgumentsCreate.hpp.

Member Function Documentation

◆ LogEntry() [1/2]

void KIM::ModelComputeArgumentsCreate::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_ModelComputeArgumentsCreate_LogEntry, kim_model_compute_arguments_create_module::kim_log_entry
Since
2.0

◆ LogEntry() [2/2]

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

◆ SetArgumentSupportStatus()

int KIM::ModelComputeArgumentsCreate::SetArgumentSupportStatus ( ComputeArgumentName const  computeArgumentName,
SupportStatus const  supportStatus 
)

Set the SupportStatus of a ComputeArgumentName.

Parameters
[in]computeArgumentNameThe ComputeArgumentName of interest.
[in]supportStatusThe corresponding SupportStatus.
Returns
true if computeArgumentName is unknown.
true if computeArgumentName is SUPPORT_STATUS::requiredByAPI and supportStatus is not SUPPORT_STATUS::requiredByAPI.
false otherwise.
See also
KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus, kim_model_compute_arguments_create_module::kim_set_argument_support_status
Since
2.0

◆ SetCallbackSupportStatus()

int KIM::ModelComputeArgumentsCreate::SetCallbackSupportStatus ( ComputeCallbackName const  computeCallbackName,
SupportStatus const  supportStatus 
)

Set the SupportStatus of a ComputeCallbackName.

Parameters
[in]computeCallbackNameThe ComputeCallbackName of interest.
[in]supportStatusThe corresponding SupportStatus.
Returns
true if computeCallbackName is unknown.
true if computeCallbackName is SUPPORT_STATUS::requiredByAPI and supportStatus is not SUPPORT_STATUS::requiredByAPI.
false otherwise.
See also
KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus, kim_model_compute_arguments_create_module::kim_set_callback_support_status
Since
2.0

◆ SetModelBufferPointer()

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

Set the Model's buffer pointer within the ComputeArguments object.

The model buffer pointer may be used by the model to associate a memory buffer with the ComputeArguments object.

Parameters
[in]ptrThe model buffer data pointer.
See also
KIM_ModelComputeArguments_SetModelBufferPointer, kim_model_compute_arguments_create_module::kim_set_model_buffer_pointer
Since
2.0

◆ ToString()

std::string const& KIM::ModelComputeArgumentsCreate::ToString ( ) const

Get a string representing the internal state of the ComputeArguments 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_ModelComputeArgumentsCreate_ToString, kim_model_compute_arguments_create_module::kim_to_string
Since
2.0

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