KIM API V2
kim_numbering_module.f90
Go to the documentation of this file.
1 !
2 ! CDDL HEADER START
3 !
4 ! The contents of this file are subject to the terms of the Common Development
5 ! and Distribution License Version 1.0 (the "License").
6 !
7 ! You can obtain a copy of the license at
8 ! http://www.opensource.org/licenses/CDDL-1.0. See the License for the
9 ! specific language governing permissions and limitations under the License.
10 !
11 ! When distributing Covered Code, include this CDDL HEADER in each file and
12 ! include the License file in a prominent location with the name LICENSE.CDDL.
13 ! If applicable, add the following below this CDDL HEADER, with the fields
14 ! enclosed by brackets "[]" replaced with your own identifying information:
15 !
16 ! Portions Copyright (c) [yyyy] [name of copyright owner]. All rights reserved.
17 !
18 ! CDDL HEADER END
19 !
20 
21 !
22 ! Copyright (c) 2016--2018, Regents of the University of Minnesota.
23 ! All rights reserved.
24 !
25 ! Contributors:
26 ! Ryan S. Elliott
27 !
28 
29 !
30 ! Release: This file is part of the kim-api-v2.0.0-beta.0 package.
31 !
32 
33 
35  use, intrinsic :: iso_c_binding
36  implicit none
37  private
38 
39  public &
40  kim_numbering_type, &
41  kim_numbering_from_string, &
42  operator (.eq.), &
43  operator (.ne.), &
44  kim_numbering_string, &
45 
48 
49  kim_numbering_get_number_of_numberings, &
50  kim_numbering_get_numbering
51 
52 
53  type, bind(c) :: kim_numbering_type
54  integer(c_int) :: numbering_id
55  end type kim_numbering_type
56 
57  type(kim_numbering_type), protected, &
58  bind(c, name="KIM_NUMBERING_zeroBased") &
60  type(kim_numbering_type), protected, &
61  bind(c, name="KIM_NUMBERING_oneBased") &
63 
64  interface operator (.eq.)
65  logical function kim_numbering_equal(left, right)
66  use, intrinsic :: iso_c_binding
67  import kim_numbering_type
68  implicit none
69  type(kim_numbering_type), intent(in) :: left
70  type(kim_numbering_type), intent(in) :: right
71  end function kim_numbering_equal
72  end interface operator (.eq.)
73 
74  interface operator (.ne.)
75  logical function kim_numbering_not_equal(left, right)
76  use, intrinsic :: iso_c_binding
77  import kim_numbering_type
78  implicit none
79  type(kim_numbering_type), intent(in) :: left
80  type(kim_numbering_type), intent(in) :: right
81  end function kim_numbering_not_equal
82  end interface operator (.ne.)
83 
84  interface
85  subroutine kim_numbering_from_string(string, numbering)
86  use, intrinsic :: iso_c_binding
87  import kim_numbering_type
88  implicit none
89  character(len=*, kind=c_char), intent(in) :: string
90  type(kim_numbering_type), intent(out) :: numbering
91  end subroutine kim_numbering_from_string
92 
93  subroutine kim_numbering_string(numbering, string)
94  use, intrinsic :: iso_c_binding
95  import kim_numbering_type
96  implicit none
97  type(kim_numbering_type), intent(in), value :: numbering
98  character(len=*, kind=c_char), intent(out) :: string
99  end subroutine kim_numbering_string
100 
101  subroutine kim_numbering_get_number_of_numberings(number_of_numberings)
102  use, intrinsic :: iso_c_binding
103  implicit none
104  integer(c_int), intent(out) :: number_of_numberings
105  end subroutine kim_numbering_get_number_of_numberings
106 
107  subroutine kim_numbering_get_numbering(index, numbering, ierr)
108  use, intrinsic :: iso_c_binding
109  import kim_numbering_type
110  implicit none
111  integer(c_int), intent(in), value :: index
112  type(kim_numbering_type), intent(out) :: numbering
113  integer(c_int), intent(out) :: ierr
114  end subroutine kim_numbering_get_numbering
115  end interface
116 end module kim_numbering_module
type(kim_numbering_type), public, protected kim_numbering_one_based
type(kim_numbering_type), public, protected kim_numbering_zero_based