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::TIME_UNIT Namespace Reference

Contains the enumeration constants and the discovery routines for the TimeUnit Extensible Enumeration. More...

Classes

struct  Comparator
 Structure provided for use with std::map. More...
 

Functions

void GetNumberOfTimeUnits (int *const numberOfTimeUnits)
 Get the number of standard TimeUnit's defined by the KIM API. More...
 
int GetTimeUnit (int const index, TimeUnit *const timeUnit)
 Get the identity of each defined standard TimeUnit. More...
 

Variables

TimeUnit const unused
 Indicates that a TimeUnit is not used. More...
 
TimeUnit const fs
 The standard femtosecond unit of time. More...
 
TimeUnit const ps
 The standard picosecond unit of time. More...
 
TimeUnit const ns
 The standard nanosecond unit of time. More...
 
TimeUnit const s
 The standard second unit of time. More...
 

Detailed Description

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

Function Documentation

◆ GetNumberOfTimeUnits()

void KIM::TIME_UNIT::GetNumberOfTimeUnits ( int *const  numberOfTimeUnits)

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

Parameters
[out]numberOfTimeUnitsThe number of standard TimeUnit's defined by the KIM API.
See also
KIM_TIME_UNIT_GetNumberOfTimeUnits, kim_time_unit_module::kim_get_number_of_time_units
Since
2.0

◆ GetTimeUnit()

int KIM::TIME_UNIT::GetTimeUnit ( int const  index,
TimeUnit *const  timeUnit 
)

Get the identity of each defined standard TimeUnit.

Parameters
[in]indexZero-based index uniquely labeling each defined standard TimeUnitnit. This index ordering is only guaranteed to be stable during the lifetime of the current process.
[out]timeUnitThe TimeUnit object associated with index.
Returns
true if index < 0 or index >= numberOfTimeUnits.
false otherwise.
See also
KIM_TIME_UNIT_GetTimeUnit, kim_time_unit_module::kim_get_time_unit
Since
2.0

Variable Documentation

◆ fs

TimeUnit const KIM::TIME_UNIT::fs

The standard femtosecond unit of time.

See also
KIM_TIME_UNIT_fs, kim_time_unit_module::kim_time_unit_fs
Since
2.0

◆ ns

TimeUnit const KIM::TIME_UNIT::ns

The standard nanosecond unit of time.

See also
KIM_TIME_UNIT_ns, kim_time_unit_module::kim_time_unit_ns
Since
2.0

◆ ps

TimeUnit const KIM::TIME_UNIT::ps

The standard picosecond unit of time.

See also
KIM_TIME_UNIT_ps, kim_time_unit_module::kim_time_unit_ps
Since
2.0

◆ s

TimeUnit const KIM::TIME_UNIT::s

The standard second unit of time.

See also
KIM_TIME_UNIT_s, kim_time_unit_module::kim_time_unit_s
Since
2.0

◆ unused

TimeUnit const KIM::TIME_UNIT::unused

Indicates that a TimeUnit is not used.

See also
KIM_TIME_UNIT_unused, kim_time_unit_module::kim_time_unit_unused
Since
2.0