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_time_unit_module Module Reference

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

Data Types

interface  kim_from_string
 Create a TimeUnit 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...
 
type  kim_time_unit_type
 An Extensible Enumeration for the TimeUnit's supported by the KIM API. More...
 
interface  kim_to_string
 Converts the object to a string. More...
 

Functions/Subroutines

recursive subroutine, public kim_get_number_of_time_units (number_of_time_units)
 Get the number of standard TimeUnit's defined by the KIM API. More...
 
recursive subroutine, public kim_get_time_unit (index, time_unit, ierr)
 Get the identity of each defined standard TimeUnit. More...
 

Variables

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_unused"), public, protected kim_time_unit_unused
 Indicates that a TimeUnit is not used. More...
 
type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_fs"), public, protected kim_time_unit_fs
 The standard femtosecond unit of time. More...
 
type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_ps"), public, protected kim_time_unit_ps
 The standard picosecond unit of time. More...
 
type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_ns"), public, protected kim_time_unit_ns
 The standard nanosecond unit of time. More...
 
type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_s"), public, protected kim_time_unit_s
 The standard second unit of time. More...
 

Detailed Description

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

See also
KIM::TimeUnit, KIM_TimeUnit
Since
2.0

Function/Subroutine Documentation

◆ kim_get_number_of_time_units()

recursive subroutine, public kim_time_unit_module::kim_get_number_of_time_units ( integer(c_int), intent(out)  number_of_time_units)

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

See also
KIM::TIME_UNIT::GetNumberOfTimeUnits, KIM_TIME_UNIT_GetNumberOfTimeUnits
Since
2.0

Definition at line 264 of file kim_time_unit_module.f90.

◆ kim_get_time_unit()

recursive subroutine, public kim_time_unit_module::kim_get_time_unit ( integer(c_int), intent(in)  index,
type(kim_time_unit_type), intent(out)  time_unit,
integer(c_int), intent(out)  ierr 
)

Get the identity of each defined standard TimeUnit.

See also
KIM::TIME_UNIT::GetTimeUnit, KIM_TIME_UNIT_GetTimeUnit
Since
2.0

Definition at line 284 of file kim_time_unit_module.f90.

Variable Documentation

◆ kim_time_unit_fs

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_fs"), public, protected kim_time_unit_module::kim_time_unit_fs

The standard femtosecond unit of time.

See also
KIM::TIME_UNIT::fs, KIM_TIME_UNIT_fs
Since
2.0

Definition at line 86 of file kim_time_unit_module.f90.

◆ kim_time_unit_ns

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_ns"), public, protected kim_time_unit_module::kim_time_unit_ns

The standard nanosecond unit of time.

See also
KIM::TIME_UNIT::ns, KIM_TIME_UNIT_ns
Since
2.0

Definition at line 104 of file kim_time_unit_module.f90.

◆ kim_time_unit_ps

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_ps"), public, protected kim_time_unit_module::kim_time_unit_ps

The standard picosecond unit of time.

See also
KIM::TIME_UNIT::ps, KIM_TIME_UNIT_ps
Since
2.0

Definition at line 95 of file kim_time_unit_module.f90.

◆ kim_time_unit_s

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_s"), public, protected kim_time_unit_module::kim_time_unit_s

The standard second unit of time.

See also
KIM::TIME_UNIT::s, KIM_TIME_UNIT_s
Since
2.0

Definition at line 113 of file kim_time_unit_module.f90.

◆ kim_time_unit_unused

type(kim_time_unit_type), save, bind(C, name="KIM_TIME_UNIT_unused"), public, protected kim_time_unit_module::kim_time_unit_unused

Indicates that a TimeUnit is not used.

See also
KIM::TIME_UNIT::unused, KIM_TIME_UNIT_unused
Since
2.0

Definition at line 77 of file kim_time_unit_module.f90.