kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Typedefs | Functions
KIM_ModelWriteParameterizedModel.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_ModelWriteParameterizedModel KIM_ModelWriteParameterizedModel
 Provides the interface to a KIM API Model object for use by models within their MODEL_ROUTINE_NAME::WriteParameterizedModel routine. More...
 

Functions

void KIM_ModelWriteParameterizedModel_GetPath (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const path)
 Get the directory path where the parameterized model files should be written. More...
 
void KIM_ModelWriteParameterizedModel_GetModelName (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const **const modelName)
 Get the name of the new parameterized model. More...
 
void KIM_ModelWriteParameterizedModel_SetParameterFileName (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, char const *const fileName)
 Set the file name for the next parameter file. More...
 
void KIM_ModelWriteParameterizedModel_GetModelBufferPointer (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, void **const ptr)
 Get the Model's buffer pointer within the Model object. More...
 
void KIM_ModelWriteParameterizedModel_LogEntry (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel, 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_ModelWriteParameterizedModel_ToString (KIM_ModelWriteParameterizedModel const *const modelWriteParameterizedModel)
 Get a string representing the internal state of the Model object. More...
 

Typedef Documentation

◆ KIM_LogVerbosity

Forward declaration.

Since
2.0

Definition at line 47 of file KIM_ModelWriteParameterizedModel.h.

◆ KIM_ModelWriteParameterizedModel

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

See also
KIM::ModelWriteParameterizedModel, kim_model_write_parameterized_model_module::kim_model_write_parameterized_model_handle_type
Since
2.0

Definition at line 62 of file KIM_ModelWriteParameterizedModel.h.

Function Documentation

◆ KIM_ModelWriteParameterizedModel_GetModelBufferPointer()

void KIM_ModelWriteParameterizedModel_GetModelBufferPointer ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel,
void **const  ptr 
)

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

See also
KIM::ModelWriteParameterizedModel::GetModelBufferPointer, kim_model_write_parameterized_model_module::kim_get_model_buffer_pointer
Since
2.0

◆ KIM_ModelWriteParameterizedModel_GetModelName()

void KIM_ModelWriteParameterizedModel_GetModelName ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel,
char const **const  modelName 
)

Get the name of the new parameterized model.

See also
KIM::ModelWriteParameterizedModel::GetModelName, kim_model_write_parameterized_model_module::kim_get_model_name
Since
2.0

◆ KIM_ModelWriteParameterizedModel_GetPath()

void KIM_ModelWriteParameterizedModel_GetPath ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel,
char const **const  path 
)

Get the directory path where the parameterized model files should be written.

See also
KIM::ModelWriteParameterizedModel::GetPath, kim_model_write_parameterized_model_module::kim_get_path
Since
2.0

◆ KIM_ModelWriteParameterizedModel_LogEntry()

void KIM_ModelWriteParameterizedModel_LogEntry ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel,
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::ModelWriteParameterizedModel::LogEntry, kim_model_write_parameterized_model_module::kim_log_entry
Since
2.0

◆ KIM_ModelWriteParameterizedModel_SetParameterFileName()

void KIM_ModelWriteParameterizedModel_SetParameterFileName ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel,
char const *const  fileName 
)

Set the file name for the next parameter file.

See also
KIM::ModelWriteParameterizedModel::SetParameterFileName, kim_model_write_parameterized_model_module::kim_set_parameter_file_name
Since
2.0

◆ KIM_ModelWriteParameterizedModel_ToString()

char const* KIM_ModelWriteParameterizedModel_ToString ( KIM_ModelWriteParameterizedModel const *const  modelWriteParameterizedModel)

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

See also
KIM::ModelWriteParameterizedModel::ToString, kim_model_write_parameterized_model_module::kim_to_string
Since
2.0