kim-api 2.4.2+30a0ceab.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
 
Loading...
Searching...
No Matches
Classes | Functions | Variables
KIM_ModelRoutineName.h File Reference

Go to the source code of this file.

Classes

struct  KIM_ModelRoutineName
 An Extensible Enumeration for the ModelRoutineName's supported by the KIM API. More...
 

Functions

KIM_ModelRoutineName KIM_ModelRoutineName_FromString (char const *const str)
 KIM::ModelRoutineName::ModelRoutineName(std::string const &)
 
int KIM_ModelRoutineName_Known (KIM_ModelRoutineName const modelRoutineName)
 Determines if the object is a quantity known to the KIM API.
 
int KIM_ModelRoutineName_Equal (KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
 Compares ModelRoutineName objects for equality.
 
int KIM_ModelRoutineName_NotEqual (KIM_ModelRoutineName const lhs, KIM_ModelRoutineName const rhs)
 Compares ModelRoutineName objects for inequality.
 
char const * KIM_ModelRoutineName_ToString (KIM_ModelRoutineName const modelRoutineName)
 Converts the object to a string.
 
void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames (int *const numberOfModelRoutineNames)
 Get the number of standard ModelRoutineName's defined by the KIM API.
 
int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName (int const index, KIM_ModelRoutineName *const modelRoutineName)
 Get the identity of each defined standard ModelRoutineName.
 

Variables

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create
 The standard Create routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate
 The standard ComputeArgumentsCreate routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute
 The standard Compute routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension
 The standard Extension routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh
 The standard Refresh routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel
 The standard WriteParameterizedModel routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy
 The standard ComputeArgumentsDestroy routine.
 
KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy
 The standard Destroy routine.
 

Function Documentation

◆ KIM_MODEL_ROUTINE_NAME_GetModelRoutineName()

int KIM_MODEL_ROUTINE_NAME_GetModelRoutineName ( int const index,
KIM_ModelRoutineName *const modelRoutineName )

Get the identity of each defined standard ModelRoutineName.

See also
KIM::MODEL_ROUTINE_NAME::GetModelRoutineName, kim_model_routine_name_module::kim_get_model_routine_name
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames()

void KIM_MODEL_ROUTINE_NAME_GetNumberOfModelRoutineNames ( int *const numberOfModelRoutineNames)

Get the number of standard ModelRoutineName's defined by the KIM API.

See also
KIM::MODEL_ROUTINE_NAME::GetNumberOfModelRoutineNames, kim_model_routine_name_module::kim_get_number_of_model_routine_names
Since
2.0

◆ KIM_ModelRoutineName_Equal()

int KIM_ModelRoutineName_Equal ( KIM_ModelRoutineName const lhs,
KIM_ModelRoutineName const rhs )

Compares ModelRoutineName objects for equality.

See also
KIM::ModelRoutineName::operator==(), kim_model_routine_name_module::operator(.eq.)
Since
2.0

◆ KIM_ModelRoutineName_FromString()

KIM_ModelRoutineName KIM_ModelRoutineName_FromString ( char const *const str)

KIM::ModelRoutineName::ModelRoutineName(std::string const &)

See also
KIM::ModelRoutineName::ModelRoutineName(std::string const &), kim_model_routine_name_module::kim_from_string
Since
2.0

◆ KIM_ModelRoutineName_Known()

int KIM_ModelRoutineName_Known ( KIM_ModelRoutineName const modelRoutineName)

Determines if the object is a quantity known to the KIM API.

See also
KIM::ModelRoutineName::Known, kim_model_routine_name_module::kim_known
Since
2.0

◆ KIM_ModelRoutineName_NotEqual()

int KIM_ModelRoutineName_NotEqual ( KIM_ModelRoutineName const lhs,
KIM_ModelRoutineName const rhs )

Compares ModelRoutineName objects for inequality.

See also
KIM::ModelRoutineName::operator!=(), kim_model_routine_name_module::operator(.ne.)
Since
2.0

◆ KIM_ModelRoutineName_ToString()

char const * KIM_ModelRoutineName_ToString ( KIM_ModelRoutineName const modelRoutineName)

Converts the object to a string.

See also
KIM::ModelRoutineName::ToString, kim_model_routine_name_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_MODEL_ROUTINE_NAME_Compute

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Compute
extern

The standard Compute routine.

See also
KIM::MODEL_ROUTINE_NAME::Compute, kim_model_routine_name_module::kim_model_routine_name_compute
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsCreate
extern

The standard ComputeArgumentsCreate routine.

See also
KIM::MODEL_ROUTINE_NAME::ComputeArgumentsCreate, kim_model_routine_name_module:: kim_model_routine_name_compute_arguments_create
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_ComputeArgumentsDestroy
extern

The standard ComputeArgumentsDestroy routine.

See also
KIM::MODEL_ROUTINE_NAME::ComputeArgumentsDestroy, kim_model_routine_name_module:: kim_model_routine_name_compute_arguments_destroy
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_Create

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Create
extern

The standard Create routine.

See also
KIM::MODEL_ROUTINE_NAME::Create, kim_model_routine_name_module::kim_model_routine_name_create
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_Destroy

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Destroy
extern

The standard Destroy routine.

See also
KIM::MODEL_ROUTINE_NAME::Destroy, kim_model_routine_name_module::kim_model_routine_name_destroy
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_Extension

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Extension
extern

The standard Extension routine.

See also
KIM::MODEL_ROUTINE_NAME::Extension, kim_model_routine_name_module::kim_model_routine_name_extension
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_Refresh

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_Refresh
extern

The standard Refresh routine.

See also
KIM::MODEL_ROUTINE_NAME::Refresh, kim_model_routine_name_module::kim_model_routine_name_refresh
Since
2.0

◆ KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel

KIM_ModelRoutineName const KIM_MODEL_ROUTINE_NAME_WriteParameterizedModel
extern

The standard WriteParameterizedModel routine.

See also
KIM::MODEL_ROUTINE_NAME::WriteParameterizedModel, kim_model_routine_name_module:: kim_model_routine_name_write_parameterized_model
Since
2.0