#include "KIM_FunctionTypes.h"

Include dependency graph for KIM_ComputeArguments.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct KIM_LogVerbosity	KIM_LogVerbosity
	Forward declaration. More...

typedef struct KIM_LanguageName	KIM_LanguageName
	Forward declaration. More...

typedef struct KIM_ComputeArgumentName	KIM_ComputeArgumentName
	Forward declaration. More...

typedef struct KIM_ComputeCallbackName	KIM_ComputeCallbackName
	Forward declaration. More...

typedef struct KIM_SupportStatus	KIM_SupportStatus
	Forward declaration. More...

typedef struct KIM_ComputeArguments	KIM_ComputeArguments
	Provides the primary interface to a KIM API ComputeArguments object and is meant to be used by simulators. More...

Functions
int	KIM_ComputeArguments_GetArgumentSupportStatus (KIM_ComputeArguments const const computeArguments, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus const supportStatus)
	Get the SupportStatus of a ComputeArgumentName. More...

int	KIM_ComputeArguments_GetCallbackSupportStatus (KIM_ComputeArguments const const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus const supportStatus)
	Get the SupportStatus of a ComputeCallbackName. More...

int	KIM_ComputeArguments_SetArgumentPointerInteger (KIM_ComputeArguments const computeArguments, KIM_ComputeArgumentName const computeArgumentName, int const const ptr)
	Set the data pointer for a ComputeArgumentName. More...

int	KIM_ComputeArguments_SetArgumentPointerDouble (KIM_ComputeArguments const computeArguments, KIM_ComputeArgumentName const computeArgumentName, double const const ptr)
	Set the data pointer for a ComputeArgumentName. More...

int	KIM_ComputeArguments_SetCallbackPointer (KIM_ComputeArguments const computeArguments, KIM_ComputeCallbackName const computeCallbackName, KIM_LanguageName const languageName, KIM_Function const fptr, void *const dataObject)
	Set the function pointer for a ComputeCallbackName. More...

void	KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent (KIM_ComputeArguments const const computeArguments, int const result)
	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	KIM_ComputeArguments_SetSimulatorBufferPointer (KIM_ComputeArguments const computeArguments, void const ptr)
	Set the Simulator's buffer pointer within the ComputeArguments object. More...

void	KIM_ComputeArguments_GetSimulatorBufferPointer (KIM_ComputeArguments const const computeArguments, void *const ptr)
	Get the Simulator's buffer pointer from the ComputeArguments object. More...

char const *	KIM_ComputeArguments_ToString (KIM_ComputeArguments const *const computeArguments)
	Get a string representing the internal state of the ComputeArguments object. More...

void	KIM_ComputeArguments_SetLogID (KIM_ComputeArguments const computeArguments, char const const logID)
	Set the identity of the Log object associated with the ComputeArguments object. More...

void	KIM_ComputeArguments_PushLogVerbosity (KIM_ComputeArguments *const computeArguments, KIM_LogVerbosity const logVerbosity)
	Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack. More...

void	KIM_ComputeArguments_PopLogVerbosity (KIM_ComputeArguments *const computeArguments)
	Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack. More...

Typedef Documentation

◆ KIM_ComputeArgumentName

typedef struct KIM_ComputeArgumentName KIM_ComputeArgumentName

Forward declaration.

Since: 2.0

Definition at line 66 of file KIM_ComputeArguments.h.

◆ KIM_ComputeArguments

typedef struct KIM_ComputeArguments KIM_ComputeArguments

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 100 of file KIM_ComputeArguments.h.

◆ KIM_ComputeCallbackName

typedef struct KIM_ComputeCallbackName KIM_ComputeCallbackName

Forward declaration.

Since: 2.0

Definition at line 76 of file KIM_ComputeArguments.h.

◆ KIM_LanguageName

typedef struct KIM_LanguageName KIM_LanguageName

Forward declaration.

Since: 2.0

Definition at line 56 of file KIM_ComputeArguments.h.

◆ KIM_LogVerbosity

typedef struct KIM_LogVerbosity KIM_LogVerbosity

Forward declaration.

Since: 2.0

Definition at line 46 of file KIM_ComputeArguments.h.

◆ KIM_SupportStatus

typedef struct KIM_SupportStatus KIM_SupportStatus

Forward declaration.

Since: 2.0

Definition at line 86 of file KIM_ComputeArguments.h.

Function Documentation

◆ KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent()

void KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent	(	KIM_ComputeArguments const *const	computeArguments,
		int *const	result
	)

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.

See also: KIM::ComputeArguments::AreAllRequiredArgumentsAndCallbacksPresent, kim_compute_arguments_module::kim_are_all_required_present

Since: 2.0

◆ KIM_ComputeArguments_GetArgumentSupportStatus()

int KIM_ComputeArguments_GetArgumentSupportStatus	(	KIM_ComputeArguments const *const	computeArguments,
		KIM_ComputeArgumentName const	computeArgumentName,
		KIM_SupportStatus *const	supportStatus
	)

Get the SupportStatus of a ComputeArgumentName.

See also: KIM::ComputeArguments::GetArgumentSupportStatus, kim_compute_arguments_module::kim_get_argument_support_status

Since: 2.0

◆ KIM_ComputeArguments_GetCallbackSupportStatus()

int KIM_ComputeArguments_GetCallbackSupportStatus	(	KIM_ComputeArguments const *const	computeArguments,
		KIM_ComputeCallbackName const	computeCallbackName,
		KIM_SupportStatus *const	supportStatus
	)

Get the SupportStatus of a ComputeCallbackName.

See also: KIM::ComputeArguments::GetCallbackSupportStatus, kim_compute_arguments_module::kim_get_callback_support_status

Since: 2.0

◆ KIM_ComputeArguments_GetSimulatorBufferPointer()

void KIM_ComputeArguments_GetSimulatorBufferPointer	(	KIM_ComputeArguments const *const	computeArguments,
		void **const	ptr
	)

Get the Simulator's buffer pointer from the ComputeArguments object.

See also: KIM::ComputeArguments::GetSimulatorBufferPointer, kim_compute_arguments_module::kim_get_simulator_buffer_pointer

Since: 2.0

◆ KIM_ComputeArguments_PopLogVerbosity()

void KIM_ComputeArguments_PopLogVerbosity ( KIM_ComputeArguments *const computeArguments )

Pop a LogVerbosity from the ComputeArguments object's Log object verbosity stack.

See also: KIM::ComputeArguments::PopLogVerbosity, kim_compute_arguments_module::kim_pop_log_verbosity

Since: 2.0

◆ KIM_ComputeArguments_PushLogVerbosity()

void KIM_ComputeArguments_PushLogVerbosity	(	KIM_ComputeArguments *const	computeArguments,
		KIM_LogVerbosity const	logVerbosity
	)

Push a new LogVerbosity onto the ComputeArguments object's Log object verbosity stack.

See also: KIM::ComputeArguments::PushLogVerbosity, kim_compute_arguments_module::kim_push_log_verbosity

Since: 2.0

◆ KIM_ComputeArguments_SetArgumentPointerDouble()

int KIM_ComputeArguments_SetArgumentPointerDouble	(	KIM_ComputeArguments *const	computeArguments,
		KIM_ComputeArgumentName const	computeArgumentName,
		double const *const	ptr
	)

Set the data pointer for a ComputeArgumentName.

See also: KIM::ComputeArguments::SetArgumentPointer, kim_compute_arguments_module::kim_set_argument_pointer

Since: 2.0

◆ KIM_ComputeArguments_SetArgumentPointerInteger()

int KIM_ComputeArguments_SetArgumentPointerInteger	(	KIM_ComputeArguments *const	computeArguments,
		KIM_ComputeArgumentName const	computeArgumentName,
		int const *const	ptr
	)

Set the data pointer for a ComputeArgumentName.

See also: KIM::ComputeArguments::SetArgumentPointer, kim_compute_arguments_module::kim_set_argument_pointer

Since: 2.0

◆ KIM_ComputeArguments_SetCallbackPointer()

int KIM_ComputeArguments_SetCallbackPointer	(	KIM_ComputeArguments *const	computeArguments,
		KIM_ComputeCallbackName const	computeCallbackName,
		KIM_LanguageName const	languageName,
		KIM_Function *const	fptr,
		void *const	dataObject
	)

Set the function pointer for a ComputeCallbackName.

See also: KIM::ComputeArguments::SetCallbackPointer, kim_compute_arguments_module::kim_set_callback_pointer

Since: 2.0

◆ KIM_ComputeArguments_SetLogID()

void KIM_ComputeArguments_SetLogID	(	KIM_ComputeArguments *const	computeArguments,
		char const *const	logID
	)

Set the identity of the Log object associated with the ComputeArguments object.

See also: KIM::ComputeArguments::SetLogID, kim_compute_arguments_module::kim_set_log_id

Since: 2.0

◆ KIM_ComputeArguments_SetSimulatorBufferPointer()

void KIM_ComputeArguments_SetSimulatorBufferPointer	(	KIM_ComputeArguments *const	computeArguments,
		void *const	ptr
	)

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

See also: KIM::ComputeArguments::SetSimulatorBufferPointer, kim_compute_arguments_module::kim_set_simulator_buffer_pointer

Since: 2.0

◆ KIM_ComputeArguments_ToString()

char const* KIM_ComputeArguments_ToString ( KIM_ComputeArguments const *const computeArguments )

Get a string representing the internal state of the ComputeArguments object.

See also: KIM::ComputeArguments::ToString, kim_compute_arguments_module::kim_to_string

Since: 2.0

Typedefs

Functions

Typedef Documentation

◆ KIM_ComputeArgumentName

◆ KIM_ComputeArguments

◆ KIM_ComputeCallbackName

◆ KIM_LanguageName

◆ KIM_LogVerbosity

◆ KIM_SupportStatus

Function Documentation

◆ KIM_ComputeArguments_AreAllRequiredArgumentsAndCallbacksPresent()

◆ KIM_ComputeArguments_GetArgumentSupportStatus()

◆ KIM_ComputeArguments_GetCallbackSupportStatus()

◆ KIM_ComputeArguments_GetSimulatorBufferPointer()

◆ KIM_ComputeArguments_PopLogVerbosity()

◆ KIM_ComputeArguments_PushLogVerbosity()

◆ KIM_ComputeArguments_SetArgumentPointerDouble()

◆ KIM_ComputeArguments_SetArgumentPointerInteger()

◆ KIM_ComputeArguments_SetCallbackPointer()

◆ KIM_ComputeArguments_SetLogID()

◆ KIM_ComputeArguments_SetSimulatorBufferPointer()

◆ KIM_ComputeArguments_ToString()