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_ChargeUnit |
An Extensible Enumeration for the ChargeUnit's supported by the KIM API. More... | |
Typedefs | |
typedef struct KIM_ChargeUnit | KIM_ChargeUnit |
Convenience typedef. More... | |
Functions | |
KIM_ChargeUnit | KIM_ChargeUnit_FromString (char const *const str) |
Create a ChargeUnit 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_ChargeUnit_Known (KIM_ChargeUnit const chargeUnit) |
Determines if the object is a quantity known to the KIM API. More... | |
int | KIM_ChargeUnit_Equal (KIM_ChargeUnit const lhs, KIM_ChargeUnit const rhs) |
Compares ChargeUnit objects for equality. More... | |
int | KIM_ChargeUnit_NotEqual (KIM_ChargeUnit const lhs, KIM_ChargeUnit const rhs) |
Compares ChargeUnit objects for inequality. More... | |
char const * | KIM_ChargeUnit_ToString (KIM_ChargeUnit const chargeUnit) |
Converts the object to a string. More... | |
void | KIM_CHARGE_UNIT_GetNumberOfChargeUnits (int *const numberOfChargeUnits) |
Get the number of standard ChargeUnit's defined by the KIM API. More... | |
int | KIM_CHARGE_UNIT_GetChargeUnit (int const index, KIM_ChargeUnit *const chargeUnit) |
Get the identity of each defined standard ChargeUnit. More... | |
Variables | |
KIM_ChargeUnit const | KIM_CHARGE_UNIT_unused |
Indicates that a ChargeUnit is not used. More... | |
KIM_ChargeUnit const | KIM_CHARGE_UNIT_C |
The standard Coulomb unit of charge. More... | |
KIM_ChargeUnit const | KIM_CHARGE_UNIT_e |
The standard electron unit of charge. More... | |
KIM_ChargeUnit const | KIM_CHARGE_UNIT_statC |
The standard statcoulomb unit of charge. More... | |
typedef struct KIM_ChargeUnit KIM_ChargeUnit |
int KIM_CHARGE_UNIT_GetChargeUnit | ( | int const | index, |
KIM_ChargeUnit *const | chargeUnit | ||
) |
Get the identity of each defined standard ChargeUnit.
void KIM_CHARGE_UNIT_GetNumberOfChargeUnits | ( | int *const | numberOfChargeUnits | ) |
Get the number of standard ChargeUnit's defined by the KIM API.
int KIM_ChargeUnit_Equal | ( | KIM_ChargeUnit const | lhs, |
KIM_ChargeUnit const | rhs | ||
) |
Compares ChargeUnit objects for equality.
KIM_ChargeUnit KIM_ChargeUnit_FromString | ( | char const *const | str | ) |
Create a ChargeUnit 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_ChargeUnit_Known | ( | KIM_ChargeUnit const | chargeUnit | ) |
Determines if the object is a quantity known to the KIM API.
int KIM_ChargeUnit_NotEqual | ( | KIM_ChargeUnit const | lhs, |
KIM_ChargeUnit const | rhs | ||
) |
Compares ChargeUnit objects for inequality.
char const* KIM_ChargeUnit_ToString | ( | KIM_ChargeUnit const | chargeUnit | ) |
Converts the object to a string.
KIM_ChargeUnit const KIM_CHARGE_UNIT_C |
The standard Coulomb unit of charge.
KIM_ChargeUnit const KIM_CHARGE_UNIT_e |
The standard electron unit of charge.
KIM_ChargeUnit const KIM_CHARGE_UNIT_statC |
The standard statcoulomb unit of charge.
KIM_ChargeUnit const KIM_CHARGE_UNIT_unused |
Indicates that a ChargeUnit is not used.