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 | Typedefs | Functions | Variables
KIM_ChargeUnit.h File Reference
This graph shows which files directly or indirectly include this file:

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 Documentation

◆ KIM_ChargeUnit

Convenience typedef.

Since
2.0

Definition at line 65 of file KIM_ChargeUnit.h.

Function Documentation

◆ KIM_CHARGE_UNIT_GetChargeUnit()

int KIM_CHARGE_UNIT_GetChargeUnit ( int const  index,
KIM_ChargeUnit *const  chargeUnit 
)

Get the identity of each defined standard ChargeUnit.

See also
KIM::CHARGE_UNIT::GetChargeUnit, kim_charge_unit_module::kim_get_charge_unit
Since
2.0

◆ KIM_CHARGE_UNIT_GetNumberOfChargeUnits()

void KIM_CHARGE_UNIT_GetNumberOfChargeUnits ( int *const  numberOfChargeUnits)

Get the 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

◆ KIM_ChargeUnit_Equal()

int KIM_ChargeUnit_Equal ( KIM_ChargeUnit const  lhs,
KIM_ChargeUnit const  rhs 
)

Compares ChargeUnit objects for equality.

See also
KIM::ChargeUnit::operator==(), kim_charge_unit_module::operator(.eq.)
Since
2.0

◆ KIM_ChargeUnit_FromString()

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.

See also
KIM::ChargeUnit::ChargeUnit(std::string const &), kim_charge_unit_module::kim_from_string
Since
2.0

◆ KIM_ChargeUnit_Known()

int KIM_ChargeUnit_Known ( KIM_ChargeUnit const  chargeUnit)

Determines if the object is a quantity known to the KIM API.

See also
KIM::ChargeUnit::Known, kim_charge_unit_module::kim_known
Since
2.0

◆ KIM_ChargeUnit_NotEqual()

int KIM_ChargeUnit_NotEqual ( KIM_ChargeUnit const  lhs,
KIM_ChargeUnit const  rhs 
)

Compares ChargeUnit objects for inequality.

See also
KIM::ChargeUnit::operator!=(), kim_charge_unit_module::operator(.ne.)
Since
2.0

◆ KIM_ChargeUnit_ToString()

char const* KIM_ChargeUnit_ToString ( KIM_ChargeUnit const  chargeUnit)

Converts the object to a string.

See also
KIM::ChargeUnit::ToString, kim_charge_unit_module::kim_to_string
Since
2.0

Variable Documentation

◆ KIM_CHARGE_UNIT_C

KIM_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

◆ KIM_CHARGE_UNIT_e

KIM_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

◆ KIM_CHARGE_UNIT_statC

KIM_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

◆ KIM_CHARGE_UNIT_unused

KIM_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