kim-api  2.1.4-git+v2.1.3-git-3-g4c859c7f.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Classes | Functions | Variables
KIM::CHARGE_UNIT Namespace Reference

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...
 

Detailed Description

Contains the enumeration constants and the discovery routines for the ChargeUnit Extensible Enumeration.

Function Documentation

◆ GetChargeUnit()

int KIM::CHARGE_UNIT::GetChargeUnit ( int const  index,
ChargeUnit *const  chargeUnit 
)

Get the identity of each defined standard ChargeUnit.

Parameters
[in]indexZero-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]chargeUnitThe ChargeUnit object associated with index.
Returns
true if index < 0 or index >= numberOfChargeUnits.
false otherwise.
See also
KIM_CHARGE_UNIT_GetChargeUnit, kim_charge_unit_module::kim_get_charge_unit
Since
2.0

◆ GetNumberOfChargeUnits()

void KIM::CHARGE_UNIT::GetNumberOfChargeUnits ( int *const  numberOfChargeUnits)

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

Parameters
[out]numberOfChargeUnitsThe number of standard ChargeUnit's defined by the KIM API.
See also
KIM_CHARGE_UNIT_GetNumberOfChargeUnits, kim_charge_unit_module::kim_get_number_of_charge_units
Since
2.0

Variable Documentation

◆ C

ChargeUnit const KIM::CHARGE_UNIT::C

The standard Coulomb unit of charge.

See also
KIM_CHARGE_UNIT_C, kim_charge_unit_module::kim_charge_unit_c
Since
2.0

◆ e

ChargeUnit const KIM::CHARGE_UNIT::e

The standard electron unit of charge.

See also
KIM_CHARGE_UNIT_e, kim_charge_unit_module::kim_charge_unit_e
Since
2.0

◆ statC

ChargeUnit const KIM::CHARGE_UNIT::statC

The standard statcoulomb unit of charge.

See also
KIM_CHARGE_UNIT_statC, kim_charge_unit_module::kim_charge_unit_statc
Since
2.0

◆ unused

ChargeUnit const KIM::CHARGE_UNIT::unused

Indicates that a ChargeUnit is not used.

See also
KIM_CHARGE_UNIT_unused, kim_charge_unit_module::kim_charge_unit_unused
Since
2.0