kim-api 2.3.0+AppleClang.AppleClang.GNU
An Application Programming Interface (API) for the Knowledgebase of Interatomic Models (KIM).
Loading...
Searching...
No Matches
Data Types | Functions/Subroutines | Variables
kim_charge_unit_module Module Reference

An Extensible Enumeration for the ChargeUnit's supported by the KIM API. More...

Data Types

type  kim_charge_unit_type
 An Extensible Enumeration for the ChargeUnit's supported by the KIM API. More...
 
interface  kim_from_string
 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...
 
interface  kim_known
 Determines if the object is a quantity known to the KIM API. More...
 
interface  kim_to_string
 Converts the object to a string. More...
 

Functions/Subroutines

recursive subroutine, public kim_get_number_of_charge_units (number_of_charge_units)
 Get the number of standard ChargeUnit's defined by the KIM API. More...
 
recursive subroutine, public kim_get_charge_unit (index, charge_unit, ierr)
 Get the identity of each defined standard ChargeUnit. More...
 

Variables

type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_unused"), public, protected kim_charge_unit_unused
 Indicates that a ChargeUnit is not used. More...
 
type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_c"), public, protected kim_charge_unit_c
 The standard Coulomb unit of charge. More...
 
type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_e"), public, protected kim_charge_unit_e
 The standard electron unit of charge. More...
 
type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_statC"), public, protected kim_charge_unit_statc
 The standard statcoulomb unit of charge. More...
 

Detailed Description

An Extensible Enumeration for the ChargeUnit's supported by the KIM API.

See also
KIM::ChargeUnit, KIM_ChargeUnit
Since
2.0

Function/Subroutine Documentation

◆ kim_get_charge_unit()

recursive subroutine, public kim_charge_unit_module::kim_get_charge_unit ( integer(c_int), intent(in)  index,
type(kim_charge_unit_type), intent(out)  charge_unit,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard ChargeUnit.

See also
KIM::CHARGE_UNIT::GetChargeUnit, KIM_CHARGE_UNIT_GetChargeUnit
Since
2.0

Definition at line 277 of file kim_charge_unit_module.f90.

◆ kim_get_number_of_charge_units()

recursive subroutine, public kim_charge_unit_module::kim_get_number_of_charge_units ( integer(c_int), intent(out)  number_of_charge_units)

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

See also
KIM::CHARGE_UNIT::GetNumberOfChargeUnits, KIM_CHARGE_UNIT_GetNumberOfChargeUnits
Since
2.0

Definition at line 257 of file kim_charge_unit_module.f90.

Variable Documentation

◆ kim_charge_unit_c

type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_c"), public, protected kim_charge_unit_module::kim_charge_unit_c

The standard Coulomb unit of charge.

See also
KIM::CHARGE_UNIT::C, KIM_CHARGE_UNIT_C
Since
2.0

Definition at line 85 of file kim_charge_unit_module.f90.

◆ kim_charge_unit_e

type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_e"), public, protected kim_charge_unit_module::kim_charge_unit_e

The standard electron unit of charge.

See also
KIM::CHARGE_UNIT::e, KIM_CHARGE_UNIT_e
Since
2.0

Definition at line 94 of file kim_charge_unit_module.f90.

◆ kim_charge_unit_statc

type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_statC"), public, protected kim_charge_unit_module::kim_charge_unit_statc

The standard statcoulomb unit of charge.

See also
KIM::CHARGE_UNIT::statC, KIM_CHARGE_UNIT_statC
Since
2.0

Definition at line 103 of file kim_charge_unit_module.f90.

◆ kim_charge_unit_unused

type(kim_charge_unit_type), save, bind(C, name="KIM_CHARGE_UNIT_unused"), public, protected kim_charge_unit_module::kim_charge_unit_unused

Indicates that a ChargeUnit is not used.

See also
KIM::CHARGE_UNIT::unused, KIM_CHARGE_UNIT_unused
Since
2.0

Definition at line 76 of file kim_charge_unit_module.f90.