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

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

typedef struct KIM_Model	KIM_Model
	Forward declaration. More...

typedef struct KIM_ModelCompute	KIM_ModelCompute
	Forward declaration. More...

typedef struct KIM_ModelCreate	KIM_ModelCreate
	Forward declaration. More...

typedef struct KIM_ModelDestroy	KIM_ModelDestroy
	Forward declaration. More...

typedef struct KIM_ModelDriverCreate	KIM_ModelDriverCreate
	Forward declaration. More...

typedef struct KIM_ModelRefresh	KIM_ModelRefresh
	Forward declaration. More...

typedef struct KIM_ModelWriteParameterizedModel	KIM_ModelWriteParameterizedModel
	Forward declaration. More...

typedef struct KIM_ComputeArguments	KIM_ComputeArguments
	Forward declaration. More...

typedef struct KIM_ModelComputeArguments	KIM_ModelComputeArguments
	Forward declaration. More...

typedef struct KIM_ModelComputeArgumentsCreate	KIM_ModelComputeArgumentsCreate
	Forward declaration. More...

typedef struct KIM_ModelComputeArgumentsDestroy	KIM_ModelComputeArgumentsDestroy
	Forward declaration. More...

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

Functions
void	KIM_ModelExtension_GetExtensionID (KIM_ModelExtension const const modelExtension, char const *const extensionID)
	Get the extension identification string. More...

KIM_Model *	KIM_ModelExtension_ToModel (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a Model interface. More...

KIM_ModelCompute *	KIM_ModelExtension_ToModelCompute (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelCompute interface. More...

KIM_ModelCreate *	KIM_ModelExtension_ToModelCreate (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelCreate interface. More...

KIM_ModelDestroy *	KIM_ModelExtension_ToModelDestroy (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelDestroy interface. More...

KIM_ModelDriverCreate *	KIM_ModelExtension_ToModelDriverCreate (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface. More...

KIM_ModelRefresh *	KIM_ModelExtension_ToModelRefresh (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelRefresh interface. More...

KIM_ModelWriteParameterizedModel *	KIM_ModelExtension_ToModelWriteParameterizedModel (KIM_ModelExtension *const modelExtension)
	Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface. More...

KIM_ModelComputeArguments *	KIM_ModelExtension_ToModelComputeArguments (KIM_ModelExtension const const modelExtension, KIM_ComputeArguments const computeArguments)
	Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface. More...

KIM_ModelComputeArgumentsCreate *	KIM_ModelExtension_ToModelComputeArgumentsCreate (KIM_ModelExtension const const modelExtension, KIM_ComputeArguments const computeArguments)
	Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface. More...

KIM_ModelComputeArgumentsDestroy *	KIM_ModelExtension_ToModelComputeArgumentsDestroy (KIM_ModelExtension const const modelExtension, KIM_ComputeArguments const computeArguments)
	Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface. More...

void	KIM_ModelExtension_GetModelBufferPointer (KIM_ModelExtension const const modelCompute, void *const ptr)
	Get the Model's buffer pointer within the Model object. More...

void	KIM_ModelExtension_LogEntry (KIM_ModelExtension const const modelCompute, 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_ModelExtension_ToString (KIM_ModelExtension const *const modelCompute)
	Get a string representing the internal state of the Model object. More...

Typedef Documentation

◆ KIM_ComputeArguments

typedef struct KIM_ComputeArguments KIM_ComputeArguments

Forward declaration.

Since: 2.0

Definition at line 123 of file KIM_ModelExtension.h.

◆ KIM_LogVerbosity

typedef struct KIM_LogVerbosity KIM_LogVerbosity

Forward declaration.

Since: 2.0

Definition at line 42 of file KIM_ModelExtension.h.

◆ KIM_Model

typedef struct KIM_Model KIM_Model

Forward declaration.

Since: 2.0

Definition at line 52 of file KIM_ModelExtension.h.

◆ KIM_ModelCompute

typedef struct KIM_ModelCompute KIM_ModelCompute

Forward declaration.

Since: 2.0

Definition at line 62 of file KIM_ModelExtension.h.

◆ KIM_ModelComputeArguments

typedef struct KIM_ModelComputeArguments KIM_ModelComputeArguments

Forward declaration.

Since: 2.0

Definition at line 133 of file KIM_ModelExtension.h.

◆ KIM_ModelComputeArgumentsCreate

typedef struct KIM_ModelComputeArgumentsCreate KIM_ModelComputeArgumentsCreate

Forward declaration.

Since: 2.0

Definition at line 143 of file KIM_ModelExtension.h.

◆ KIM_ModelComputeArgumentsDestroy

typedef struct KIM_ModelComputeArgumentsDestroy KIM_ModelComputeArgumentsDestroy

Forward declaration.

Since: 2.0

Definition at line 153 of file KIM_ModelExtension.h.

◆ KIM_ModelCreate

typedef struct KIM_ModelCreate KIM_ModelCreate

Forward declaration.

Since: 2.0

Definition at line 72 of file KIM_ModelExtension.h.

◆ KIM_ModelDestroy

typedef struct KIM_ModelDestroy KIM_ModelDestroy

Forward declaration.

Since: 2.0

Definition at line 82 of file KIM_ModelExtension.h.

◆ KIM_ModelDriverCreate

typedef struct KIM_ModelDriverCreate KIM_ModelDriverCreate

Forward declaration.

Since: 2.0

Definition at line 92 of file KIM_ModelExtension.h.

◆ KIM_ModelExtension

typedef struct KIM_ModelExtension KIM_ModelExtension

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

See also: KIM::ModelExtension, kim_model_extension_module::kim_model_extension_handle_type

Since: 2.0

Definition at line 168 of file KIM_ModelExtension.h.

◆ KIM_ModelRefresh

typedef struct KIM_ModelRefresh KIM_ModelRefresh

Forward declaration.

Since: 2.0

Definition at line 102 of file KIM_ModelExtension.h.

◆ KIM_ModelWriteParameterizedModel

typedef struct KIM_ModelWriteParameterizedModel KIM_ModelWriteParameterizedModel

Forward declaration.

Since: 2.0

Definition at line 112 of file KIM_ModelExtension.h.

Function Documentation

◆ KIM_ModelExtension_GetExtensionID()

void KIM_ModelExtension_GetExtensionID	(	KIM_ModelExtension const *const	modelExtension,
		char const **const	extensionID
	)

Get the extension identification string.

See also: KIM::ModelExtension::GetExtensionID, kim_model_extension_module::kim_get_extension_id

Since: 2.0

◆ KIM_ModelExtension_GetModelBufferPointer()

void KIM_ModelExtension_GetModelBufferPointer	(	KIM_ModelExtension const *const	modelCompute,
		void **const	ptr
	)

Get the Model's buffer pointer within the Model object.

See also: KIM::ModelExtension::GetModelBufferPointer, kim_model_extension_module::kim_get_model_buffer_pointer

Since: 2.0

◆ KIM_ModelExtension_LogEntry()

void KIM_ModelExtension_LogEntry	(	KIM_ModelExtension const *const	modelCompute,
		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::ModelExtension::LogEntry, kim_model_extension_module::kim_log_entry

Since: 2.0

◆ KIM_ModelExtension_ToModel()

KIM_Model* KIM_ModelExtension_ToModel ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a Model interface.

See also: KIM::ModelExtension::Model, kim_model_extension_module::kim_to_model

Since: 2.0

◆ KIM_ModelExtension_ToModelCompute()

KIM_ModelCompute* KIM_ModelExtension_ToModelCompute ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelCompute interface.

See also: KIM::ModelExtension::ModelCompute, kim_model_extension_module::kim_to_model_compute

Since: 2.0

◆ KIM_ModelExtension_ToModelComputeArguments()

KIM_ModelComputeArguments* KIM_ModelExtension_ToModelComputeArguments	(	KIM_ModelExtension const *const	modelExtension,
		KIM_ComputeArguments *const	computeArguments
	)

Convert the ModelExtension interface to the Model object to a ModelComputeArguments interface.

See also: KIM::ModelExtension::ModelComputeArguments, kim_model_extension_module::kim_to_model_compute_arguments

Since: 2.0

◆ KIM_ModelExtension_ToModelComputeArgumentsCreate()

KIM_ModelComputeArgumentsCreate* KIM_ModelExtension_ToModelComputeArgumentsCreate	(	KIM_ModelExtension const *const	modelExtension,
		KIM_ComputeArguments *const	computeArguments
	)

Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsCreate interface.

See also: KIM::ModelExtension::ModelComputeArgumentsCreate, kim_model_extension_module::kim_to_model_compute_arguments_create

Since: 2.0

◆ KIM_ModelExtension_ToModelComputeArgumentsDestroy()

KIM_ModelComputeArgumentsDestroy* KIM_ModelExtension_ToModelComputeArgumentsDestroy	(	KIM_ModelExtension const *const	modelExtension,
		KIM_ComputeArguments *const	computeArguments
	)

Convert the ModelExtension interface to the Model object to a ModelComputeArgumentsDestroy interface.

See also: KIM::ModelExtension::ModelComputeArgumentsDestroy, kim_model_extension_module::kim_to_model_compute_arguments_destroy

Since: 2.0

◆ KIM_ModelExtension_ToModelCreate()

KIM_ModelCreate* KIM_ModelExtension_ToModelCreate ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelCreate interface.

See also: KIM::ModelExtension::ModelCreate, kim_model_extension_module::kim_to_model_create

Since: 2.0

◆ KIM_ModelExtension_ToModelDestroy()

KIM_ModelDestroy* KIM_ModelExtension_ToModelDestroy ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelDestroy interface.

See also: KIM::ModelExtension::ModelDestroy, kim_model_extension_module::kim_to_model_destroy

Since: 2.0

◆ KIM_ModelExtension_ToModelDriverCreate()

KIM_ModelDriverCreate* KIM_ModelExtension_ToModelDriverCreate ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelDriverCreate interface.

See also: KIM::ModelExtension::ModelDriverCreate, kim_model_extension_module::kim_to_model_driver_create

Since: 2.0

◆ KIM_ModelExtension_ToModelRefresh()

KIM_ModelRefresh* KIM_ModelExtension_ToModelRefresh ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelRefresh interface.

See also: KIM::ModelExtension::ModelRefresh, kim_model_extension_module::kim_to_model_refresh

Since: 2.0

◆ KIM_ModelExtension_ToModelWriteParameterizedModel()

KIM_ModelWriteParameterizedModel* KIM_ModelExtension_ToModelWriteParameterizedModel ( KIM_ModelExtension *const modelExtension )

Convert the ModelExtension interface to the Model object to a ModelWriteParameterizedModel interface.

See also: KIM::ModelExtension::ModelWriteParameterizedModel, kim_model_extension_module::kim_to_model_write_parameterized_model

Since: 2.0

◆ KIM_ModelExtension_ToString()

char const* KIM_ModelExtension_ToString ( KIM_ModelExtension const *const modelCompute )

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

See also: KIM::ModelExtension::ToString, kim_model_extension_module::kim_to_string

Since: 2.0

Typedefs

Functions

Typedef Documentation

◆ KIM_ComputeArguments

◆ KIM_LogVerbosity

◆ KIM_Model

◆ KIM_ModelCompute

◆ KIM_ModelComputeArguments

◆ KIM_ModelComputeArgumentsCreate

◆ KIM_ModelComputeArgumentsDestroy

◆ KIM_ModelCreate

◆ KIM_ModelDestroy

◆ KIM_ModelDriverCreate

◆ KIM_ModelExtension

◆ KIM_ModelRefresh

◆ KIM_ModelWriteParameterizedModel

Function Documentation

◆ KIM_ModelExtension_GetExtensionID()

◆ KIM_ModelExtension_GetModelBufferPointer()

◆ KIM_ModelExtension_LogEntry()

◆ KIM_ModelExtension_ToModel()

◆ KIM_ModelExtension_ToModelCompute()

◆ KIM_ModelExtension_ToModelComputeArguments()

◆ KIM_ModelExtension_ToModelComputeArgumentsCreate()

◆ KIM_ModelExtension_ToModelComputeArgumentsDestroy()

◆ KIM_ModelExtension_ToModelCreate()

◆ KIM_ModelExtension_ToModelDestroy()

◆ KIM_ModelExtension_ToModelDriverCreate()

◆ KIM_ModelExtension_ToModelRefresh()

◆ KIM_ModelExtension_ToModelWriteParameterizedModel()

◆ KIM_ModelExtension_ToString()