kim-api
2.3.1-git+v2.3.0-git-2-g378406f9.GNU.GNU.
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
|
Contains the enumeration constants and the discovery routines for the ChargeUnit Extensible Enumeration. More...
Classes | |
struct | Comparator |
Structure provided for use with std::map. More... | |
Functions | |
void | GetNumberOfChargeUnits (int *const numberOfChargeUnits) |
Get the number of standard ChargeUnit's defined by the KIM API. More... | |
int | GetChargeUnit (int const index, ChargeUnit *const chargeUnit) |
Get the identity of each defined standard ChargeUnit. More... | |
Variables | |
ChargeUnit const | unused |
Indicates that a ChargeUnit is not used. More... | |
ChargeUnit const | C |
The standard Coulomb unit of charge. More... | |
ChargeUnit const | e |
The standard electron unit of charge. More... | |
ChargeUnit const | statC |
The standard statcoulomb unit of charge. More... | |
Contains the enumeration constants and the discovery routines for the ChargeUnit Extensible Enumeration.
int KIM::CHARGE_UNIT::GetChargeUnit | ( | int const | index, |
ChargeUnit *const | chargeUnit | ||
) |
Get the identity of each defined standard ChargeUnit.
[in] | index | Zero-based index uniquely labeling each defined standard ChargeUnit. This index ordering is only guaranteed to be stable during the lifetime of the current process. |
[out] | chargeUnit | The ChargeUnit object associated with index . |
true
if index < 0
or index >= numberOfChargeUnits
. false
otherwise.void KIM::CHARGE_UNIT::GetNumberOfChargeUnits | ( | int *const | numberOfChargeUnits | ) |
Get the number of standard ChargeUnit's defined by the KIM API.
[out] | numberOfChargeUnits | The number of standard ChargeUnit's defined by the KIM API. |
ChargeUnit const KIM::CHARGE_UNIT::C |
The standard Coulomb unit of charge.
ChargeUnit const KIM::CHARGE_UNIT::e |
The standard electron unit of charge.
ChargeUnit const KIM::CHARGE_UNIT::statC |
The standard statcoulomb unit of charge.
ChargeUnit const KIM::CHARGE_UNIT::unused |
Indicates that a ChargeUnit is not used.