OpenCMISS-Iron Internal API Documentation
distributed_matrix_vector_IO.f90
Go to the documentation of this file.
1 
43 
45 MODULE distriubted_matrix_vector_io
46 
47  USE base_routines
48  USE iso_varying_string
49  USE kinds
50  USE strings
51  USE types
52 
53 #include "macros.h"
54 
55  IMPLICIT NONE
56 
57  PRIVATE
58 
59  !Module types
60 
61  !Module variables
62 
63  !Interfaces
64 
65  PUBLIC distributed_matrix_vector_io_close,distributed_matrix_vector_io_open,distributed_vector_io_read,distributed_vector_io_write
66 
67 CONTAINS
68 
69  !
70  !================================================================================================================================
71  !
72 
74  SUBROUTINE distributed_matrix_vector_io_close(ERR,ERROR,*)
75 
76  !Argument variables
77  INTEGER(INTG), INTENT(OUT) :: ERR
78  TYPE(varying_string), INTENT(OUT) :: ERROR
79  !Local Variables
80 
81  enters("DISTRIBUTED_MATRIX_VECTOR_IO_CLOSE",err,error,*999)
82 
83 
84  exits("DISTRIBUTED_MATRIX_VECTOR_IO_CLOSE")
85  RETURN
86 999 errorsexits("DISTRIBUTED_MATRIX_VECTOR_IO_CLOSE",err,error)
87  RETURN 1
88  END SUBROUTINE distributed_matrix_vector_io_close
89 
90  !
91  !================================================================================================================================
92  !
93 
95  SUBROUTINE distributed_matrix_vector_io_open(ERR,ERROR,*)
96 
97  !Argument variables
98  INTEGER(INTG), INTENT(OUT) :: ERR
99  TYPE(varying_string), INTENT(OUT) :: ERROR
100  !Local Variables
101 
102  enters("DISTRIBUTED_MATRIX_VECTOR_IO_OPEN",err,error,*999)
103 
104 
105  exits("DISTRIBUTED_MATRIX_VECTOR_IO_OPEN")
106  RETURN
107 999 errorsexits("DISTRIBUTED_MATRIX_VECTOR_IO_OPEN",err,error)
108  RETURN 1
109  END SUBROUTINE distributed_matrix_vector_io_open
110 
111  !
112  !================================================================================================================================
113  !
114 
116  SUBROUTINE distributed_vector_io_read(FILE,OFFSET,DISTRIBUTED_VECTOR,ERR,ERROR,*)
117 
118  !Argument variables
119  INTEGER(INTG), INTENT(IN) :: FILE
120  INTEGER(INTG), INTENT(INOUT) :: OFFSET !Should be large integer
121  TYPE(distributed_vector_type), POINTER :: DISTRIBUTED_VECTOR
122  INTEGER(INTG), INTENT(OUT) :: ERR
123  TYPE(varying_string), INTENT(OUT) :: ERROR
124  !Local Variables
125 
126  enters("DISTRIBUTED_VECTOR_IO_READ",err,error,*999)
127 
128 
129  exits("DISTRIBUTED_VECTOR_IO_READ")
130  RETURN
131 999 errorsexits("DISTRIBUTED_VECTOR_IO_READ",err,error)
132  RETURN 1
133  END SUBROUTINE distributed_vector_io_read
134 
135  !
136  !================================================================================================================================
137  !
138 
140  SUBROUTINE distributed_vector_io_write(FILE,OFFSET,DISTRIBUTED_VECTOR,ERR,ERROR,*)
141 
142  !Argument variables
143  INTEGER(INTG), INTENT(IN) :: FILE
144  INTEGER(INTG), INTENT(INOUT) :: OFFSET !Should be large integer
145  TYPE(distributed_vector_type), POINTER :: DISTRIBUTED_VECTOR
146  INTEGER(INTG), INTENT(OUT) :: ERR
147  TYPE(varying_string), INTENT(OUT) :: ERROR
148  !Local Variables
149 
150  enters("DISTRIBUTED_VECTOR_IO_WRITE",err,error,*999)
151 
152  IF(ASSOCIATED(distributed_vector)) THEN
153  ELSE
154  CALL flagerror("Distributed vector is not associated.",err,error,*999)
155  ENDIF
156 
157  exits("DISTRIBUTED_VECTOR_IO_WRITE")
158  RETURN
159 999 errorsexits("DISTRIBUTED_VECTOR_IO_WRITE",err,error)
160  RETURN 1
161  END SUBROUTINE distributed_vector_io_write
162 
163  !
164  !================================================================================================================================
165  !
166 
167 
168 END MODULE distriubted_matrix_vector_io
169 
base_routines::enters
subroutine, public enters(NAME, ERR, ERROR,)
Records the entry into the named procedure and initialises the error code.
Definition: base_routines.f90:363
distriubted_matrix_vector_io::distributed_matrix_vector_io_close
subroutine, public distributed_matrix_vector_io_close(ERR, ERROR,)
Closes a distributed matrix vector IO file.
Definition: distributed_matrix_vector_IO.f90:75
strings
This module contains all string manipulation and transformation routines.
Definition: strings.f90:45
distriubted_matrix_vector_io
This module handles all distributed_matrix_vector_IO.
Definition: distributed_matrix_vector_IO.f90:45
iso_varying_string
This module provides an iso_varying_string module, conformant to the API specified in ISO/IEC 1539-2:...
Definition: iso_varying_string.f90:62
iso_varying_string::varying_string
Definition: iso_varying_string.f90:75
distriubted_matrix_vector_io::distributed_vector_io_write
subroutine, public distributed_vector_io_write(FILE, OFFSET, DISTRIBUTED_VECTOR, ERR, ERROR,)
Reads a distributed vector from a file file.
Definition: distributed_matrix_vector_IO.f90:141
base_routines::exits
subroutine, public exits(NAME)
Records the exit out of the named procedure.
Definition: base_routines.f90:504
types
This module contains all type definitions in order to avoid cyclic module references.
Definition: types.f90:70
distriubted_matrix_vector_io::distributed_vector_io_read
subroutine, public distributed_vector_io_read(FILE, OFFSET, DISTRIBUTED_VECTOR, ERR, ERROR,)
Reads a distributed vector from a file file.
Definition: distributed_matrix_vector_IO.f90:117
base_routines
This module contains all the low-level base routines e.g., all debug, control, and low-level communic...
Definition: base_routines.f90:45
types::distributed_vector_type
Contains the information for a vector that is distributed across a number of domains.
Definition: types.f90:786
distriubted_matrix_vector_io::distributed_matrix_vector_io_open
subroutine, public distributed_matrix_vector_io_open(ERR, ERROR,)
Opens a distributed matrix vector IO file.
Definition: distributed_matrix_vector_IO.f90:96
base_routines::flagerror
Flags an error condition.
Definition: base_routines.f90:240
kinds
This module contains all kind definitions.
Definition: kinds.f90:45