File: kim_energy_unit_module.f90

package info (click to toggle)
kim-api 2.0~beta2.gita734d1-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 3,944 kB
  • sloc: cpp: 22,447; f90: 13,218; ansic: 3,865; sh: 1,960; makefile: 298
file content (137 lines) | stat: -rw-r--r-- 4,501 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
!
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the Common Development
! and Distribution License Version 1.0 (the "License").
!
! You can obtain a copy of the license at
! http://www.opensource.org/licenses/CDDL-1.0.  See the License for the
! specific language governing permissions and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each file and
! include the License file in a prominent location with the name LICENSE.CDDL.
! If applicable, add the following below this CDDL HEADER, with the fields
! enclosed by brackets "[]" replaced with your own identifying information:
!
! Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
!
! CDDL HEADER END
!

!
! Copyright (c) 2016--2018, Regents of the University of Minnesota.
! All rights reserved.
!
! Contributors:
!    Ryan S. Elliott
!

!
! Release: This file is part of the kim-api.git repository.
!


module kim_energy_unit_module
  use, intrinsic :: iso_c_binding
  implicit none
  private

  public &
    kim_energy_unit_type, &
    kim_energy_unit_from_string, &
    operator (.eq.), &
    operator (.ne.), &
    kim_energy_unit_string, &

    kim_energy_unit_unused, &
    kim_energy_unit_amu_a2_per_ps2, &
    kim_energy_unit_erg, &
    kim_energy_unit_ev, &
    kim_energy_unit_hartree, &
    kim_energy_unit_j, &
    kim_energy_unit_kcal_mol, &

    kim_energy_unit_get_number_of_energy_units, &
    kim_energy_unit_get_energy_unit


  type, bind(c) :: kim_energy_unit_type
    integer(c_int) energy_unit_id
  end type kim_energy_unit_type

  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_unsued") &
    :: kim_energy_unit_unused
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_amu_A2_per_ps2") &
    :: kim_energy_unit_amu_a2_per_ps2
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_erg") &
    :: kim_energy_unit_erg
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_eV") &
    :: kim_energy_unit_ev
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_Hartree") &
    :: kim_energy_unit_hartree
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_J") &
    :: kim_energy_unit_j
  type(kim_energy_unit_type), protected, &
    bind(c, name="KIM_ENERGY_UNIT_kcal_mol") &
    :: kim_energy_unit_kcal_mol

  interface operator (.eq.)
    logical function kim_energy_unit_equal(left, right)
      use, intrinsic :: iso_c_binding
      import kim_energy_unit_type
      implicit none
      type(kim_energy_unit_type), intent(in) :: left
      type(kim_energy_unit_type), intent(in) :: right
    end function kim_energy_unit_equal
  end interface operator (.eq.)

  interface operator (.ne.)
    logical function kim_energy_unit_not_equal(left, right)
      use, intrinsic :: iso_c_binding
      import kim_energy_unit_type
      implicit none
      type(kim_energy_unit_type), intent(in) :: left
      type(kim_energy_unit_type), intent(in) :: right
    end function kim_energy_unit_not_equal
  end interface operator (.ne.)

  interface
    subroutine kim_energy_unit_from_string(string, energy_unit)
      use, intrinsic :: iso_c_binding
      import kim_energy_unit_type
      implicit none
      character(len=*, kind=c_char), intent(in) :: string
      type(kim_energy_unit_type), intent(out) :: energy_unit
    end subroutine kim_energy_unit_from_string

    subroutine kim_energy_unit_string(energy_unit, string)
      use, intrinsic :: iso_c_binding
      import kim_energy_unit_type
      implicit none
      type(kim_energy_unit_type), intent(in), value :: energy_unit
      character(len=*, kind=c_char), intent(out) :: string
    end subroutine kim_energy_unit_string

    subroutine kim_energy_unit_get_number_of_energy_units( &
      number_of_energy_units)
      use, intrinsic :: iso_c_binding
      implicit none
      integer(c_int), intent(out) :: number_of_energy_units
    end subroutine kim_energy_unit_get_number_of_energy_units

    subroutine kim_energy_unit_get_energy_unit(index, energy_unit, ierr)
      use, intrinsic :: iso_c_binding
      import kim_energy_unit_type
      implicit none
      integer(c_int), intent(in), value :: index
      type(kim_energy_unit_type), intent(out) :: energy_unit
      integer(c_int), intent(out) :: ierr
    end subroutine kim_energy_unit_get_energy_unit
  end interface
end module kim_energy_unit_module