Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators.
More...
#include <KIM_ComputeArguments.hpp>
|
int | GetArgumentSupportStatus (ComputeArgumentName const computeArgumentName, SupportStatus *const supportStatus) const |
| Get the SupportStatus of a ComputeArgumentName. More...
|
|
int | GetCallbackSupportStatus (ComputeCallbackName const computeCallbackName, SupportStatus *const supportStatus) const |
| Get the SupportStatus of a ComputeCallbackName. More...
|
|
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, int const *const ptr) |
| Set the data pointer for a ComputeArgumentName. More...
|
|
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, int *const ptr) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
|
|
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, double const *const ptr) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
|
|
int | SetArgumentPointer (ComputeArgumentName const computeArgumentName, double *const ptr) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
|
|
int | SetCallbackPointer (ComputeCallbackName const computeCallbackName, LanguageName const languageName, Function *const fptr, void *const dataObject) |
| Set the function pointer for a ComputeCallbackName. More...
|
|
void | AreAllRequiredArgumentsAndCallbacksPresent (int *const result) const |
| Determine if non-NULL pointers have been set for all ComputeArgumentName's and ComputeCallbackName's with SupportStatus values of SUPPORT_STATUS::requiredByAPI or SUPPORT_STATUS::required. More...
|
|
void | SetSimulatorBufferPointer (void *const ptr) |
| Set the Simulator's buffer pointer within the ComputeArguments object. More...
|
|
void | GetSimulatorBufferPointer (void **const ptr) const |
| Get the Simulator's buffer pointer from the ComputeArguments object. More...
|
|
std::string const & | ToString () const |
| Get a string representing the internal state of the ComputeArguments object. More...
|
|
void | SetLogID (std::string const &logID) |
| Set the identity of the Log object associated with the ComputeArguments object. More...
|
|
void | PushLogVerbosity (LogVerbosity const logVerbosity) |
| Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack. More...
|
|
void | PopLogVerbosity () |
| Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack. More...
|
|
Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators.
- See also
- KIM_ComputeArguments, kim_compute_arguments_module::kim_compute_arguments_handle_type
- Since
- 2.0
Definition at line 58 of file KIM_ComputeArguments.hpp.
◆ AreAllRequiredArgumentsAndCallbacksPresent()
void KIM::ComputeArguments::AreAllRequiredArgumentsAndCallbacksPresent |
( |
int *const |
result | ) |
const |
◆ GetArgumentSupportStatus()
◆ GetCallbackSupportStatus()
◆ GetSimulatorBufferPointer()
void KIM::ComputeArguments::GetSimulatorBufferPointer |
( |
void **const |
ptr | ) |
const |
◆ PopLogVerbosity()
void KIM::ComputeArguments::PopLogVerbosity |
( |
| ) |
|
◆ PushLogVerbosity()
void KIM::ComputeArguments::PushLogVerbosity |
( |
LogVerbosity const |
logVerbosity | ) |
|
◆ SetArgumentPointer() [1/4]
int KIM::ComputeArguments::SetArgumentPointer |
( |
ComputeArgumentName const |
computeArgumentName, |
|
|
double *const |
ptr |
|
) |
| |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ SetArgumentPointer() [2/4]
int KIM::ComputeArguments::SetArgumentPointer |
( |
ComputeArgumentName const |
computeArgumentName, |
|
|
double const *const |
ptr |
|
) |
| |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ SetArgumentPointer() [3/4]
int KIM::ComputeArguments::SetArgumentPointer |
( |
ComputeArgumentName const |
computeArgumentName, |
|
|
int *const |
ptr |
|
) |
| |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
◆ SetArgumentPointer() [4/4]
int KIM::ComputeArguments::SetArgumentPointer |
( |
ComputeArgumentName const |
computeArgumentName, |
|
|
int const *const |
ptr |
|
) |
| |
◆ SetCallbackPointer()
◆ SetLogID()
void KIM::ComputeArguments::SetLogID |
( |
std::string const & |
logID | ) |
|
◆ SetSimulatorBufferPointer()
void KIM::ComputeArguments::SetSimulatorBufferPointer |
( |
void *const |
ptr | ) |
|
◆ ToString()
std::string const & KIM::ComputeArguments::ToString |
( |
| ) |
const |
◆ ModelImplementation
friend class ModelImplementation |
|
friend |
The documentation for this class was generated from the following file: