KIM API V2
Classes | Macros | Typedefs | Functions | Variables
KIM_ArgumentName.h File Reference

Go to the source code of this file.

Classes

struct  KIM_ArgumentName
 

Macros

#define KIM_DATA_TYPE_DEFINED_
 
#define KIM_ARGUMENT_NAME_DEFINED_
 

Typedefs

typedef struct KIM_DataType KIM_DataType
 
typedef struct KIM_ArgumentName KIM_ArgumentName
 

Functions

KIM_ArgumentName KIM_ArgumentNameFromString (char const *const str)
 
int KIM_ArgumentNameEqual (KIM_ArgumentName const left, KIM_ArgumentName const right)
 
int KIM_ArgumentNameNotEqual (KIM_ArgumentName const left, KIM_ArgumentName const right)
 
char const *const KIM_ArgumentNameString (KIM_ArgumentName const argumentName)
 
void KIM_ARGUMENT_NAME_GetNumberOfArguments (int *const numberOfArguments)
 
int KIM_ARGUMENT_NAME_GetArgumentName (int const index, KIM_ArgumentName *const argumentName)
 
int KIM_ARGUMENT_NAME_GetArgumentDataType (KIM_ArgumentName const argumentName, KIM_DataType *const dataType)
 

Variables

KIM_ArgumentName const KIM_ARGUMENT_NAME_numberOfParticles
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_particleSpeciesCodes
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_particleContributing
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_coordinates
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialEnergy
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialForces
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleEnergy
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialVirial
 
KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleVirial
 

Macro Definition Documentation

◆ KIM_ARGUMENT_NAME_DEFINED_

#define KIM_ARGUMENT_NAME_DEFINED_

Definition at line 50 of file KIM_ArgumentName.h.

◆ KIM_DATA_TYPE_DEFINED_

#define KIM_DATA_TYPE_DEFINED_

Definition at line 41 of file KIM_ArgumentName.h.

Typedef Documentation

◆ KIM_ArgumentName

Definition at line 51 of file KIM_ArgumentName.h.

◆ KIM_DataType

typedef struct KIM_DataType KIM_DataType

Definition at line 42 of file KIM_ArgumentName.h.

Function Documentation

◆ KIM_ARGUMENT_NAME_GetArgumentDataType()

int KIM_ARGUMENT_NAME_GetArgumentDataType ( KIM_ArgumentName const  argumentName,
KIM_DataType *const  dataType 
)

◆ KIM_ARGUMENT_NAME_GetArgumentName()

int KIM_ARGUMENT_NAME_GetArgumentName ( int const  index,
KIM_ArgumentName *const  argumentName 
)

◆ KIM_ARGUMENT_NAME_GetNumberOfArguments()

void KIM_ARGUMENT_NAME_GetNumberOfArguments ( int *const  numberOfArguments)

◆ KIM_ArgumentNameEqual()

int KIM_ArgumentNameEqual ( KIM_ArgumentName const  left,
KIM_ArgumentName const  right 
)

◆ KIM_ArgumentNameFromString()

KIM_ArgumentName KIM_ArgumentNameFromString ( char const *const  str)

◆ KIM_ArgumentNameNotEqual()

int KIM_ArgumentNameNotEqual ( KIM_ArgumentName const  left,
KIM_ArgumentName const  right 
)

◆ KIM_ArgumentNameString()

char const* const KIM_ArgumentNameString ( KIM_ArgumentName const  argumentName)

Variable Documentation

◆ KIM_ARGUMENT_NAME_coordinates

KIM_ArgumentName const KIM_ARGUMENT_NAME_coordinates

◆ KIM_ARGUMENT_NAME_numberOfParticles

KIM_ArgumentName const KIM_ARGUMENT_NAME_numberOfParticles

◆ KIM_ARGUMENT_NAME_partialEnergy

KIM_ArgumentName const KIM_ARGUMENT_NAME_partialEnergy

◆ KIM_ARGUMENT_NAME_partialForces

KIM_ArgumentName const KIM_ARGUMENT_NAME_partialForces

◆ KIM_ARGUMENT_NAME_partialParticleEnergy

KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleEnergy

◆ KIM_ARGUMENT_NAME_partialParticleVirial

KIM_ArgumentName const KIM_ARGUMENT_NAME_partialParticleVirial

◆ KIM_ARGUMENT_NAME_partialVirial

KIM_ArgumentName const KIM_ARGUMENT_NAME_partialVirial

◆ KIM_ARGUMENT_NAME_particleContributing

KIM_ArgumentName const KIM_ARGUMENT_NAME_particleContributing

◆ KIM_ARGUMENT_NAME_particleSpeciesCodes

KIM_ArgumentName const KIM_ARGUMENT_NAME_particleSpeciesCodes