kim-api-v2
2.0.1+cc5c14a.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Go to the source code of this file.
Classes | |
struct | KIM_LengthUnit |
An Extensible Enumeration for the LengthUnit's supported by the KIM API. More... | |
Typedefs | |
typedef struct KIM_LengthUnit | KIM_LengthUnit |
Convenience typedef. More... | |
Functions | |
KIM_LengthUnit | KIM_LengthUnit_FromString (char const *const str) |
Create a LengthUnit object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated. More... | |
int | KIM_LengthUnit_Known (KIM_LengthUnit const lengthUnit) |
Determines if the object is a quantity known to the KIM API. More... | |
int | KIM_LengthUnit_Equal (KIM_LengthUnit const lhs, KIM_LengthUnit const rhs) |
Compares LengthUnit objects for equality. More... | |
int | KIM_LengthUnit_NotEqual (KIM_LengthUnit const lhs, KIM_LengthUnit const rhs) |
Compares LengthUnit objects for inequality. More... | |
char const * | KIM_LengthUnit_ToString (KIM_LengthUnit const lengthUnit) |
Converts the object to a string. More... | |
void | KIM_LENGTH_UNIT_GetNumberOfLengthUnits (int *const numberOfLengthUnits) |
Get the number of standard LengthUnit's defined by the KIM API. More... | |
int | KIM_LENGTH_UNIT_GetLengthUnit (int const index, KIM_LengthUnit *const lengthUnit) |
Get the identity of each defined standard LengthUnit. More... | |
Variables | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_unused |
Indicates that a LengthUnit is not used. More... | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_A |
The standard angstrom unit of length. More... | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_Bohr |
The standard Bohr unit of length. More... | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_cm |
The standard centimeter unit of length. More... | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_m |
The standard meter unit of length. More... | |
KIM_LengthUnit const | KIM_LENGTH_UNIT_nm |
The standard nanometer unit of length. More... | |
typedef struct KIM_LengthUnit KIM_LengthUnit |
int KIM_LENGTH_UNIT_GetLengthUnit | ( | int const | index, |
KIM_LengthUnit *const | lengthUnit | ||
) |
Get the identity of each defined standard LengthUnit.
void KIM_LENGTH_UNIT_GetNumberOfLengthUnits | ( | int *const | numberOfLengthUnits | ) |
Get the number of standard LengthUnit's defined by the KIM API.
int KIM_LengthUnit_Equal | ( | KIM_LengthUnit const | lhs, |
KIM_LengthUnit const | rhs | ||
) |
Compares LengthUnit objects for equality.
KIM_LengthUnit KIM_LengthUnit_FromString | ( | char const *const | str | ) |
Create a LengthUnit object corresponding to the provided string. If the string does not match one of the values defined by the KIM API, then an "unknown" object is generated.
int KIM_LengthUnit_Known | ( | KIM_LengthUnit const | lengthUnit | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_LengthUnit_NotEqual | ( | KIM_LengthUnit const | lhs, |
KIM_LengthUnit const | rhs | ||
) |
Compares LengthUnit objects for inequality.
char const* KIM_LengthUnit_ToString | ( | KIM_LengthUnit const | lengthUnit | ) |
Converts the object to a string.
KIM_LengthUnit const KIM_LENGTH_UNIT_A |
The standard angstrom unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_Bohr |
The standard Bohr unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_cm |
The standard centimeter unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_m |
The standard meter unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_nm |
The standard nanometer unit of length.
KIM_LengthUnit const KIM_LENGTH_UNIT_unused |
Indicates that a LengthUnit is not used.