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-alpha.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  type, bind(c) :: kim_numbering_type
50  integer(c_int) :: numbering_id
51  end type kim_numbering_type
52 
53  type(kim_numbering_type), protected, &
54  bind(c, name="KIM_NUMBERING_zeroBased") &
56  type(kim_numbering_type), protected, &
57  bind(c, name="KIM_NUMBERING_oneBased") &
59 
60  interface operator (.eq.)
61  logical function kim_numbering_equal(left, right)
62  use, intrinsic :: iso_c_binding
63  import kim_numbering_type
64  implicit none
65  type(kim_numbering_type), intent(in) :: left
66  type(kim_numbering_type), intent(in) :: right
67  end function kim_numbering_equal
68  end interface operator (.eq.)
69 
70  interface operator (.ne.)
71  logical function kim_numbering_not_equal(left, right)
72  use, intrinsic :: iso_c_binding
73  import kim_numbering_type
74  implicit none
75  type(kim_numbering_type), intent(in) :: left
76  type(kim_numbering_type), intent(in) :: right
77  end function kim_numbering_not_equal
78  end interface operator (.ne.)
79 
80  interface
81  subroutine kim_numbering_from_string(string, numbering)
82  import kim_numbering_type
83  implicit none
84  character(len=*), intent(in) :: string
85  type(kim_numbering_type), intent(out) :: numbering
86  end subroutine kim_numbering_from_string
87 
88  subroutine kim_numbering_string(numbering, string)
89  import kim_numbering_type
90  implicit none
91  type(kim_numbering_type), intent(in), value :: numbering
92  character(len=*), intent(out) :: string
93  end subroutine kim_numbering_string
94  end interface
95 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