KIM_ModelComputeArgumentsCreate.h File Reference

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

Go to the source code of this file.

Typedefs
typedef struct KIM_LogVerbosity	KIM_LogVerbosity
	Forward declaration. More...
typedef struct KIM_SupportStatus	KIM_SupportStatus
	Forward declaration. More...
typedef struct KIM_ComputeArgumentName	KIM_ComputeArgumentName
	Forward declaration. More...
typedef struct KIM_ComputeCallbackName	KIM_ComputeCallbackName
	Forward declaration. More...
typedef struct KIM_ModelComputeArgumentsCreate	KIM_ModelComputeArgumentsCreate
	Provides the interface to a KIM API ComputeArguments object for use by models within their MODEL_ROUTINE_NAME::ComputeArgumentsCreate routine. More...

Functions
int	KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus (KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeArgumentName const computeArgumentName, KIM_SupportStatus const supportStatus)
	Set the SupportStatus of a ComputeArgumentName. More...
int	KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus (KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, KIM_ComputeCallbackName const computeCallbackName, KIM_SupportStatus const supportStatus)
	Set the SupportStatus of a ComputeCallbackName. More...
void	KIM_ModelComputeArgumentsCreate_SetModelBufferPointer (KIM_ModelComputeArgumentsCreate *const modelComputeArgumentsCreate, void *const ptr)
	Set the Model's buffer pointer within the ComputeArguments object. More...
void	KIM_ModelComputeArgumentsCreate_LogEntry (KIM_ModelComputeArgumentsCreate const *const modelComputeArgumentsCreate, KIM_LogVerbosity const logVerbosity, char const *const message, int const lineNumber, char const *const fileName)
	Write a log entry into the log file. More...
char const *	KIM_ModelComputeArgumentsCreate_ToString (KIM_ModelComputeArgumentsCreate const *const modelComputeArgumentsCreate)
	Get a string representing the internal state of the ComputeArguments object. More...

Typedef Documentation

KIM_ComputeArgumentName

typedef struct KIM_ComputeArgumentName KIM_ComputeArgumentName

Forward declaration.

Since

2.0

Definition at line 62 of file KIM_ModelComputeArgumentsCreate.h.

KIM_ComputeCallbackName

typedef struct KIM_ComputeCallbackName KIM_ComputeCallbackName

Forward declaration.

Since

2.0

Definition at line 72 of file KIM_ModelComputeArgumentsCreate.h.

KIM_LogVerbosity

typedef struct KIM_LogVerbosity KIM_LogVerbosity

Forward declaration.

Since

2.0

Definition at line 42 of file KIM_ModelComputeArgumentsCreate.h.

KIM_ModelComputeArgumentsCreate

typedef struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate

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 87 of file KIM_ModelComputeArgumentsCreate.h.

KIM_SupportStatus

typedef struct KIM_SupportStatus KIM_SupportStatus

Forward declaration.

Since

2.0

Definition at line 52 of file KIM_ModelComputeArgumentsCreate.h.

Function Documentation

KIM_ModelComputeArgumentsCreate_LogEntry()

void KIM_ModelComputeArgumentsCreate_LogEntry	(	KIM_ModelComputeArgumentsCreate const *const	modelComputeArgumentsCreate,
		KIM_LogVerbosity const	logVerbosity,
		char const *const	message,
		int const	lineNumber,
		char const *const	fileName
	)

Write a log entry into the log file.

See also

KIM::ModelComputeArgumentsCreate::LogEntry, kim_model_compute_arguments_module::kim_log_entry

Since

2.0

KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus()

int KIM_ModelComputeArgumentsCreate_SetArgumentSupportStatus	(	KIM_ModelComputeArgumentsCreate *const	modelComputeArgumentsCreate,
		KIM_ComputeArgumentName const	computeArgumentName,
		KIM_SupportStatus const	supportStatus
	)

Set the SupportStatus of a ComputeArgumentName.

See also

KIM::ModelComputeArgumentsCreate::SetArgumentSupportStatus, kim_model_compute_arguments_create_module::kim_set_argument_support_status

Since

2.0

KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus()

int KIM_ModelComputeArgumentsCreate_SetCallbackSupportStatus	(	KIM_ModelComputeArgumentsCreate *const	modelComputeArgumentsCreate,
		KIM_ComputeCallbackName const	computeCallbackName,
		KIM_SupportStatus const	supportStatus
	)

Set the SupportStatus of a ComputeCallbackName.

See also

KIM::ModelComputeArgumentsCreate::SetCallbackSupportStatus, kim_model_compute_arguments_create_module::kim_set_callback_support_status

Since

2.0

KIM_ModelComputeArgumentsCreate_SetModelBufferPointer()

void KIM_ModelComputeArgumentsCreate_SetModelBufferPointer	(	KIM_ModelComputeArgumentsCreate *const	modelComputeArgumentsCreate,
		void *const	ptr
	)

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

See also

KIM::ModelComputeArgumentsCreate::SetModelBufferPointer, kim_model_compute_arguments_module::kim_set_model_buffer_pointer

Since

2.0

KIM_ModelComputeArgumentsCreate_ToString()

char const* KIM_ModelComputeArgumentsCreate_ToString

(

KIM_ModelComputeArgumentsCreate const *const

modelComputeArgumentsCreate

)

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

See also

KIM::ModelComputeArgumentsCreate::ToString, kim_model_compute_arguments_module::kim_to_string

Since

2.0