[4213] | 1 | !---------------------------------------------------------------------- |
---|
| 2 | ! NEMO system team, System and Interface for oceanic RElocable Nesting |
---|
| 3 | !---------------------------------------------------------------------- |
---|
| 4 | ! |
---|
| 5 | ! DESCRIPTION: |
---|
| 6 | !> @brief |
---|
| 7 | !> This module manage dimension and how to change order of those dimension. |
---|
[5037] | 8 | !> |
---|
[4213] | 9 | !> @details |
---|
| 10 | !> define type TDIM:<br/> |
---|
[5037] | 11 | !> @code |
---|
| 12 | !> TYPE(TDIM) :: tl_dim |
---|
| 13 | !> @endcode |
---|
[4213] | 14 | !> |
---|
[5037] | 15 | !> to initialize a dimension structure:<br/> |
---|
| 16 | !> @code |
---|
| 17 | !> tl_dim=dim_init( cd_name, [id_len,] [ld_uld,] [cd_sname]) |
---|
| 18 | !> @endcode |
---|
[4213] | 19 | !> - cd_name is the dimension name |
---|
[5037] | 20 | !> - id_len is the dimension size [optional] |
---|
| 21 | !> - ld_uld is true if this dimension is the unlimited one [optional] |
---|
| 22 | !> - cd_sname is the dimension short name ('x','y','z','t') [optional] |
---|
[4213] | 23 | !> |
---|
[5037] | 24 | !> to clean dimension structure:<br/> |
---|
| 25 | !> @code |
---|
| 26 | !> CALL dim_clean(tl_dim) |
---|
| 27 | !> @endcode |
---|
| 28 | !> - tl_dim : dimension strucutre or array of dimension structure |
---|
| 29 | !> |
---|
[4213] | 30 | !> to print information about dimension structure:<br/> |
---|
[5037] | 31 | !> @code |
---|
[4213] | 32 | !> CALL dim_print(tl_dim) |
---|
[5037] | 33 | !> @endcode |
---|
[4213] | 34 | !> |
---|
[5037] | 35 | !> to copy dimension structure in another one (using different memory cell):<br/> |
---|
| 36 | !> @code |
---|
| 37 | !> tl_dim2=dim_copy(tl_dim1) |
---|
| 38 | !> @endcode |
---|
| 39 | !> |
---|
[4213] | 40 | !> to get dimension name:<br/> |
---|
| 41 | !> - tl_dim\%c_name |
---|
| 42 | !> |
---|
| 43 | !> to get dimension short name:<br/> |
---|
| 44 | !> - tl_dim\%c_sname |
---|
| 45 | !> |
---|
| 46 | !> to get dimension length:<br/> |
---|
| 47 | !> - tl_dim\%i_len |
---|
| 48 | !> |
---|
| 49 | !> to know if dimension is the unlimited one:<br/> |
---|
| 50 | !> - tl_dim\%l_uld |
---|
| 51 | !> |
---|
[5037] | 52 | !> to get dimension id (for variable or file dimension):<br/> |
---|
[4213] | 53 | !> - tl_dim\%i_id |
---|
| 54 | !> |
---|
[5037] | 55 | !> to know if dimension is used (for variable or file dimension):<br/> |
---|
[4213] | 56 | !> - tl_dim\%l_use |
---|
| 57 | !> |
---|
| 58 | !> Former function or information concern only one dimension. However |
---|
| 59 | !> variables as well as files use usually 4 dimensions.<br/> |
---|
| 60 | !> To easily work with variable we want they will be all 4D and ordered as |
---|
[5037] | 61 | !> following: ('x','y','z','t').<br/> |
---|
[4213] | 62 | !> Functions and subroutines below, allow to reorder dimension of |
---|
| 63 | !> variable.<br/> |
---|
| 64 | !> |
---|
[5037] | 65 | !> Suppose we defined the array of dimension structure below:<br/> |
---|
| 66 | !> @code |
---|
| 67 | !> TYPE(TDIM), DIMENSION(4) :: tl_dim |
---|
[4213] | 68 | !> tl_dim(1)=dim_init( 'X', id_len=10) |
---|
| 69 | !> tl_dim(2)=dim_init( 'T', id_len=3, ld_uld=.TRUE.) |
---|
[5037] | 70 | !> @endcode |
---|
[4213] | 71 | !> |
---|
[5037] | 72 | !> to reorder dimension (default order: ('x','y','z','t')):<br/> |
---|
| 73 | !> @code |
---|
| 74 | !> CALL dim_reorder(tl_dim(:)) |
---|
| 75 | !> @endcode |
---|
[4213] | 76 | !> |
---|
| 77 | !> This subroutine filled dimension structure with unused dimension, |
---|
[5609] | 78 | !> then switch from "disordered" dimension to "ordered" dimension.<br/> |
---|
[5037] | 79 | !> The dimension structure return will be:<br/> |
---|
| 80 | !> tl_dim(1) => 'X', i_len=10, l_use=T, l_uld=F<br/> |
---|
| 81 | !> tl_dim(2) => 'Y', i_len=1, l_use=F, l_uld=F<br/> |
---|
| 82 | !> tl_dim(3) => 'Z', i_len=1, l_use=F, l_uld=F<br/> |
---|
| 83 | !> tl_dim(4) => 'T', i_len=3, l_use=T, l_uld=T<br/> |
---|
[4213] | 84 | !> |
---|
[5037] | 85 | !> After using subroutine dim_reorder you could use functions and subroutine |
---|
[4213] | 86 | !> below.<br/> |
---|
| 87 | !> |
---|
[5037] | 88 | !> to use another dimension order.<br/> |
---|
| 89 | !> @code |
---|
| 90 | !> CALL dim_reorder(tl(dim(:), cl_neworder) |
---|
| 91 | !> @endcode |
---|
| 92 | !> - cl_neworder : character(len=4) (example: 'yxzt') |
---|
| 93 | !> |
---|
[5609] | 94 | !> to switch dimension array from ordered dimension to disordered |
---|
[5037] | 95 | !> dimension:<br/> |
---|
| 96 | !> @code |
---|
[5609] | 97 | !> CALL dim_disorder(tl_dim(:)) |
---|
[5037] | 98 | !> @endcode |
---|
| 99 | !> |
---|
| 100 | !> to fill unused dimension of an array of dimension structure.<br/> |
---|
| 101 | !> @code |
---|
| 102 | !> tl_dimout(:)=dim_fill_unused(tl_dimin(:)) |
---|
| 103 | !> @endcode |
---|
| 104 | !> - tl_dimout(:) : 1D array (4elts) of dimension strcuture |
---|
| 105 | !> - tl_dimin(:) : 1D array (<=4elts) of dimension structure |
---|
| 106 | !> |
---|
| 107 | !> to reshape array of value in "ordered" dimension:<br/> |
---|
| 108 | !> @code |
---|
[4213] | 109 | !> CALL dim_reshape_2xyzt(tl_dim(:), value(:,:,:,:)) |
---|
[5037] | 110 | !> @endcode |
---|
[5609] | 111 | !> - value must be a 4D array of real(8) value "disordered" |
---|
[4213] | 112 | !> |
---|
[5609] | 113 | !> to reshape array of value in "disordered" dimension:<br/> |
---|
[5037] | 114 | !> @code |
---|
[4213] | 115 | !> CALL dim_reshape_xyzt2(tl_dim(:), value(:,:,:,:)) |
---|
[5037] | 116 | !> @endcode |
---|
| 117 | !> - value must be a 4D array of real(8) value "ordered" |
---|
[4213] | 118 | !> |
---|
[5037] | 119 | !> to reorder a 1D array of 4 elements in "ordered" dimension:<br/> |
---|
| 120 | !> @code |
---|
[4213] | 121 | !> CALL dim_reorder_2xyzt(tl_dim(:), tab(:)) |
---|
[5037] | 122 | !> @endcode |
---|
[5609] | 123 | !> - tab must be a 1D array with 4 elements "disordered". |
---|
[4213] | 124 | !> It could be composed of character, integer(4), or logical |
---|
| 125 | !> |
---|
[5609] | 126 | !> to reorder a 1D array of 4 elements in "disordered" dimension:<br/> |
---|
[5037] | 127 | !> @code |
---|
[5609] | 128 | !> CALL dim_reorder_xyzt2(tl_dim(:), tab(:)) |
---|
[5037] | 129 | !> @endcode |
---|
| 130 | !> - tab must be a 1D array with 4 elements "ordered". |
---|
[4213] | 131 | !> It could be composed of character, integer(4), or logical |
---|
| 132 | !> |
---|
[5037] | 133 | !> to get dimension index from a array of dimension structure, |
---|
| 134 | !> given dimension name or short name :<br/> |
---|
| 135 | !> @code |
---|
| 136 | !> index=dim_get_index( tl_dim(:), [cl_name, cl_sname] ) |
---|
| 137 | !> @endcode |
---|
| 138 | !> - tl_dim(:) : array of dimension structure |
---|
| 139 | !> - cl_name : dimension name [optional] |
---|
| 140 | !> - cl_sname: dimension short name [optional] |
---|
| 141 | !> |
---|
| 142 | !> to get dimension id used in an array of dimension structure, |
---|
| 143 | !> given dimension name or short name :<br/> |
---|
| 144 | !> @code |
---|
| 145 | !> id=dim_get_id( tl_dim(:), [cl_name, cl_sname] ) |
---|
| 146 | !> @endcode |
---|
| 147 | !> - tl_dim(:) : array of dimension structure |
---|
| 148 | !> - cl_name : dimension name [optional] |
---|
| 149 | !> - cl_sname: dimension short name [optional] |
---|
| 150 | !> |
---|
| 151 | !> @author J.Paul |
---|
[12080] | 152 | !> |
---|
[5037] | 153 | !> @date November, 2013 - Initial Version |
---|
[12080] | 154 | !> @date September, 2015 |
---|
[6393] | 155 | !> - manage useless (dummy) dimension |
---|
[7646] | 156 | !> @date October, 2016 |
---|
| 157 | !> - dimension allowed read in configuration file |
---|
[12080] | 158 | !> @date May, 2019 |
---|
| 159 | !> - read number of element for each dimension allowed in configuration file |
---|
| 160 | !> - read number of element for each dummy array in configuration file |
---|
[4213] | 161 | !> |
---|
[12080] | 162 | !> @note Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[4213] | 163 | !---------------------------------------------------------------------- |
---|
| 164 | MODULE dim |
---|
[12080] | 165 | |
---|
[4213] | 166 | USE global ! global variable |
---|
| 167 | USE kind ! F90 kind parameter |
---|
| 168 | USE logger ! log file manager |
---|
| 169 | USE fct ! basic useful function |
---|
[12080] | 170 | |
---|
[4213] | 171 | IMPLICIT NONE |
---|
| 172 | ! NOTE_avoid_public_variables_if_possible |
---|
| 173 | |
---|
| 174 | ! type and variable |
---|
| 175 | PUBLIC :: TDIM !< dimension structure |
---|
| 176 | |
---|
[12080] | 177 | PRIVATE :: im_ndumdim !< number of elt in dummy dimension array |
---|
[6393] | 178 | PRIVATE :: cm_dumdim !< dummy dimension array |
---|
[12080] | 179 | PRIVATE :: im_dimX !< number of elt in x dimension array |
---|
| 180 | PRIVATE :: im_dimY !< number of elt in y dimension array |
---|
| 181 | PRIVATE :: im_dimZ !< number of elt in z dimension array |
---|
| 182 | PRIVATE :: im_dimT !< number of elt in t dimension array |
---|
[7646] | 183 | PRIVATE :: cm_dimX !< x dimension array |
---|
| 184 | PRIVATE :: cm_dimY !< y dimension array |
---|
| 185 | PRIVATE :: cm_dimZ !< z dimension array |
---|
| 186 | PRIVATE :: cm_dimT !< t dimension array |
---|
[6393] | 187 | |
---|
[4213] | 188 | ! function and subroutine |
---|
| 189 | PUBLIC :: dim_init !< initialize dimension structure |
---|
| 190 | PUBLIC :: dim_clean !< clean dimension structuree |
---|
| 191 | PUBLIC :: dim_print !< print dimension information |
---|
[5037] | 192 | PUBLIC :: dim_copy !< copy dimension structure |
---|
[5609] | 193 | PUBLIC :: dim_reorder !< filled dimension structure to switch from disordered to ordered dimension |
---|
| 194 | PUBLIC :: dim_disorder !< switch dimension array from ordered to disordered dimension |
---|
[5037] | 195 | PUBLIC :: dim_fill_unused !< filled dimension structure with unused dimension |
---|
| 196 | PUBLIC :: dim_reshape_2xyzt !< reshape array dimension to ('x','y','z','t') |
---|
| 197 | PUBLIC :: dim_reshape_xyzt2 !< reshape array dimension from ('x','y','z','t') |
---|
| 198 | PUBLIC :: dim_reorder_2xyzt !< reorder 1D array to ('x','y','z','t') |
---|
| 199 | PUBLIC :: dim_reorder_xyzt2 !< reorder 1D array from ('x','y','z','t') |
---|
| 200 | PUBLIC :: dim_get_index !< get dimension index in array of dimension structure |
---|
| 201 | PUBLIC :: dim_get_id !< get dimension id in array of dimension structure |
---|
[6393] | 202 | PUBLIC :: dim_get_dummy !< fill dummy dimension array |
---|
| 203 | PUBLIC :: dim_is_dummy !< check if dimension is defined as dummy dimension |
---|
[7646] | 204 | PUBLIC :: dim_def_extra !< read dimension configuration file, and save dimension allowed. |
---|
[4213] | 205 | |
---|
[5037] | 206 | PRIVATE :: dim__reshape_2xyzt_dp ! reshape real(8) 4D array to ('x','y','z','t') |
---|
| 207 | PRIVATE :: dim__reshape_xyzt2_dp ! reshape real(8) 4D array from ('x','y','z','t') |
---|
| 208 | PRIVATE :: dim__reorder_2xyzt_i4 ! reorder integer(4) 1D array to ('x','y','z','t') |
---|
| 209 | PRIVATE :: dim__reorder_xyzt2_i4 ! reorder integer(4) 1D array from ('x','y','z','t') |
---|
| 210 | PRIVATE :: dim__reorder_2xyzt_l ! reorder logical 1D array to ('x','y','z','t') |
---|
| 211 | PRIVATE :: dim__reorder_xyzt2_l ! reorder logical 1D array from ('x','y','z','t') |
---|
| 212 | PRIVATE :: dim__reorder_2xyzt_c ! reorder string 1D array to ('x','y','z','t') |
---|
| 213 | PRIVATE :: dim__reorder_xyzt2_c ! reorder string 1D array from ('x','y','z','t') |
---|
| 214 | PRIVATE :: dim__clean_unit ! clean one dimension structure |
---|
| 215 | PRIVATE :: dim__clean_arr ! clean a array of dimension structure |
---|
| 216 | PRIVATE :: dim__print_unit ! print information on one dimension structure |
---|
| 217 | PRIVATE :: dim__print_arr ! print information on a array of dimension structure |
---|
| 218 | PRIVATE :: dim__copy_unit ! copy dimension structure |
---|
| 219 | PRIVATE :: dim__copy_arr ! copy array of dimension structure |
---|
[7646] | 220 | PRIVATE :: dim__is_allowed |
---|
[4213] | 221 | |
---|
[5037] | 222 | TYPE TDIM !< dimension structure |
---|
| 223 | CHARACTER(LEN=lc) :: c_name = '' !< dimension name |
---|
[4213] | 224 | CHARACTER(LEN=lc) :: c_sname = 'u' !< dimension short name |
---|
[5037] | 225 | INTEGER(i4) :: i_id = 0 !< dimension id |
---|
[4213] | 226 | INTEGER(i4) :: i_len = 1 !< dimension length |
---|
| 227 | LOGICAL :: l_uld = .FALSE. !< dimension unlimited or not |
---|
| 228 | LOGICAL :: l_use = .FALSE. !< dimension used or not |
---|
[5037] | 229 | INTEGER(i4) :: i_2xyzt = 0 !< indices to reshape array to ('x','y','z','t') |
---|
| 230 | INTEGER(i4) :: i_xyzt2 = 0 !< indices to reshape array from ('x','y','z','t') |
---|
[4213] | 231 | END TYPE |
---|
| 232 | |
---|
[12080] | 233 | INTEGER(i4) , SAVE :: im_ndumdim !< number of elt in dummy dimension array |
---|
| 234 | CHARACTER(LEN=lc), DIMENSION(ip_maxdumcfg), SAVE :: cm_dumdim !< dummy dimension |
---|
| 235 | INTEGER(i4) , SAVE :: im_dimX !< number of elt in x dimension array |
---|
| 236 | INTEGER(i4) , SAVE :: im_dimY !< number of elt in y dimension array |
---|
| 237 | INTEGER(i4) , SAVE :: im_dimZ !< number of elt in z dimension array |
---|
| 238 | INTEGER(i4) , SAVE :: im_dimT !< number of elt in t dimension array |
---|
| 239 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg), SAVE :: cm_dimX !< x dimension |
---|
| 240 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg), SAVE :: cm_dimY !< y dimension |
---|
| 241 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg), SAVE :: cm_dimZ !< z dimension |
---|
| 242 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg), SAVE :: cm_dimT !< t dimension |
---|
[6393] | 243 | |
---|
[4213] | 244 | INTERFACE dim_print |
---|
| 245 | MODULE PROCEDURE dim__print_unit ! print information on one dimension |
---|
[5037] | 246 | MODULE PROCEDURE dim__print_arr ! print information on a array of dimension |
---|
[4213] | 247 | END INTERFACE dim_print |
---|
| 248 | |
---|
| 249 | INTERFACE dim_clean |
---|
| 250 | MODULE PROCEDURE dim__clean_unit ! clean one dimension |
---|
[5037] | 251 | MODULE PROCEDURE dim__clean_arr ! clean a array of dimension |
---|
[4213] | 252 | END INTERFACE dim_clean |
---|
| 253 | |
---|
[5037] | 254 | INTERFACE dim_copy |
---|
| 255 | MODULE PROCEDURE dim__copy_unit ! copy dimension structure |
---|
| 256 | MODULE PROCEDURE dim__copy_arr ! copy array of dimension structure |
---|
| 257 | END INTERFACE |
---|
| 258 | |
---|
[4213] | 259 | INTERFACE dim_reshape_2xyzt |
---|
[5037] | 260 | MODULE PROCEDURE dim__reshape_2xyzt_dp ! reshape real(8) 4D array to ('x','y','z','t') |
---|
[4213] | 261 | END INTERFACE dim_reshape_2xyzt |
---|
| 262 | |
---|
| 263 | INTERFACE dim_reshape_xyzt2 |
---|
[5037] | 264 | MODULE PROCEDURE dim__reshape_xyzt2_dp ! reshape real(8) 4D array from ('x','y','z','t') |
---|
[4213] | 265 | END INTERFACE dim_reshape_xyzt2 |
---|
| 266 | |
---|
| 267 | INTERFACE dim_reorder_2xyzt |
---|
[5037] | 268 | MODULE PROCEDURE dim__reorder_2xyzt_i4 ! reorder integer(4) 1D array to ('x','y','z','t') |
---|
| 269 | MODULE PROCEDURE dim__reorder_2xyzt_c ! reorder string 1D array to ('x','y','z','t') |
---|
| 270 | MODULE PROCEDURE dim__reorder_2xyzt_l ! reorder logical 1D array to ('x','y','z','t') |
---|
[4213] | 271 | END INTERFACE dim_reorder_2xyzt |
---|
| 272 | |
---|
| 273 | INTERFACE dim_reorder_xyzt2 |
---|
[5037] | 274 | MODULE PROCEDURE dim__reorder_xyzt2_i4 ! reorder integer(4) 1D array from ('x','y','z','t') |
---|
| 275 | MODULE PROCEDURE dim__reorder_xyzt2_c ! reorder string 1D array from ('x','y','z','t') |
---|
| 276 | MODULE PROCEDURE dim__reorder_xyzt2_l ! reorder logical 1D array from ('x','y','z','t') |
---|
[4213] | 277 | END INTERFACE dim_reorder_xyzt2 |
---|
| 278 | |
---|
| 279 | CONTAINS |
---|
[12080] | 280 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 281 | FUNCTION dim__copy_arr(td_dim) & |
---|
| 282 | & RESULT (tf_dim) |
---|
[4213] | 283 | !------------------------------------------------------------------- |
---|
[5037] | 284 | !> @brief |
---|
| 285 | !> This subroutine copy a array of dimension structure in another one |
---|
| 286 | !> @details |
---|
| 287 | !> see dim__copy_unit |
---|
[4213] | 288 | !> |
---|
[5037] | 289 | !> @warning do not use on the output of a function who create or read an |
---|
| 290 | !> structure (ex: tl_dim=dim_copy(dim_init()) is forbidden). |
---|
| 291 | !> This will create memory leaks. |
---|
| 292 | !> @warning to avoid infinite loop, do not use any function inside |
---|
| 293 | !> this subroutine |
---|
| 294 | !> |
---|
[4213] | 295 | !> @author J.Paul |
---|
[5037] | 296 | !> @date November, 2014 - Initial Version |
---|
[4213] | 297 | ! |
---|
[5037] | 298 | !> @param[in] td_dim array of dimension structure |
---|
| 299 | !> @return copy of input array of dimension structure |
---|
[4213] | 300 | !------------------------------------------------------------------- |
---|
[12080] | 301 | |
---|
[4213] | 302 | IMPLICIT NONE |
---|
[12080] | 303 | |
---|
[4213] | 304 | ! Argument |
---|
[12080] | 305 | TYPE(TDIM), DIMENSION(:), INTENT(IN) :: td_dim |
---|
| 306 | |
---|
[5037] | 307 | ! function |
---|
[12080] | 308 | TYPE(TDIM), DIMENSION(SIZE(td_dim(:))) :: tf_dim |
---|
[5037] | 309 | |
---|
| 310 | ! local variable |
---|
| 311 | ! loop indices |
---|
| 312 | INTEGER(i4) :: ji |
---|
| 313 | !---------------------------------------------------------------- |
---|
| 314 | |
---|
| 315 | DO ji=1,SIZE(td_dim(:)) |
---|
[12080] | 316 | tf_dim(ji)=dim_copy(td_dim(ji)) |
---|
[5037] | 317 | ENDDO |
---|
| 318 | |
---|
| 319 | END FUNCTION dim__copy_arr |
---|
[12080] | 320 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 321 | FUNCTION dim__copy_unit(td_dim) & |
---|
| 322 | & RESULT (tf_dim) |
---|
[5037] | 323 | !------------------------------------------------------------------- |
---|
| 324 | !> @brief |
---|
| 325 | !> This subroutine copy an dimension structure in another one |
---|
| 326 | !> @details |
---|
| 327 | !> dummy function to get the same use for all structure |
---|
| 328 | !> |
---|
| 329 | !> @warning do not use on the output of a function who create or read an |
---|
| 330 | !> structure (ex: tl_dim=dim_copy(dim_init()) is forbidden). |
---|
| 331 | !> This will create memory leaks. |
---|
| 332 | !> @warning to avoid infinite loop, do not use any function inside |
---|
| 333 | !> this subroutine |
---|
| 334 | !> |
---|
| 335 | !> @author J.Paul |
---|
| 336 | !> @date November, 2014 - Initial Version |
---|
| 337 | !> |
---|
| 338 | !> @param[in] td_dim dimension structure |
---|
| 339 | !> @return copy of input dimension structure |
---|
| 340 | !------------------------------------------------------------------- |
---|
[12080] | 341 | |
---|
[5037] | 342 | IMPLICIT NONE |
---|
[12080] | 343 | |
---|
[5037] | 344 | ! Argument |
---|
| 345 | TYPE(TDIM), INTENT(IN) :: td_dim |
---|
[12080] | 346 | |
---|
[5037] | 347 | ! function |
---|
[12080] | 348 | TYPE(TDIM) :: tf_dim |
---|
[5037] | 349 | |
---|
| 350 | ! local variable |
---|
| 351 | !---------------------------------------------------------------- |
---|
| 352 | |
---|
[12080] | 353 | tf_dim=td_dim |
---|
[5037] | 354 | |
---|
| 355 | END FUNCTION dim__copy_unit |
---|
[12080] | 356 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 357 | FUNCTION dim_get_index(td_dim, cd_name, cd_sname) & |
---|
| 358 | & RESULT (if_idx) |
---|
[5037] | 359 | !------------------------------------------------------------------- |
---|
| 360 | !> @brief This function returns dimension index, |
---|
| 361 | !> given dimension name or short name. |
---|
| 362 | !> |
---|
| 363 | !> @details |
---|
| 364 | !> the function check dimension name, in the array of dimension structure. |
---|
| 365 | !> dimension could be used or not. |
---|
| 366 | !> |
---|
| 367 | !> @author J.Paul |
---|
| 368 | !> @date November, 2013 - Initial Version |
---|
[5609] | 369 | !> @date September, 2014 |
---|
| 370 | !> - do not check if dimension used |
---|
[5037] | 371 | !> |
---|
| 372 | !> @param[in] td_dim array of dimension structure |
---|
| 373 | !> @param[in] cd_name dimension name |
---|
| 374 | !> @param[in] cd_sname dimension short name |
---|
| 375 | !> @return dimension index |
---|
| 376 | !------------------------------------------------------------------- |
---|
[12080] | 377 | |
---|
[5037] | 378 | IMPLICIT NONE |
---|
[12080] | 379 | |
---|
[5037] | 380 | ! Argument |
---|
| 381 | TYPE(TDIM) , DIMENSION(:), INTENT(IN) :: td_dim |
---|
[4213] | 382 | CHARACTER(LEN=*), INTENT(IN) :: cd_name |
---|
| 383 | CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: cd_sname |
---|
| 384 | |
---|
[12080] | 385 | ! function |
---|
| 386 | INTEGER(i4) :: if_idx |
---|
| 387 | |
---|
[4213] | 388 | ! local variable |
---|
| 389 | CHARACTER(LEN=lc) :: cl_name |
---|
| 390 | CHARACTER(LEN=lc) :: cl_dim_name |
---|
| 391 | CHARACTER(LEN=lc) :: cl_sname |
---|
| 392 | CHARACTER(LEN=lc) :: cl_dim_sname |
---|
| 393 | |
---|
| 394 | INTEGER(i4) :: il_ndim |
---|
| 395 | |
---|
| 396 | ! loop indices |
---|
| 397 | INTEGER(i4) :: ji |
---|
| 398 | !---------------------------------------------------------------- |
---|
| 399 | ! init |
---|
[12080] | 400 | if_idx=0 |
---|
[4213] | 401 | |
---|
| 402 | il_ndim=SIZE(td_dim(:)) |
---|
| 403 | |
---|
| 404 | ! look for dimension name |
---|
| 405 | cl_name=fct_lower(cd_name) |
---|
[5037] | 406 | ! check if dimension is in array of dimension structure |
---|
[4213] | 407 | DO ji=1,il_ndim |
---|
| 408 | cl_dim_name=fct_lower(td_dim(ji)%c_name) |
---|
[5037] | 409 | IF( TRIM(cl_dim_name) == TRIM(cl_name) )THEN |
---|
[12080] | 410 | if_idx=ji |
---|
| 411 | EXIT |
---|
[4213] | 412 | ENDIF |
---|
| 413 | ENDDO |
---|
| 414 | |
---|
| 415 | ! look for dimension short name |
---|
[12080] | 416 | IF( if_idx == 0 )THEN |
---|
[4213] | 417 | |
---|
| 418 | cl_sname=fct_lower(cd_name) |
---|
[5037] | 419 | ! check if dimension is in array of dimension structure |
---|
[4213] | 420 | DO ji=1,il_ndim |
---|
| 421 | cl_dim_sname=fct_lower(td_dim(ji)%c_sname) |
---|
[5037] | 422 | IF( (TRIM(cl_dim_sname) == TRIM(cl_sname) ) )THEN |
---|
| 423 | CALL logger_debug("DIM GET INDEX: variable short name "//& |
---|
[12080] | 424 | & TRIM(ADJUSTL(cd_name))//" already in file") |
---|
| 425 | if_idx=ji |
---|
[4213] | 426 | EXIT |
---|
| 427 | ENDIF |
---|
| 428 | ENDDO |
---|
[5037] | 429 | |
---|
[4213] | 430 | ENDIF |
---|
| 431 | |
---|
| 432 | ! look for dimension short name |
---|
| 433 | IF( PRESENT(cd_sname) )THEN |
---|
[12080] | 434 | IF( if_idx == 0 )THEN |
---|
[4213] | 435 | |
---|
| 436 | cl_sname=fct_lower(cd_sname) |
---|
[5037] | 437 | ! check if dimension is in array of dimension structure |
---|
[4213] | 438 | DO ji=1,il_ndim |
---|
| 439 | cl_dim_sname=fct_lower(td_dim(ji)%c_sname) |
---|
[5037] | 440 | IF( (TRIM(cl_dim_sname) == TRIM(cl_sname) ) )THEN |
---|
| 441 | CALL logger_debug("DIM GET INDEX: variable short name "//& |
---|
[12080] | 442 | & TRIM(ADJUSTL(cd_sname))//" already in file") |
---|
| 443 | if_idx=ji |
---|
[4213] | 444 | EXIT |
---|
| 445 | ENDIF |
---|
| 446 | ENDDO |
---|
[5037] | 447 | |
---|
[4213] | 448 | ENDIF |
---|
| 449 | ENDIF |
---|
| 450 | |
---|
[5037] | 451 | END FUNCTION dim_get_index |
---|
[12080] | 452 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 453 | FUNCTION dim_get_id(td_dim, cd_name, cd_sname) & |
---|
| 454 | & RESULT (if_id) |
---|
[4213] | 455 | !------------------------------------------------------------------- |
---|
[5037] | 456 | !> @brief This function returns dimension id, in a array of dimension structure, |
---|
| 457 | !> given dimension name, or short name. |
---|
| 458 | !> @note only dimension used are checked. |
---|
[4213] | 459 | !> |
---|
| 460 | !> @author J.Paul |
---|
[5037] | 461 | !> @date November, 2013 - Initial Version |
---|
[4213] | 462 | ! |
---|
[5037] | 463 | !> @param[in] td_dim dimension structure |
---|
| 464 | !> @param[in] cd_name dimension name or short name |
---|
| 465 | !> @param[in] cd_sname dimension short name |
---|
[4213] | 466 | !> @return dimension id |
---|
| 467 | !------------------------------------------------------------------- |
---|
[12080] | 468 | |
---|
[4213] | 469 | IMPLICIT NONE |
---|
[12080] | 470 | |
---|
[4213] | 471 | ! Argument |
---|
| 472 | TYPE(TDIM), DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 473 | CHARACTER(LEN=*), INTENT(IN) :: cd_name |
---|
[4213] | 474 | CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: cd_sname |
---|
| 475 | |
---|
[12080] | 476 | ! function |
---|
| 477 | INTEGER(i4) :: if_id |
---|
| 478 | |
---|
[4213] | 479 | ! local variable |
---|
| 480 | CHARACTER(LEN=lc) :: cl_name |
---|
| 481 | CHARACTER(LEN=lc) :: cl_dim_name |
---|
| 482 | CHARACTER(LEN=lc) :: cl_sname |
---|
| 483 | CHARACTER(LEN=lc) :: cl_dim_sname |
---|
| 484 | |
---|
| 485 | INTEGER(i4) :: il_ndim |
---|
| 486 | |
---|
| 487 | ! loop indices |
---|
| 488 | INTEGER(i4) :: ji |
---|
[5037] | 489 | INTEGER(i4) :: jj |
---|
[4213] | 490 | !---------------------------------------------------------------- |
---|
| 491 | ! init |
---|
[12080] | 492 | if_id=0 |
---|
[4213] | 493 | |
---|
| 494 | il_ndim=SIZE(td_dim(:)) |
---|
| 495 | |
---|
| 496 | ! look for dimension name |
---|
| 497 | cl_name=fct_lower(cd_name) |
---|
[5037] | 498 | ! check if dimension is in array of dimension structure and used |
---|
| 499 | jj=0 |
---|
[4213] | 500 | DO ji=1,il_ndim |
---|
| 501 | cl_dim_name=fct_lower(td_dim(ji)%c_name) |
---|
| 502 | IF( TRIM(cl_dim_name) == TRIM(cl_name) .AND. & |
---|
[5037] | 503 | & td_dim(ji)%l_use )THEN |
---|
| 504 | IF( td_dim(ji)%i_id /= 0 )THEN |
---|
[12080] | 505 | if_id=td_dim(ji)%i_id |
---|
[5037] | 506 | EXIT |
---|
| 507 | ENDIF |
---|
[4213] | 508 | ENDIF |
---|
| 509 | ENDDO |
---|
| 510 | |
---|
| 511 | ! look for dimension short name |
---|
[12080] | 512 | IF( if_id == 0 )THEN |
---|
[4213] | 513 | |
---|
| 514 | cl_sname=fct_lower(cd_name) |
---|
[5037] | 515 | ! check if dimension is in array of dimension structure and used |
---|
| 516 | jj=0 |
---|
[4213] | 517 | DO ji=1,il_ndim |
---|
| 518 | cl_dim_sname=fct_lower(td_dim(ji)%c_sname) |
---|
| 519 | IF( (TRIM(cl_dim_sname) == TRIM(cl_sname) ).AND.& |
---|
[5037] | 520 | & td_dim(ji)%l_use )THEN |
---|
| 521 | IF( td_dim(ji)%i_id /= 0 )THEN |
---|
[12080] | 522 | if_id=td_dim(ji)%i_id |
---|
[5037] | 523 | EXIT |
---|
| 524 | ENDIF |
---|
[4213] | 525 | ENDIF |
---|
| 526 | ENDDO |
---|
[5037] | 527 | |
---|
[4213] | 528 | ENDIF |
---|
| 529 | |
---|
| 530 | ! look for dimension short name |
---|
| 531 | IF( PRESENT(cd_sname) )THEN |
---|
[12080] | 532 | IF( if_id == 0 )THEN |
---|
[4213] | 533 | |
---|
| 534 | cl_sname=fct_lower(cd_sname) |
---|
[5037] | 535 | ! check if dimension is in array of dimension structure and used |
---|
| 536 | jj=0 |
---|
[4213] | 537 | DO ji=1,il_ndim |
---|
| 538 | cl_dim_sname=fct_lower(td_dim(ji)%c_sname) |
---|
| 539 | IF( (TRIM(cl_dim_sname) == TRIM(cl_sname) ).AND.& |
---|
[12080] | 540 | & td_dim(ji)%l_use )THEN |
---|
[5037] | 541 | IF( td_dim(ji)%i_id /= 0 )THEN |
---|
[12080] | 542 | if_id=td_dim(ji)%i_id |
---|
[5037] | 543 | EXIT |
---|
| 544 | ENDIF |
---|
[4213] | 545 | ENDIF |
---|
| 546 | ENDDO |
---|
[5037] | 547 | |
---|
[4213] | 548 | ENDIF |
---|
| 549 | ENDIF |
---|
| 550 | |
---|
[5037] | 551 | END FUNCTION dim_get_id |
---|
[12080] | 552 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 553 | FUNCTION dim_init(cd_name, id_len, ld_uld, cd_sname, ld_use) & |
---|
| 554 | & RESULT (tf_dim) |
---|
[4213] | 555 | !------------------------------------------------------------------- |
---|
[5037] | 556 | !> @brief This function initialize a dimension structure with given |
---|
| 557 | !> name.<br/> |
---|
| 558 | !> @details |
---|
| 559 | !> Optionally length could be inform, as well as short name and if dimension |
---|
| 560 | !> is unlimited or not.<br/> |
---|
[5609] | 561 | !> By default, define dimension is supposed to be used. |
---|
| 562 | !> Optionally you could force a defined dimension to be unused. |
---|
[4213] | 563 | !> |
---|
| 564 | !> @author J.Paul |
---|
[5037] | 565 | !> @date November, 2013 - Initial Version |
---|
[5609] | 566 | !> @date February, 2015 |
---|
| 567 | !> - add optional argument to define dimension unused |
---|
| 568 | !> @date July, 2015 |
---|
| 569 | !> - Bug fix: inform order to disorder table instead of disorder to order |
---|
| 570 | !> table |
---|
[12080] | 571 | !> @date May, 2019 |
---|
| 572 | !> - use number of element for each dimention allowed, instead of while loop |
---|
| 573 | !> |
---|
[5037] | 574 | !> @param[in] cd_name dimension name |
---|
| 575 | !> @param[in] id_len dimension length |
---|
| 576 | !> @param[in] ld_uld dimension unlimited |
---|
| 577 | !> @param[in] cd_sname dimension short name |
---|
[6393] | 578 | !> @param[in] ld_use dimension use or not |
---|
[4213] | 579 | !> @return dimension structure |
---|
| 580 | !------------------------------------------------------------------- |
---|
[12080] | 581 | |
---|
[4213] | 582 | IMPLICIT NONE |
---|
| 583 | |
---|
| 584 | ! Argument |
---|
| 585 | CHARACTER(LEN=*), INTENT(IN) :: cd_name |
---|
| 586 | INTEGER(i4), INTENT(IN), OPTIONAL :: id_len |
---|
| 587 | LOGICAL, INTENT(IN), OPTIONAL :: ld_uld |
---|
| 588 | CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: cd_sname |
---|
[5609] | 589 | LOGICAL, INTENT(IN), OPTIONAL :: ld_use |
---|
[4213] | 590 | |
---|
[12080] | 591 | ! function |
---|
| 592 | TYPE(TDIM) :: tf_dim |
---|
| 593 | |
---|
[4213] | 594 | ! local variable |
---|
| 595 | CHARACTER(LEN=lc) :: cl_name |
---|
| 596 | CHARACTER(LEN=lc) :: cl_sname |
---|
| 597 | !---------------------------------------------------------------- |
---|
| 598 | |
---|
| 599 | ! clean dimension |
---|
[12080] | 600 | CALL dim_clean(tf_dim) |
---|
[4213] | 601 | |
---|
| 602 | cl_name=fct_upper(cd_name) |
---|
| 603 | |
---|
[5037] | 604 | CALL logger_debug( & |
---|
[4213] | 605 | & " DIM INIT: dimension name: "//TRIM(cl_name) ) |
---|
[12080] | 606 | tf_dim%c_name=TRIM(ADJUSTL(cd_name)) |
---|
[4213] | 607 | |
---|
| 608 | IF( PRESENT(id_len) )THEN |
---|
[5037] | 609 | CALL logger_debug( & |
---|
[4213] | 610 | & " DIM INIT: dimension length: "//fct_str(id_len) ) |
---|
[12080] | 611 | tf_dim%i_len=id_len |
---|
[4213] | 612 | ENDIF |
---|
| 613 | |
---|
| 614 | ! define dimension is supposed to be used |
---|
[5609] | 615 | IF( PRESENT(ld_use) )THEN |
---|
[12080] | 616 | tf_dim%l_use=ld_use |
---|
[5609] | 617 | ELSE |
---|
[12080] | 618 | tf_dim%l_use=.TRUE. |
---|
[5609] | 619 | ENDIF |
---|
[4213] | 620 | |
---|
| 621 | IF( PRESENT(cd_sname) )THEN |
---|
| 622 | |
---|
| 623 | cl_sname=fct_lower(cd_sname) |
---|
| 624 | |
---|
| 625 | IF( TRIM(cl_sname) == 'x' .OR. & |
---|
| 626 | & TRIM(cl_sname) == 'y' .OR. & |
---|
| 627 | & TRIM(cl_sname) == 'z' .OR. & |
---|
| 628 | & TRIM(cl_sname) == 't' )THEN |
---|
[5037] | 629 | CALL logger_debug( & |
---|
[4213] | 630 | & " DIM INIT: dimension short name: "//TRIM(cd_sname) ) |
---|
[12080] | 631 | tf_dim%c_sname=TRIM(cd_sname) |
---|
[4213] | 632 | ELSE |
---|
| 633 | CALL logger_warn("DIM INIT: invalid short name."//& |
---|
| 634 | " choose between ('x','y','z','t')") |
---|
| 635 | ENDIF |
---|
| 636 | ENDIF |
---|
| 637 | |
---|
[12080] | 638 | IF( TRIM(fct_lower(tf_dim%c_sname)) == 'u' )THEN |
---|
[4213] | 639 | |
---|
| 640 | cl_name=fct_lower(cd_name) |
---|
| 641 | |
---|
[12080] | 642 | IF( dim__is_allowed(TRIM(cl_name), cm_dimX(:), im_dimX) )THEN |
---|
| 643 | tf_dim%c_sname='x' |
---|
| 644 | ELSEIF( dim__is_allowed(TRIM(cl_name), cm_dimY(:), im_dimY) )THEN |
---|
| 645 | tf_dim%c_sname='y' |
---|
| 646 | ELSEIF( dim__is_allowed(TRIM(cl_name), cm_dimZ(:), im_dimZ) )THEN |
---|
| 647 | tf_dim%c_sname='z' |
---|
| 648 | ELSEIF( dim__is_allowed(TRIM(cl_name), cm_dimT(:), im_dimT) )THEN |
---|
| 649 | tf_dim%c_sname='t' |
---|
[7646] | 650 | ELSE |
---|
| 651 | CALL logger_warn("DIM INIT: "//TRIM(cd_name)//& |
---|
| 652 | " not allowed.") |
---|
| 653 | ENDIF |
---|
[4213] | 654 | |
---|
| 655 | ENDIF |
---|
| 656 | |
---|
| 657 | IF( PRESENT(ld_uld) )THEN |
---|
[5037] | 658 | CALL logger_debug( & |
---|
[4213] | 659 | & " DIM INIT: unlimited dimension: "//fct_str(ld_uld) ) |
---|
[12080] | 660 | tf_dim%l_uld=ld_uld |
---|
[4213] | 661 | ELSE |
---|
[12080] | 662 | IF( TRIM(fct_lower(tf_dim%c_sname)) =='t' )THEN |
---|
| 663 | tf_dim%l_uld=.TRUE. |
---|
[4213] | 664 | ENDIF |
---|
| 665 | ENDIF |
---|
| 666 | |
---|
[5609] | 667 | ! get dimension order indices |
---|
[12080] | 668 | tf_dim%i_xyzt2=SCAN(TRIM(cp_dimorder),TRIM(tf_dim%c_sname)) |
---|
[5037] | 669 | |
---|
[4213] | 670 | END FUNCTION dim_init |
---|
[12080] | 671 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 672 | SUBROUTINE dim__print_arr(td_dim) |
---|
[4213] | 673 | !------------------------------------------------------------------- |
---|
[5037] | 674 | !> @brief This subroutine print informations of an array of dimension. |
---|
[4213] | 675 | !> |
---|
| 676 | !> @author J.Paul |
---|
[5037] | 677 | !> @date November, 2013 - Initial Version |
---|
[4213] | 678 | ! |
---|
[5037] | 679 | !> @param[in] td_dim array of dimension structure |
---|
[4213] | 680 | !------------------------------------------------------------------- |
---|
[12080] | 681 | |
---|
[4213] | 682 | IMPLICIT NONE |
---|
| 683 | |
---|
| 684 | ! Argument |
---|
| 685 | TYPE(TDIM), DIMENSION(:), INTENT(IN) :: td_dim |
---|
| 686 | |
---|
| 687 | ! loop indices |
---|
| 688 | INTEGER(i4) :: ji |
---|
| 689 | !---------------------------------------------------------------- |
---|
| 690 | |
---|
| 691 | DO ji=1,SIZE(td_dim(:)) |
---|
| 692 | CALL dim_print(td_dim(ji)) |
---|
| 693 | ENDDO |
---|
| 694 | |
---|
[5037] | 695 | END SUBROUTINE dim__print_arr |
---|
[12080] | 696 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 697 | SUBROUTINE dim__print_unit(td_dim) |
---|
[4213] | 698 | !------------------------------------------------------------------- |
---|
[5037] | 699 | !> @brief This subrtoutine print dimension information. |
---|
[4213] | 700 | !> |
---|
| 701 | !> @author J.Paul |
---|
[5037] | 702 | !> @date November, 2013 - Initial Version |
---|
[4213] | 703 | ! |
---|
[5037] | 704 | !> @param[in] td_dim dimension structure |
---|
[4213] | 705 | !------------------------------------------------------------------- |
---|
[12080] | 706 | |
---|
[4213] | 707 | IMPLICIT NONE |
---|
| 708 | |
---|
| 709 | ! Argument |
---|
| 710 | TYPE(TDIM), INTENT(IN) :: td_dim |
---|
| 711 | !---------------------------------------------------------------- |
---|
| 712 | |
---|
[12080] | 713 | WRITE(*,'((3x,a,a),(/6x,a,a),(a,i1),(a,i5),2(a,a),2(a,i1))') & |
---|
[4213] | 714 | & " dimension : ",TRIM(td_dim%c_name), & |
---|
| 715 | & " short name : ",TRIM(td_dim%c_sname), & |
---|
| 716 | & " id : ",td_dim%i_id, & |
---|
| 717 | & " len : ",td_dim%i_len, & |
---|
| 718 | & " use : ",TRIM(fct_str(td_dim%l_use)), & |
---|
| 719 | & " uld : ",TRIM(fct_str(td_dim%l_uld)), & |
---|
| 720 | & " xyzt2 : ",td_dim%i_xyzt2, & |
---|
| 721 | & " 2xyzt : ",td_dim%i_2xyzt |
---|
| 722 | |
---|
| 723 | END SUBROUTINE dim__print_unit |
---|
[12080] | 724 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 725 | FUNCTION dim_fill_unused(td_dim) & |
---|
| 726 | & RESULT (tf_dim) |
---|
[4213] | 727 | !------------------------------------------------------------------- |
---|
[5037] | 728 | !> @brief This function fill unused dimension of an array of dimension |
---|
| 729 | !> and return a 4 elts array of dimension structure. |
---|
| 730 | !> @details |
---|
| 731 | !> output dimensions 'x','y','z' and 't' are all informed. |
---|
| 732 | !> |
---|
| 733 | !> @note without input array of dimension, return |
---|
| 734 | !> a 4 elts array of dimension structure all unused |
---|
| 735 | !> (case variable 0d) |
---|
| 736 | !> |
---|
[4213] | 737 | !> @author J.Paul |
---|
[5037] | 738 | !> @date November, 2013 - Initial Version |
---|
[5609] | 739 | !> @date July, 2015 |
---|
| 740 | !> - Bug fix: use order to disorder table (see dim_init) |
---|
[5037] | 741 | !> |
---|
| 742 | !> @param[in] td_dim array of dimension structure |
---|
| 743 | !> @return 4elts array of dimension structure |
---|
[4213] | 744 | !------------------------------------------------------------------- |
---|
[12080] | 745 | |
---|
[4213] | 746 | IMPLICIT NONE |
---|
[12080] | 747 | |
---|
[4213] | 748 | ! Argument |
---|
[5037] | 749 | TYPE(TDIM), DIMENSION(:), INTENT(IN), OPTIONAL :: td_dim |
---|
[4213] | 750 | |
---|
| 751 | ! function |
---|
[12080] | 752 | TYPE(TDIM), DIMENSION(ip_maxdim) :: tf_dim |
---|
[4213] | 753 | |
---|
| 754 | ! local variable |
---|
[5037] | 755 | CHARACTER(LEN=lc) :: cl_dimin |
---|
| 756 | INTEGER(i4) , DIMENSION(1) :: il_ind ! index |
---|
| 757 | |
---|
[4213] | 758 | ! loop indices |
---|
[5037] | 759 | INTEGER(i4) :: ji |
---|
[4213] | 760 | !---------------------------------------------------------------- |
---|
| 761 | |
---|
[5037] | 762 | IF( PRESENT(td_dim) )THEN |
---|
[12080] | 763 | tf_dim(1:SIZE(td_dim(:)))=td_dim(:) |
---|
[5037] | 764 | ENDIF |
---|
| 765 | ! concatenate short nem dimension in a character string |
---|
[12080] | 766 | cl_dimin=fct_lower(fct_concat(tf_dim(:)%c_sname)) |
---|
[5037] | 767 | DO ji = 1, ip_maxdim |
---|
[4213] | 768 | |
---|
[5037] | 769 | ! search missing dimension |
---|
| 770 | IF( INDEX(cl_dimin,TRIM(fct_lower(cp_dimorder(ji:ji)))) == 0 )THEN |
---|
[5609] | 771 | ! search first empty dimension (see dim_init) |
---|
[12080] | 772 | il_ind(:)=MINLOC( tf_dim(:)%i_xyzt2, tf_dim(:)%i_xyzt2 == 0 ) |
---|
[4213] | 773 | |
---|
[5037] | 774 | ! put missing dimension instead of empty one |
---|
[12080] | 775 | tf_dim(il_ind(1))%c_sname=fct_lower(cp_dimorder(ji:ji)) |
---|
[5037] | 776 | ! update output structure |
---|
[12080] | 777 | tf_dim(il_ind(1))%c_name=fct_lower(cp_dimorder(ji:ji)) |
---|
| 778 | tf_dim(il_ind(1))%i_xyzt2=ji |
---|
| 779 | tf_dim(il_ind(1))%i_len=1 |
---|
| 780 | tf_dim(il_ind(1))%l_use=.FALSE. |
---|
[4213] | 781 | ENDIF |
---|
| 782 | |
---|
[5037] | 783 | ENDDO |
---|
| 784 | |
---|
| 785 | END FUNCTION dim_fill_unused |
---|
[12080] | 786 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 787 | SUBROUTINE dim_reorder(td_dim, cd_dimorder) |
---|
[4213] | 788 | !------------------------------------------------------------------- |
---|
| 789 | !> @brief |
---|
[5037] | 790 | !> This subroutine switch element of an array (4 elts) of dimension |
---|
[4213] | 791 | !> structure |
---|
[5609] | 792 | !> from disordered dimension to ordered dimension <br/> |
---|
[5037] | 793 | !> |
---|
| 794 | !> @details |
---|
| 795 | !> Optionally you could specify dimension order to output |
---|
| 796 | !> (default 'xyzt') |
---|
[4213] | 797 | !> Example: (/'z','x','t','y'/) => (/'x','y','z','t'/) |
---|
[5037] | 798 | !> |
---|
[4213] | 799 | !> @warning this subroutine change dimension order |
---|
| 800 | ! |
---|
| 801 | !> @author J.Paul |
---|
[5037] | 802 | !> @date November, 2013 - Initial Version |
---|
[5609] | 803 | !> @date September, 2014 |
---|
| 804 | !> - allow to choose ordered dimension to be output |
---|
[4213] | 805 | !> |
---|
[5037] | 806 | !> @param[inout] td_dim array of dimension structure |
---|
| 807 | !> @param[in] cd_dimorder dimension order to be output |
---|
[4213] | 808 | !------------------------------------------------------------------- |
---|
[12080] | 809 | |
---|
[4213] | 810 | IMPLICIT NONE |
---|
[12080] | 811 | |
---|
[4213] | 812 | ! Argument |
---|
[5037] | 813 | TYPE(TDIM) , DIMENSION(:), INTENT(INOUT) :: td_dim |
---|
| 814 | CHARACTER(LEN=ip_maxdim) , INTENT(IN ), OPTIONAL :: cd_dimorder |
---|
[4213] | 815 | |
---|
| 816 | ! local variable |
---|
[5037] | 817 | INTEGER(i4) :: il_ind |
---|
| 818 | |
---|
[4213] | 819 | CHARACTER(LEN=lc) :: cl_dimin |
---|
[5037] | 820 | CHARACTER(LEN=lc) :: cl_dimorder |
---|
| 821 | |
---|
[4213] | 822 | TYPE(TDIM) , DIMENSION(ip_maxdim) :: tl_dim |
---|
| 823 | |
---|
| 824 | ! loop indices |
---|
| 825 | INTEGER(i4) :: ji |
---|
| 826 | !---------------------------------------------------------------- |
---|
| 827 | |
---|
| 828 | IF( SIZE(td_dim(:)) /= ip_maxdim )THEN |
---|
[5037] | 829 | CALL logger_error("DIM REORDER: invalid dimension of array dimension.") |
---|
[4213] | 830 | ELSE |
---|
| 831 | |
---|
[5037] | 832 | cl_dimorder=TRIM(cp_dimorder) |
---|
| 833 | IF( PRESENT(cd_dimorder) ) cl_dimorder=TRIM(ADJUSTL(cd_dimorder)) |
---|
| 834 | |
---|
| 835 | ! add id if dimension used and no id |
---|
[4213] | 836 | DO ji=1, ip_maxdim |
---|
| 837 | |
---|
| 838 | IF( td_dim(ji)%l_use )THEN |
---|
[5037] | 839 | IF( td_dim(ji)%i_id == 0 )THEN |
---|
| 840 | td_dim(ji)%i_id=MAXVAL(td_dim(:)%i_id)+1 |
---|
| 841 | ENDIF |
---|
[4213] | 842 | ELSE |
---|
| 843 | td_dim(ji)%i_id=0 |
---|
| 844 | td_dim(ji)%i_xyzt2=0 |
---|
[5037] | 845 | td_dim(ji)%i_2xyzt=0 |
---|
[4213] | 846 | td_dim(ji)%c_sname='u' |
---|
| 847 | td_dim(ji)%c_name='' |
---|
| 848 | td_dim(ji)%l_uld=.FALSE. |
---|
| 849 | ENDIF |
---|
| 850 | |
---|
| 851 | ENDDO |
---|
| 852 | |
---|
| 853 | ! fill unused dimension |
---|
[5037] | 854 | tl_dim(:)=dim_fill_unused(td_dim(:)) |
---|
[4213] | 855 | cl_dimin=fct_lower(fct_concat(tl_dim(:)%c_sname)) |
---|
| 856 | |
---|
| 857 | ! compute input id from output id (xyzt) |
---|
| 858 | DO ji = 1, ip_maxdim |
---|
| 859 | |
---|
[5037] | 860 | il_ind=SCAN(TRIM(cl_dimorder),TRIM(cl_dimin(ji:ji))) |
---|
| 861 | IF( il_ind /= 0 )THEN |
---|
| 862 | tl_dim(ji)%i_xyzt2=il_ind |
---|
[4213] | 863 | ENDIF |
---|
| 864 | |
---|
| 865 | ENDDO |
---|
| 866 | |
---|
| 867 | ! compute output id (xyzt) from input id |
---|
| 868 | DO ji = 1, ip_maxdim |
---|
| 869 | |
---|
[5037] | 870 | il_ind=SCAN(TRIM(cl_dimin),TRIM(cl_dimorder(ji:ji))) |
---|
| 871 | IF( il_ind /= 0 )THEN |
---|
| 872 | tl_dim(ji)%i_2xyzt=il_ind |
---|
[4213] | 873 | ENDIF |
---|
| 874 | |
---|
| 875 | ENDDO |
---|
| 876 | |
---|
| 877 | ! change dimension order to ('x','y','z','t') |
---|
| 878 | td_dim(:)%c_name = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%c_name) |
---|
| 879 | td_dim(:)%c_sname = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%c_sname) |
---|
| 880 | td_dim(:)%i_id = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%i_id ) |
---|
| 881 | td_dim(:)%i_len = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%i_len ) |
---|
| 882 | td_dim(:)%l_uld = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%l_uld ) |
---|
| 883 | td_dim(:)%l_use = dim_reorder_2xyzt(tl_dim(:),tl_dim(:)%l_use ) |
---|
| 884 | td_dim(:)%i_2xyzt = tl_dim(:)%i_2xyzt |
---|
| 885 | td_dim(:)%i_xyzt2 = tl_dim(:)%i_xyzt2 |
---|
| 886 | |
---|
[5037] | 887 | ! clean |
---|
| 888 | CALL dim_clean(tl_dim(:)) |
---|
[4213] | 889 | ENDIF |
---|
| 890 | |
---|
| 891 | END SUBROUTINE dim_reorder |
---|
[12080] | 892 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 893 | SUBROUTINE dim_disorder(td_dim) |
---|
[4213] | 894 | !------------------------------------------------------------------- |
---|
[5037] | 895 | !> @brief This subroutine switch dimension array from ordered dimension ('x','y','z','t') |
---|
[5609] | 896 | !> to disordered dimension. <br/> |
---|
[5037] | 897 | !> @details |
---|
[4213] | 898 | !> Example: (/'x','y','z','t'/) => (/'z','x','t','y'/)<br/> |
---|
[5037] | 899 | ! This is useful to add dimension in a variable or file. |
---|
[4213] | 900 | !> @warning this subroutine change dimension order |
---|
| 901 | ! |
---|
| 902 | !> @author J.Paul |
---|
[5037] | 903 | !> @date November, 2013 - Initial Version |
---|
[4213] | 904 | ! |
---|
[5037] | 905 | !> @param[inout] td_dim array of dimension structure |
---|
[4213] | 906 | !------------------------------------------------------------------- |
---|
[12080] | 907 | |
---|
[4213] | 908 | IMPLICIT NONE |
---|
[12080] | 909 | |
---|
[4213] | 910 | ! Argument |
---|
| 911 | TYPE(TDIM), DIMENSION(:), INTENT(INOUT) :: td_dim |
---|
| 912 | |
---|
| 913 | ! local variable |
---|
| 914 | |
---|
| 915 | ! loop indices |
---|
| 916 | INTEGER(i4) :: ji |
---|
| 917 | INTEGER(i4) :: jj |
---|
| 918 | !---------------------------------------------------------------- |
---|
| 919 | |
---|
| 920 | IF( SIZE(td_dim(:)) /= ip_maxdim )THEN |
---|
[5609] | 921 | CALL logger_error("DIM DISORDER: invalid dimension of array dimension.") |
---|
[4213] | 922 | ELSE |
---|
[5037] | 923 | ! add dummy xyzt2 id to unused dimension |
---|
[4213] | 924 | jj=1 |
---|
| 925 | DO ji = 1, ip_maxdim |
---|
| 926 | IF( .NOT. td_dim(ji)%l_use .AND. td_dim(ji)%i_xyzt2 == 0 )THEN |
---|
| 927 | DO WHILE( ANY( td_dim(:)%i_xyzt2 == jj )) |
---|
| 928 | jj=jj+1 |
---|
| 929 | ENDDO |
---|
| 930 | td_dim(ji)%i_xyzt2=jj |
---|
| 931 | ENDIF |
---|
| 932 | ENDDO |
---|
| 933 | |
---|
| 934 | ! change dimension order from ('x','y','z','t') |
---|
| 935 | td_dim(:)%c_name = dim_reorder_xyzt2(td_dim,td_dim(:)%c_name) |
---|
| 936 | td_dim(:)%c_sname = dim_reorder_xyzt2(td_dim,td_dim(:)%c_sname) |
---|
| 937 | td_dim(:)%i_id = dim_reorder_xyzt2(td_dim,td_dim(:)%i_id ) |
---|
| 938 | td_dim(:)%i_len = dim_reorder_xyzt2(td_dim,td_dim(:)%i_len ) |
---|
| 939 | td_dim(:)%l_uld = dim_reorder_xyzt2(td_dim,td_dim(:)%l_uld ) |
---|
| 940 | td_dim(:)%l_use = dim_reorder_xyzt2(td_dim,td_dim(:)%l_use ) |
---|
| 941 | |
---|
| 942 | ! remove dummy xyzt2 id from unused dimension |
---|
| 943 | DO ji = 1, ip_maxdim |
---|
| 944 | IF( .NOT. td_dim(ji)%l_use )THEN |
---|
| 945 | td_dim(ji)%i_id=0 |
---|
| 946 | td_dim(ji)%i_xyzt2=0 |
---|
| 947 | td_dim(ji)%c_sname='u' |
---|
| 948 | td_dim(ji)%c_name='' |
---|
| 949 | td_dim(ji)%l_uld=.FALSE. |
---|
| 950 | ENDIF |
---|
| 951 | ENDDO |
---|
| 952 | ENDIF |
---|
| 953 | |
---|
[5609] | 954 | END SUBROUTINE dim_disorder |
---|
[12080] | 955 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 956 | FUNCTION dim__reshape_2xyzt_dp(td_dim, dd_value) & |
---|
| 957 | & RESULT (df_value) |
---|
[4213] | 958 | !------------------------------------------------------------------- |
---|
[5037] | 959 | !> @brief This function reshape real(8) 4D array |
---|
| 960 | !> to an ordered array, as defined by dim_reorder.<br/> |
---|
| 961 | !> @details |
---|
[4213] | 962 | !> Example: (/'z','x','t','y'/) => (/'x','y','z','t'/) |
---|
| 963 | ! |
---|
| 964 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 965 | ! |
---|
[5037] | 966 | !> @warning output array dimension differ from input array dimension |
---|
[4213] | 967 | ! |
---|
| 968 | !> @author J.Paul |
---|
[5037] | 969 | !> @date November, 2013 - Initial Version |
---|
[12080] | 970 | !> @date January, 2019 |
---|
| 971 | !> - do not reshape array already order |
---|
| 972 | !> |
---|
[5037] | 973 | !> @param[in] td_dim array of dimension structure |
---|
| 974 | !> @param[in] dd_value array of value to reshape |
---|
| 975 | !> @return array of value reshaped |
---|
[4213] | 976 | !------------------------------------------------------------------- |
---|
[12080] | 977 | |
---|
[4213] | 978 | IMPLICIT NONE |
---|
| 979 | |
---|
| 980 | ! Argument |
---|
| 981 | TYPE(TDIM), DIMENSION(:) , INTENT(IN) :: td_dim |
---|
| 982 | REAL(dp) , DIMENSION(:,:,:,:), INTENT(IN) :: dd_value |
---|
| 983 | |
---|
| 984 | ! function |
---|
| 985 | REAL(dp), DIMENSION(td_dim(1)%i_len, & |
---|
[12080] | 986 | & td_dim(2)%i_len, & |
---|
| 987 | & td_dim(3)%i_len, & |
---|
| 988 | & td_dim(4)%i_len) :: df_value |
---|
[4213] | 989 | |
---|
| 990 | ! local variable |
---|
| 991 | INTEGER(i4) , DIMENSION(ip_maxdim) :: il_shape |
---|
| 992 | CHARACTER(LEN=lc) :: cl_dim |
---|
| 993 | |
---|
| 994 | ! loop indices |
---|
| 995 | INTEGER(i4) :: ji |
---|
[12080] | 996 | INTEGER(i4) :: jj |
---|
| 997 | INTEGER(i4) :: jk |
---|
| 998 | INTEGER(i4) :: jl |
---|
[4213] | 999 | !---------------------------------------------------------------- |
---|
| 1000 | |
---|
| 1001 | IF( SIZE(td_dim(:)) /= ip_maxdim )THEN |
---|
[5609] | 1002 | CALL logger_error("DIM RESHAPE 2 XYZT: invalid dimension of "//& |
---|
| 1003 | & "array dimension.") |
---|
[4213] | 1004 | ELSE |
---|
| 1005 | |
---|
| 1006 | IF( ANY(td_dim(:)%i_2xyzt==0) .OR. ANY(td_dim(:)%i_xyzt2==0) )THEN |
---|
| 1007 | |
---|
| 1008 | CALL logger_fatal( & |
---|
[5609] | 1009 | & " DIM RESHAPE 2 XYZT: you should have run dim_reorder"// & |
---|
| 1010 | & " before running RESHAPE" ) |
---|
[4213] | 1011 | |
---|
| 1012 | ENDIF |
---|
| 1013 | |
---|
| 1014 | il_shape=SHAPE(dd_value) |
---|
| 1015 | ! check input dimension |
---|
| 1016 | IF( ANY(il_shape(:) /= (/ td_dim(td_dim(1)%i_xyzt2)%i_len, & |
---|
| 1017 | & td_dim(td_dim(2)%i_xyzt2)%i_len, & |
---|
| 1018 | & td_dim(td_dim(3)%i_xyzt2)%i_len, & |
---|
| 1019 | & td_dim(td_dim(4)%i_xyzt2)%i_len /)) )THEN |
---|
| 1020 | |
---|
| 1021 | DO ji=1,ip_maxdim |
---|
[5037] | 1022 | CALL logger_debug(" DIM RESHAPE 2 XYZT: dim "//& |
---|
[12080] | 1023 | & TRIM(td_dim(td_dim(ji)%i_xyzt2)%c_name)//" "//& |
---|
| 1024 | & TRIM(fct_str(td_dim(td_dim(ji)%i_xyzt2)%i_len))//" vs "//& |
---|
| 1025 | & TRIM(fct_str(il_shape(ji))) ) |
---|
[4213] | 1026 | ENDDO |
---|
[5037] | 1027 | CALL logger_fatal(" DIM RESHAPE 2 XYZT: wrong input dimensions " ) |
---|
[4213] | 1028 | |
---|
| 1029 | ELSE |
---|
| 1030 | |
---|
| 1031 | ! write some informations |
---|
| 1032 | cl_dim="(/" |
---|
| 1033 | DO ji=1,ip_maxdim-1 |
---|
| 1034 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(il_shape(ji)))//',' |
---|
| 1035 | ENDDO |
---|
| 1036 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(il_shape(ip_maxdim)))//"/)" |
---|
| 1037 | |
---|
[5037] | 1038 | CALL logger_debug(" DIM RESHAPE 2 XYZT: input dimensions are "//& |
---|
[4213] | 1039 | & TRIM(cl_dim) ) |
---|
| 1040 | |
---|
| 1041 | cl_dim="(/" |
---|
| 1042 | DO ji=1,ip_maxdim-1 |
---|
| 1043 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(td_dim(ji)%i_len))//',' |
---|
| 1044 | ENDDO |
---|
| 1045 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(td_dim(ip_maxdim)%i_len))//"/)" |
---|
| 1046 | |
---|
[5037] | 1047 | CALL logger_debug(" DIM RESHAPE 2 XYZT: ouput dimensions should be "//& |
---|
[4213] | 1048 | & TRIM(cl_dim) ) |
---|
| 1049 | |
---|
[12080] | 1050 | IF( td_dim(1)%i_xyzt2 == 1 .AND. & |
---|
| 1051 | & td_dim(2)%i_xyzt2 == 2 .AND. & |
---|
| 1052 | & td_dim(3)%i_xyzt2 == 3 .AND. & |
---|
| 1053 | & td_dim(4)%i_xyzt2 == 4 )THEN |
---|
| 1054 | |
---|
| 1055 | DO jl=1,td_dim(4)%i_len |
---|
| 1056 | DO jk=1,td_dim(3)%i_len |
---|
| 1057 | DO jj=1,td_dim(2)%i_len |
---|
| 1058 | DO ji=1,td_dim(1)%i_len |
---|
| 1059 | df_value(ji,jj,jk,jl)=dd_value(ji,jj,jk,jl) |
---|
| 1060 | ENDDO |
---|
| 1061 | ENDDO |
---|
| 1062 | ENDDO |
---|
| 1063 | ENDDO |
---|
| 1064 | |
---|
| 1065 | ELSE |
---|
| 1066 | |
---|
[4213] | 1067 | ! reorder dimension to x,y,z,t |
---|
[12080] | 1068 | df_value(:,:,:,:)=RESHAPE(SOURCE=dd_value(:,:,:,:),& |
---|
| 1069 | & SHAPE = (/ td_dim(1)%i_len, & |
---|
| 1070 | & td_dim(2)%i_len, & |
---|
| 1071 | & td_dim(3)%i_len, & |
---|
| 1072 | & td_dim(4)%i_len /),& |
---|
| 1073 | & ORDER = (/ td_dim(1)%i_2xyzt, & |
---|
| 1074 | & td_dim(2)%i_2xyzt, & |
---|
| 1075 | & td_dim(3)%i_2xyzt, & |
---|
| 1076 | & td_dim(4)%i_2xyzt /)) |
---|
| 1077 | ENDIF |
---|
[4213] | 1078 | ENDIF |
---|
| 1079 | ENDIF |
---|
| 1080 | |
---|
| 1081 | END FUNCTION dim__reshape_2xyzt_dp |
---|
[12080] | 1082 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1083 | FUNCTION dim__reshape_xyzt2_dp(td_dim, dd_value) & |
---|
| 1084 | & RESULT (df_value) |
---|
[4213] | 1085 | !------------------------------------------------------------------- |
---|
[5037] | 1086 | !> @brief This function reshape ordered real(8) 4D array with dimension |
---|
[5609] | 1087 | !> (/'x','y','z','t'/) to an "disordered" array.<br/> |
---|
[5037] | 1088 | !> @details |
---|
[4213] | 1089 | !> Example: (/'x','y','z','t'/) => (/'z','x','t','y'/) |
---|
| 1090 | ! |
---|
| 1091 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1092 | ! |
---|
[5037] | 1093 | !> @warning output array dimension differ from input array dimension |
---|
[4213] | 1094 | ! |
---|
| 1095 | !> @author J.Paul |
---|
[5037] | 1096 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1097 | ! |
---|
[5037] | 1098 | !> @param[in] td_dim array of dimension structure |
---|
| 1099 | !> @param[in] dd_value array of value to reshape |
---|
| 1100 | !> @return array of value reshaped |
---|
[4213] | 1101 | !------------------------------------------------------------------- |
---|
[12080] | 1102 | |
---|
[4213] | 1103 | IMPLICIT NONE |
---|
| 1104 | |
---|
| 1105 | ! Argument |
---|
| 1106 | TYPE(TDIM), DIMENSION(:) , INTENT(IN) :: td_dim |
---|
| 1107 | REAL(dp), DIMENSION(:,:,:,:), INTENT(IN) :: dd_value |
---|
| 1108 | |
---|
| 1109 | ! function |
---|
| 1110 | REAL(dp), DIMENSION(td_dim(td_dim(1)%i_xyzt2)%i_len, & |
---|
[12080] | 1111 | & td_dim(td_dim(2)%i_xyzt2)%i_len, & |
---|
| 1112 | & td_dim(td_dim(3)%i_xyzt2)%i_len, & |
---|
| 1113 | & td_dim(td_dim(4)%i_xyzt2)%i_len) :: df_value |
---|
[4213] | 1114 | |
---|
| 1115 | ! local variable |
---|
| 1116 | INTEGER(i4), DIMENSION(ip_maxdim) :: il_shape |
---|
| 1117 | CHARACTER(LEN=lc) :: cl_dim |
---|
| 1118 | |
---|
| 1119 | ! loop indices |
---|
| 1120 | INTEGER(i4) :: ji |
---|
| 1121 | !---------------------------------------------------------------- |
---|
| 1122 | |
---|
| 1123 | IF( SIZE(td_dim(:)) /= ip_maxdim )THEN |
---|
[5609] | 1124 | CALL logger_error("DIM RESHAPE XYZT 2: invalid dimension of "//& |
---|
| 1125 | & "array dimension.") |
---|
[4213] | 1126 | ELSE |
---|
| 1127 | |
---|
| 1128 | IF( ANY(td_dim(:)%i_xyzt2==0) .OR. ANY(td_dim(:)%i_2xyzt==0) )THEN |
---|
| 1129 | |
---|
| 1130 | CALL logger_fatal( & |
---|
[5609] | 1131 | & " DIM RESHAPE XYZT 2: you should have run dim_reorder"// & |
---|
| 1132 | & " before running RESHAPE" ) |
---|
[4213] | 1133 | |
---|
| 1134 | ENDIF |
---|
| 1135 | |
---|
| 1136 | ! check input dimension |
---|
| 1137 | il_shape=SHAPE(dd_value) |
---|
| 1138 | IF( ANY(il_shape(:)/=td_dim(:)%i_len))THEN |
---|
| 1139 | |
---|
| 1140 | DO ji=1,ip_maxdim |
---|
[5037] | 1141 | CALL logger_trace(" DIM RESHAPE XYZT 2: dim "//& |
---|
[4213] | 1142 | & TRIM(td_dim(ji)%c_name)//" "//& |
---|
| 1143 | & TRIM(fct_str(td_dim(ji)%i_len))//" vs "//& |
---|
| 1144 | & TRIM(fct_str(il_shape(ji))) ) |
---|
| 1145 | ENDDO |
---|
[5037] | 1146 | CALL logger_fatal( "DIM RESHAPE XYZT 2: wrong input dimensions ") |
---|
[4213] | 1147 | |
---|
| 1148 | ELSE |
---|
| 1149 | |
---|
| 1150 | ! write some informations |
---|
| 1151 | cl_dim="(/" |
---|
| 1152 | DO ji=1,ip_maxdim-1 |
---|
| 1153 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(il_shape(ji)))//',' |
---|
| 1154 | ENDDO |
---|
| 1155 | cl_dim=TRIM(cl_dim)//TRIM(fct_str(il_shape(ip_maxdim)))//"/)" |
---|
| 1156 | |
---|
[5037] | 1157 | CALL logger_debug(" DIM RESHAPE XYZT 2: input dimensions are "//& |
---|
[4213] | 1158 | & TRIM(cl_dim) ) |
---|
| 1159 | |
---|
| 1160 | cl_dim="(/" |
---|
| 1161 | DO ji=1,ip_maxdim-1 |
---|
| 1162 | cl_dim=TRIM(cl_dim)//& |
---|
| 1163 | & TRIM(fct_str(td_dim(td_dim(ji)%i_xyzt2)%i_len))//',' |
---|
| 1164 | ENDDO |
---|
| 1165 | cl_dim=TRIM(cl_dim)//& |
---|
| 1166 | & TRIM(fct_str(td_dim(td_dim(ip_maxdim)%i_xyzt2)%i_len))//"/)" |
---|
| 1167 | |
---|
[5037] | 1168 | CALL logger_debug(" DIM RESHAPE XYZT 2: ouput dimensions should be "//& |
---|
[4213] | 1169 | & TRIM(cl_dim) ) |
---|
| 1170 | |
---|
[5037] | 1171 | ! reshape array |
---|
[12080] | 1172 | df_value(:,:,:,:)=RESHAPE(SOURCE=dd_value, & |
---|
| 1173 | & SHAPE = (/ td_dim(td_dim(1)%i_xyzt2)%i_len, & |
---|
| 1174 | & td_dim(td_dim(2)%i_xyzt2)%i_len, & |
---|
| 1175 | & td_dim(td_dim(3)%i_xyzt2)%i_len, & |
---|
| 1176 | & td_dim(td_dim(4)%i_xyzt2)%i_len /),& |
---|
| 1177 | & ORDER = (/ td_dim(1)%i_xyzt2, & |
---|
| 1178 | & td_dim(2)%i_xyzt2, & |
---|
| 1179 | & td_dim(3)%i_xyzt2, & |
---|
| 1180 | & td_dim(4)%i_xyzt2 /)) |
---|
[4213] | 1181 | |
---|
| 1182 | ENDIF |
---|
| 1183 | ENDIF |
---|
| 1184 | |
---|
| 1185 | END FUNCTION dim__reshape_xyzt2_dp |
---|
[12080] | 1186 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1187 | FUNCTION dim__reorder_2xyzt_i4(td_dim, id_arr) & |
---|
| 1188 | & RESULT (if_value) |
---|
[4213] | 1189 | !------------------------------------------------------------------- |
---|
[5037] | 1190 | !> @brief This function reordered integer(4) 1D array to be suitable |
---|
| 1191 | !> with dimension ordered as defined in dim_reorder. |
---|
[4213] | 1192 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1193 | ! |
---|
| 1194 | !> @author J.Paul |
---|
[5037] | 1195 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1196 | ! |
---|
[5037] | 1197 | !> @param[in] td_dim array of dimension structure |
---|
| 1198 | !> @param[in] id_arr array of value to reshape |
---|
| 1199 | !> @return array of value reshaped |
---|
[4213] | 1200 | !------------------------------------------------------------------- |
---|
[12080] | 1201 | |
---|
[4213] | 1202 | IMPLICIT NONE |
---|
| 1203 | |
---|
| 1204 | ! Argument |
---|
| 1205 | TYPE(TDIM) , DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1206 | INTEGER(i4), DIMENSION(:), INTENT(IN) :: id_arr |
---|
[4213] | 1207 | |
---|
| 1208 | ! function |
---|
[12080] | 1209 | INTEGER(i4), DIMENSION(ip_maxdim) :: if_value |
---|
[4213] | 1210 | |
---|
| 1211 | ! loop indices |
---|
| 1212 | INTEGER(i4) :: ji |
---|
| 1213 | !---------------------------------------------------------------- |
---|
| 1214 | |
---|
| 1215 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1216 | & SIZE(id_arr(:)) /= ip_maxdim )THEN |
---|
| 1217 | CALL logger_error("DIM REORDER 2 XYZT: invalid dimension of array dimension"//& |
---|
| 1218 | & " or of array of value.") |
---|
[4213] | 1219 | ELSE |
---|
| 1220 | IF( ANY(td_dim(:)%i_2xyzt==0) )THEN |
---|
| 1221 | |
---|
| 1222 | CALL logger_error( & |
---|
[5609] | 1223 | & " DIM REORDER 2 XYZT: you should have run dim_reorder"//& |
---|
| 1224 | & " before running REORDER" ) |
---|
[4213] | 1225 | |
---|
| 1226 | ENDIF |
---|
| 1227 | |
---|
| 1228 | DO ji=1,ip_maxdim |
---|
[12080] | 1229 | if_value(ji)=id_arr(td_dim(ji)%i_2xyzt) |
---|
[4213] | 1230 | ENDDO |
---|
| 1231 | ENDIF |
---|
| 1232 | |
---|
| 1233 | END FUNCTION dim__reorder_2xyzt_i4 |
---|
[12080] | 1234 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1235 | FUNCTION dim__reorder_xyzt2_i4(td_dim, id_arr) & |
---|
| 1236 | & RESULT (if_value) |
---|
[4213] | 1237 | !------------------------------------------------------------------- |
---|
[5609] | 1238 | !> @brief This function disordered integer(4) 1D array to be suitable with |
---|
[5037] | 1239 | !> initial dimension order (ex: dimension read in file). |
---|
[4213] | 1240 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1241 | ! |
---|
| 1242 | !> @author J.Paul |
---|
[5037] | 1243 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1244 | ! |
---|
[5037] | 1245 | !> @param[in] td_dim array of dimension structure |
---|
| 1246 | !> @param[in] id_arr array of value to reshape |
---|
| 1247 | !> @return array of value reshaped |
---|
[4213] | 1248 | !------------------------------------------------------------------- |
---|
[12080] | 1249 | |
---|
[4213] | 1250 | IMPLICIT NONE |
---|
| 1251 | |
---|
| 1252 | ! Argument |
---|
| 1253 | TYPE(TDIM) , DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1254 | INTEGER(i4), DIMENSION(:), INTENT(IN) :: id_arr |
---|
[12080] | 1255 | |
---|
[4213] | 1256 | ! function |
---|
[12080] | 1257 | INTEGER(i4), DIMENSION(ip_maxdim) :: if_value |
---|
| 1258 | |
---|
[4213] | 1259 | ! loop indices |
---|
| 1260 | INTEGER(i4) :: ji |
---|
| 1261 | !---------------------------------------------------------------- |
---|
| 1262 | |
---|
| 1263 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1264 | & SIZE(id_arr(:)) /= ip_maxdim )THEN |
---|
[5609] | 1265 | CALL logger_error("DIM REORDER XYZT 2: invalid dimension of "//& |
---|
| 1266 | & "array dimension or of array of value.") |
---|
[4213] | 1267 | ELSE |
---|
| 1268 | IF( ANY(td_dim(:)%i_xyzt2==0) )THEN |
---|
| 1269 | |
---|
| 1270 | CALL logger_error( & |
---|
[5609] | 1271 | & " DIM REORDER XYZT 2: you should have run dim_reorder"// & |
---|
| 1272 | & " before running REORDER" ) |
---|
[4213] | 1273 | |
---|
| 1274 | ENDIF |
---|
| 1275 | |
---|
| 1276 | DO ji=1,ip_maxdim |
---|
[12080] | 1277 | if_value(ji)=id_arr(td_dim(ji)%i_xyzt2) |
---|
[4213] | 1278 | ENDDO |
---|
| 1279 | ENDIF |
---|
| 1280 | |
---|
| 1281 | END FUNCTION dim__reorder_xyzt2_i4 |
---|
[12080] | 1282 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1283 | FUNCTION dim__reorder_2xyzt_l(td_dim, ld_arr) & |
---|
| 1284 | & RESULT (lf_arr) |
---|
[4213] | 1285 | !------------------------------------------------------------------- |
---|
[5037] | 1286 | !> @brief This function reordered logical 1D array to be suitable |
---|
| 1287 | !> with dimension ordered as defined in dim_reorder. |
---|
[4213] | 1288 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1289 | ! |
---|
| 1290 | !> @author J.Paul |
---|
[5617] | 1291 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1292 | ! |
---|
[5037] | 1293 | !> @param[in] td_dim array of dimension structure |
---|
| 1294 | !> @param[in] ld_arr array of value to reordered |
---|
| 1295 | !> @return array of value reordered |
---|
[4213] | 1296 | !------------------------------------------------------------------- |
---|
[12080] | 1297 | |
---|
[4213] | 1298 | IMPLICIT NONE |
---|
[12080] | 1299 | |
---|
[4213] | 1300 | ! Argument |
---|
| 1301 | TYPE(TDIM) , DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1302 | LOGICAL , DIMENSION(:), INTENT(IN) :: ld_arr |
---|
[4213] | 1303 | |
---|
| 1304 | ! function |
---|
[12080] | 1305 | LOGICAL, DIMENSION(ip_maxdim) :: lf_arr |
---|
[4213] | 1306 | |
---|
| 1307 | ! loop indices |
---|
| 1308 | INTEGER(i4) :: ji |
---|
| 1309 | !---------------------------------------------------------------- |
---|
| 1310 | |
---|
| 1311 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1312 | & SIZE(ld_arr(:)) /= ip_maxdim )THEN |
---|
| 1313 | CALL logger_error("DIM REORDER 2 XYZT: invalid dimension of array dimension"//& |
---|
| 1314 | & " or of array of value.") |
---|
[4213] | 1315 | ELSE |
---|
| 1316 | IF( ANY(td_dim(:)%i_2xyzt==0) )THEN |
---|
| 1317 | |
---|
| 1318 | CALL logger_error( & |
---|
[5609] | 1319 | & " DIM REORDER 2 XYZT: you should have run dim_reorder"// & |
---|
| 1320 | & " before running REORDER" ) |
---|
[4213] | 1321 | |
---|
| 1322 | ENDIF |
---|
| 1323 | |
---|
| 1324 | DO ji=1,ip_maxdim |
---|
[12080] | 1325 | lf_arr(ji)=ld_arr(td_dim(ji)%i_2xyzt) |
---|
[4213] | 1326 | ENDDO |
---|
| 1327 | ENDIF |
---|
| 1328 | |
---|
| 1329 | END FUNCTION dim__reorder_2xyzt_l |
---|
[12080] | 1330 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1331 | FUNCTION dim__reorder_xyzt2_l(td_dim, ld_arr) & |
---|
| 1332 | & RESULT (lf_arr) |
---|
[4213] | 1333 | !------------------------------------------------------------------- |
---|
[5609] | 1334 | !> @brief This function disordered logical 1D array to be suitable with |
---|
[5037] | 1335 | !> initial dimension order (ex: dimension read in file). |
---|
[4213] | 1336 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1337 | ! |
---|
| 1338 | !> @author J.Paul |
---|
[5037] | 1339 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1340 | ! |
---|
[5037] | 1341 | !> @param[in] td_dim array of dimension structure |
---|
| 1342 | !> @param[in] ld_arr array of value to reordered |
---|
| 1343 | !> @return array of value reordered |
---|
[4213] | 1344 | !------------------------------------------------------------------- |
---|
[12080] | 1345 | |
---|
[4213] | 1346 | IMPLICIT NONE |
---|
| 1347 | |
---|
| 1348 | ! Argument |
---|
| 1349 | TYPE(TDIM) , DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1350 | LOGICAL , DIMENSION(:), INTENT(IN) :: ld_arr |
---|
[12080] | 1351 | |
---|
[4213] | 1352 | ! function |
---|
[12080] | 1353 | LOGICAL, DIMENSION(ip_maxdim) :: lf_arr |
---|
| 1354 | |
---|
[4213] | 1355 | ! loop indices |
---|
| 1356 | INTEGER(i4) :: ji |
---|
| 1357 | !---------------------------------------------------------------- |
---|
| 1358 | |
---|
| 1359 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1360 | & SIZE(ld_arr(:)) /= ip_maxdim )THEN |
---|
| 1361 | CALL logger_error("DIM REORDER XYZT 2: invalid dimension of array dimension"//& |
---|
| 1362 | & " or of array of value.") |
---|
[4213] | 1363 | ELSE |
---|
| 1364 | IF( ANY(td_dim(:)%i_xyzt2==0) )THEN |
---|
| 1365 | |
---|
| 1366 | CALL logger_error( & |
---|
[5609] | 1367 | & " DIM REORDER XYZT 2: you should have run dim_reorder"//& |
---|
| 1368 | & " before running REORDER" ) |
---|
[4213] | 1369 | |
---|
| 1370 | ENDIF |
---|
| 1371 | |
---|
| 1372 | DO ji=1,ip_maxdim |
---|
[12080] | 1373 | lf_arr(ji)=ld_arr(td_dim(ji)%i_xyzt2) |
---|
[4213] | 1374 | ENDDO |
---|
| 1375 | ENDIF |
---|
| 1376 | |
---|
| 1377 | END FUNCTION dim__reorder_xyzt2_l |
---|
[12080] | 1378 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1379 | FUNCTION dim__reorder_2xyzt_c(td_dim, cd_arr) & |
---|
| 1380 | & RESULT (cf_arr) |
---|
[4213] | 1381 | !------------------------------------------------------------------- |
---|
[5037] | 1382 | !> @brief This function reordered string 1D array to be suitable |
---|
| 1383 | !> with dimension ordered as defined in dim_reorder. |
---|
[4213] | 1384 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1385 | ! |
---|
| 1386 | !> @author J.Paul |
---|
[5037] | 1387 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1388 | ! |
---|
[5037] | 1389 | !> @param[in] td_dim array of dimension structure |
---|
| 1390 | !> @param[in] cd_arr array of value to reordered |
---|
| 1391 | !> @return array of value reordered |
---|
[4213] | 1392 | !------------------------------------------------------------------- |
---|
[12080] | 1393 | |
---|
[4213] | 1394 | IMPLICIT NONE |
---|
[12080] | 1395 | |
---|
[4213] | 1396 | ! Argument |
---|
| 1397 | TYPE(TDIM), DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1398 | CHARACTER(LEN=*), DIMENSION(:), INTENT(IN) :: cd_arr |
---|
[12080] | 1399 | |
---|
[4213] | 1400 | ! function |
---|
[12080] | 1401 | CHARACTER(LEN=lc), DIMENSION(ip_maxdim) :: cf_arr |
---|
[4213] | 1402 | |
---|
| 1403 | ! loop indices |
---|
| 1404 | INTEGER(i4) :: ji |
---|
| 1405 | !---------------------------------------------------------------- |
---|
| 1406 | |
---|
| 1407 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1408 | & SIZE(cd_arr(:)) /= ip_maxdim )THEN |
---|
| 1409 | CALL logger_error("DIM REORDER 2 XYZT: invalid dimension of array dimension"//& |
---|
| 1410 | & " or of array of value.") |
---|
[4213] | 1411 | ELSE |
---|
| 1412 | IF( ANY(td_dim(:)%i_2xyzt==0) )THEN |
---|
| 1413 | |
---|
| 1414 | CALL logger_error( & |
---|
[5037] | 1415 | & " DIM REORDER 2 XYZT: you should have run dim_reorder"//& |
---|
[4213] | 1416 | & " before running REORDER" ) |
---|
| 1417 | |
---|
| 1418 | ENDIF |
---|
| 1419 | |
---|
| 1420 | DO ji=1,ip_maxdim |
---|
[12080] | 1421 | cf_arr(ji)=TRIM(cd_arr(td_dim(ji)%i_2xyzt)) |
---|
[4213] | 1422 | ENDDO |
---|
| 1423 | ENDIF |
---|
| 1424 | |
---|
| 1425 | END FUNCTION dim__reorder_2xyzt_c |
---|
[12080] | 1426 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1427 | FUNCTION dim__reorder_xyzt2_c(td_dim, cd_arr) & |
---|
| 1428 | & RESULT (cf_arr) |
---|
[4213] | 1429 | !------------------------------------------------------------------- |
---|
[5609] | 1430 | !> @brief This function disordered string 1D array to be suitable with |
---|
[5037] | 1431 | !> initial dimension order (ex: dimension read in file). |
---|
[4213] | 1432 | !> @note you must have run dim_reorder before use this subroutine |
---|
| 1433 | ! |
---|
| 1434 | !> @author J.Paul |
---|
[5617] | 1435 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1436 | ! |
---|
[5037] | 1437 | !> @param[in] td_dim array of dimension structure |
---|
| 1438 | !> @param[in] cd_arr array of value to reordered |
---|
| 1439 | !> @return array of value reordered |
---|
[4213] | 1440 | !------------------------------------------------------------------- |
---|
[12080] | 1441 | |
---|
[4213] | 1442 | IMPLICIT NONE |
---|
| 1443 | |
---|
| 1444 | ! Argument |
---|
| 1445 | TYPE(TDIM), DIMENSION(:), INTENT(IN) :: td_dim |
---|
[5037] | 1446 | CHARACTER(LEN=*), DIMENSION(:), INTENT(IN) :: cd_arr |
---|
[12080] | 1447 | |
---|
[4213] | 1448 | ! function |
---|
[12080] | 1449 | CHARACTER(LEN=lc), DIMENSION(ip_maxdim) :: cf_arr |
---|
[4213] | 1450 | |
---|
| 1451 | ! loop indices |
---|
| 1452 | INTEGER(i4) :: ji |
---|
| 1453 | !---------------------------------------------------------------- |
---|
| 1454 | |
---|
| 1455 | IF( SIZE(td_dim(:)) /= ip_maxdim .OR. & |
---|
[5037] | 1456 | & SIZE(cd_arr(:)) /= ip_maxdim )THEN |
---|
| 1457 | CALL logger_error("DIM REORDER XYZT 2: invalid dimension of array dimension"//& |
---|
| 1458 | & " or of array of value.") |
---|
[4213] | 1459 | ELSE |
---|
| 1460 | IF( ANY(td_dim(:)%i_xyzt2==0) )THEN |
---|
| 1461 | CALL logger_error( & |
---|
[5609] | 1462 | & " DIM REORDER XYZT 2: you should have run dim_reorder"// & |
---|
| 1463 | & " before running REORDER" ) |
---|
[4213] | 1464 | |
---|
| 1465 | ENDIF |
---|
| 1466 | |
---|
| 1467 | DO ji=1,ip_maxdim |
---|
[12080] | 1468 | cf_arr(ji)=TRIM(cd_arr(td_dim(ji)%i_xyzt2)) |
---|
[4213] | 1469 | ENDDO |
---|
| 1470 | ENDIF |
---|
| 1471 | |
---|
| 1472 | END FUNCTION dim__reorder_xyzt2_c |
---|
[12080] | 1473 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1474 | SUBROUTINE dim__clean_unit(td_dim) |
---|
[4213] | 1475 | !------------------------------------------------------------------- |
---|
[5037] | 1476 | !> @brief This subroutine clean dimension structure. |
---|
[4213] | 1477 | ! |
---|
| 1478 | !> @author J.Paul |
---|
[5037] | 1479 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1480 | ! |
---|
[5037] | 1481 | !> @param[in] td_dim dimension strucutre |
---|
[4213] | 1482 | !------------------------------------------------------------------- |
---|
[12080] | 1483 | |
---|
[4213] | 1484 | IMPLICIT NONE |
---|
[12080] | 1485 | |
---|
[4213] | 1486 | ! Argument |
---|
| 1487 | TYPE(TDIM), INTENT(INOUT) :: td_dim |
---|
| 1488 | |
---|
| 1489 | ! local variable |
---|
| 1490 | TYPE(TDIM) :: tl_dim ! empty dimension strucutre |
---|
| 1491 | !---------------------------------------------------------------- |
---|
| 1492 | |
---|
[5037] | 1493 | CALL logger_trace( & |
---|
| 1494 | & " DIM CLEAN: reset dimension "//TRIM(td_dim%c_name) ) |
---|
[4213] | 1495 | |
---|
| 1496 | ! replace by empty structure |
---|
| 1497 | td_dim=tl_dim |
---|
| 1498 | |
---|
| 1499 | END SUBROUTINE dim__clean_unit |
---|
[12080] | 1500 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1501 | SUBROUTINE dim__clean_arr(td_dim) |
---|
[4213] | 1502 | !------------------------------------------------------------------- |
---|
[5037] | 1503 | !> @brief This subroutine clean array of dimension structure |
---|
[4213] | 1504 | ! |
---|
| 1505 | !> @author J.Paul |
---|
[5037] | 1506 | !> @date November, 2013 - Initial Version |
---|
[4213] | 1507 | ! |
---|
[5037] | 1508 | !> @param[in] td_dim array of dimension strucutre |
---|
[4213] | 1509 | !------------------------------------------------------------------- |
---|
[12080] | 1510 | |
---|
[4213] | 1511 | IMPLICIT NONE |
---|
| 1512 | ! Argument |
---|
| 1513 | TYPE(TDIM), DIMENSION(:), INTENT(INOUT) :: td_dim |
---|
| 1514 | |
---|
| 1515 | ! loop indices |
---|
| 1516 | INTEGER(i4) :: ji |
---|
| 1517 | !---------------------------------------------------------------- |
---|
| 1518 | |
---|
| 1519 | DO ji=1,SIZE(td_dim(:)) |
---|
| 1520 | CALL dim_clean(td_dim(ji)) |
---|
| 1521 | ENDDO |
---|
| 1522 | |
---|
[5037] | 1523 | END SUBROUTINE dim__clean_arr |
---|
[12080] | 1524 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1525 | SUBROUTINE dim_get_dummy(cd_dummy) |
---|
[6393] | 1526 | !------------------------------------------------------------------- |
---|
| 1527 | !> @brief This subroutine fill dummy dimension array |
---|
| 1528 | ! |
---|
| 1529 | !> @author J.Paul |
---|
| 1530 | !> @date September, 2015 - Initial Version |
---|
[12080] | 1531 | !> @date May, 2019 |
---|
| 1532 | !> - read number of dummy element |
---|
| 1533 | !> |
---|
[6393] | 1534 | !> @param[in] cd_dummy dummy configuration file |
---|
| 1535 | !------------------------------------------------------------------- |
---|
[12080] | 1536 | |
---|
[6393] | 1537 | IMPLICIT NONE |
---|
| 1538 | ! Argument |
---|
| 1539 | CHARACTER(LEN=*), INTENT(IN) :: cd_dummy |
---|
| 1540 | |
---|
| 1541 | ! local variable |
---|
| 1542 | INTEGER(i4) :: il_fileid |
---|
| 1543 | INTEGER(i4) :: il_status |
---|
| 1544 | |
---|
| 1545 | LOGICAL :: ll_exist |
---|
| 1546 | |
---|
| 1547 | ! loop indices |
---|
| 1548 | ! namelist |
---|
[12080] | 1549 | INTEGER(i4) :: in_ndumvar |
---|
| 1550 | INTEGER(i4) :: in_ndumdim |
---|
| 1551 | INTEGER(i4) :: in_ndumatt |
---|
[7646] | 1552 | CHARACTER(LEN=lc), DIMENSION(ip_maxdumcfg) :: cn_dumvar |
---|
| 1553 | CHARACTER(LEN=lc), DIMENSION(ip_maxdumcfg) :: cn_dumdim |
---|
| 1554 | CHARACTER(LEN=lc), DIMENSION(ip_maxdumcfg) :: cn_dumatt |
---|
[6393] | 1555 | |
---|
| 1556 | !---------------------------------------------------------------- |
---|
| 1557 | NAMELIST /namdum/ & !< dummy namelist |
---|
[12080] | 1558 | & in_ndumvar,& !< number of variable name |
---|
| 1559 | & in_ndumdim,& !< number of dimension name |
---|
| 1560 | & in_ndumatt,& !< number of attribute name |
---|
[6393] | 1561 | & cn_dumvar, & !< variable name |
---|
| 1562 | & cn_dumdim, & !< dimension name |
---|
| 1563 | & cn_dumatt !< attribute name |
---|
| 1564 | !---------------------------------------------------------------- |
---|
| 1565 | |
---|
| 1566 | ! init |
---|
| 1567 | cm_dumdim(:)='' |
---|
| 1568 | |
---|
| 1569 | ! read namelist |
---|
| 1570 | INQUIRE(FILE=TRIM(cd_dummy), EXIST=ll_exist) |
---|
| 1571 | IF( ll_exist )THEN |
---|
| 1572 | |
---|
| 1573 | il_fileid=fct_getunit() |
---|
| 1574 | |
---|
| 1575 | OPEN( il_fileid, FILE=TRIM(cd_dummy), & |
---|
| 1576 | & FORM='FORMATTED', & |
---|
| 1577 | & ACCESS='SEQUENTIAL', & |
---|
| 1578 | & STATUS='OLD', & |
---|
| 1579 | & ACTION='READ', & |
---|
| 1580 | & IOSTAT=il_status) |
---|
| 1581 | CALL fct_err(il_status) |
---|
| 1582 | IF( il_status /= 0 )THEN |
---|
| 1583 | CALL logger_fatal("DIM GET DUMMY: opening "//TRIM(cd_dummy)) |
---|
| 1584 | ENDIF |
---|
| 1585 | |
---|
| 1586 | READ( il_fileid, NML = namdum ) |
---|
[12080] | 1587 | im_ndumdim = in_ndumdim |
---|
| 1588 | cm_dumdim(:)= cn_dumdim(:) |
---|
[6393] | 1589 | |
---|
| 1590 | CLOSE( il_fileid ) |
---|
| 1591 | |
---|
[12080] | 1592 | IF( im_ndumdim > ip_maxdumcfg )THEN |
---|
| 1593 | CALL logger_fatal("DIM GET dUMMY : too much dummy dimension & |
---|
| 1594 | & ( >"//fct_str(ip_maxdumcfg)//" ). & |
---|
| 1595 | & set ip_maxdumcfg to higher value.") |
---|
| 1596 | ENDIF |
---|
[6393] | 1597 | ENDIF |
---|
| 1598 | |
---|
| 1599 | END SUBROUTINE dim_get_dummy |
---|
[12080] | 1600 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1601 | FUNCTION dim_is_dummy(td_dim) & |
---|
| 1602 | & RESULT (lf_dummy) |
---|
[6393] | 1603 | !------------------------------------------------------------------- |
---|
| 1604 | !> @brief This function check if dimension is defined as dummy dimension |
---|
| 1605 | !> in configuraton file |
---|
| 1606 | !> |
---|
| 1607 | !> @author J.Paul |
---|
| 1608 | !> @date September, 2015 - Initial Version |
---|
[12080] | 1609 | !> @date, May, 2019 |
---|
| 1610 | !> - use number of dummy elt in do-loop |
---|
| 1611 | !> |
---|
[6393] | 1612 | !> @param[in] td_dim dimension structure |
---|
| 1613 | !> @return true if dimension is dummy dimension |
---|
| 1614 | !------------------------------------------------------------------- |
---|
[12080] | 1615 | |
---|
[6393] | 1616 | IMPLICIT NONE |
---|
| 1617 | |
---|
| 1618 | ! Argument |
---|
| 1619 | TYPE(TDIM), INTENT(IN) :: td_dim |
---|
| 1620 | |
---|
| 1621 | ! function |
---|
[12080] | 1622 | LOGICAL :: lf_dummy |
---|
[6393] | 1623 | |
---|
| 1624 | ! loop indices |
---|
| 1625 | INTEGER(i4) :: ji |
---|
| 1626 | !---------------------------------------------------------------- |
---|
| 1627 | |
---|
[12080] | 1628 | lf_dummy=.FALSE. |
---|
| 1629 | DO ji=1,im_ndumdim |
---|
[6393] | 1630 | IF( fct_lower(td_dim%c_name) == fct_lower(cm_dumdim(ji)) )THEN |
---|
[12080] | 1631 | lf_dummy=.TRUE. |
---|
[6393] | 1632 | EXIT |
---|
| 1633 | ENDIF |
---|
| 1634 | ENDDO |
---|
| 1635 | |
---|
| 1636 | END FUNCTION dim_is_dummy |
---|
[12080] | 1637 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1638 | SUBROUTINE dim_def_extra(cd_file) |
---|
[7646] | 1639 | !------------------------------------------------------------------- |
---|
| 1640 | !> @brief This subroutine read dimension configuration file, |
---|
| 1641 | !> and fill array of dimension allowed. |
---|
| 1642 | !> |
---|
| 1643 | !> @author J.Paul |
---|
| 1644 | !> @date Ocotber, 2016 - Initial Version |
---|
[12080] | 1645 | !> @date May, 2019 |
---|
| 1646 | !> - read number of element for each dimention |
---|
[7646] | 1647 | ! |
---|
| 1648 | !> @param[in] cd_file input file (dimension configuration file) |
---|
| 1649 | !------------------------------------------------------------------- |
---|
[12080] | 1650 | |
---|
[7646] | 1651 | IMPLICIT NONE |
---|
| 1652 | |
---|
| 1653 | ! Argument |
---|
| 1654 | CHARACTER(LEN=*), INTENT(IN) :: cd_file |
---|
| 1655 | |
---|
| 1656 | ! local variable |
---|
| 1657 | INTEGER(i4) :: il_fileid |
---|
| 1658 | INTEGER(i4) :: il_status |
---|
| 1659 | |
---|
| 1660 | LOGICAL :: ll_exist |
---|
| 1661 | |
---|
| 1662 | ! loop indices |
---|
| 1663 | ! namelist |
---|
[12080] | 1664 | INTEGER(i4) :: in_dimX = 0 |
---|
| 1665 | INTEGER(i4) :: in_dimY = 0 |
---|
| 1666 | INTEGER(i4) :: in_dimZ = 0 |
---|
| 1667 | INTEGER(i4) :: in_dimT = 0 |
---|
[7646] | 1668 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg) :: cn_dimX = '' |
---|
| 1669 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg) :: cn_dimY = '' |
---|
| 1670 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg) :: cn_dimZ = '' |
---|
| 1671 | CHARACTER(LEN=lc), DIMENSION(ip_maxdimcfg) :: cn_dimT = '' |
---|
| 1672 | |
---|
| 1673 | !---------------------------------------------------------------- |
---|
| 1674 | NAMELIST /namdim/ & !< dimension namelist |
---|
[12080] | 1675 | & in_dimX, & !< number of x dimension name allowed |
---|
| 1676 | & in_dimY, & !< number of y dimension name allowed |
---|
| 1677 | & in_dimZ, & !< number of z dimension name allowed |
---|
| 1678 | & in_dimT, & !< number of t dimension name allowed |
---|
[7646] | 1679 | & cn_dimX, & !< x dimension name allowed |
---|
| 1680 | & cn_dimY, & !< y dimension name allowed |
---|
| 1681 | & cn_dimZ, & !< z dimension name allowed |
---|
| 1682 | & cn_dimT !< t dimension name allowed |
---|
| 1683 | |
---|
| 1684 | !---------------------------------------------------------------- |
---|
| 1685 | |
---|
| 1686 | ! init |
---|
| 1687 | cm_dimX(:)='' |
---|
| 1688 | cm_dimY(:)='' |
---|
| 1689 | cm_dimZ(:)='' |
---|
| 1690 | cm_dimT(:)='' |
---|
| 1691 | |
---|
| 1692 | ! read config variable file |
---|
| 1693 | INQUIRE(FILE=TRIM(cd_file), EXIST=ll_exist) |
---|
| 1694 | IF( ll_exist )THEN |
---|
| 1695 | |
---|
| 1696 | il_fileid=fct_getunit() |
---|
| 1697 | |
---|
| 1698 | OPEN( il_fileid, FILE=TRIM(cd_file), & |
---|
| 1699 | & FORM='FORMATTED', & |
---|
| 1700 | & ACCESS='SEQUENTIAL', & |
---|
| 1701 | & STATUS='OLD', & |
---|
| 1702 | & ACTION='READ', & |
---|
| 1703 | & IOSTAT=il_status) |
---|
| 1704 | CALL fct_err(il_status) |
---|
| 1705 | IF( il_status /= 0 )THEN |
---|
| 1706 | CALL logger_fatal("DIM GET DUMMY: opening "//TRIM(cd_file)) |
---|
| 1707 | ENDIF |
---|
| 1708 | |
---|
| 1709 | READ( il_fileid, NML = namdim ) |
---|
[12080] | 1710 | im_dimX =in_dimX |
---|
| 1711 | im_dimY =in_dimY |
---|
| 1712 | im_dimZ =in_dimZ |
---|
| 1713 | im_dimT =in_dimT |
---|
[7646] | 1714 | cm_dimX(:)=cn_dimX(:) |
---|
| 1715 | cm_dimY(:)=cn_dimY(:) |
---|
| 1716 | cm_dimZ(:)=cn_dimZ(:) |
---|
| 1717 | cm_dimT(:)=cn_dimT(:) |
---|
| 1718 | |
---|
| 1719 | CLOSE( il_fileid ) |
---|
| 1720 | |
---|
| 1721 | ELSE |
---|
| 1722 | |
---|
| 1723 | CALL logger_fatal("DIM DEF EXTRA: can't find configuration"//& |
---|
| 1724 | & " file "//TRIM(cd_file)) |
---|
| 1725 | |
---|
| 1726 | ENDIF |
---|
| 1727 | |
---|
| 1728 | END SUBROUTINE dim_def_extra |
---|
[12080] | 1729 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
| 1730 | FUNCTION dim__is_allowed(cd_name, cd_dim, id_ndim) & |
---|
| 1731 | & RESULT (lf_allowed) |
---|
[7646] | 1732 | !------------------------------------------------------------------- |
---|
| 1733 | !> @brief This function check if dimension is allowed, i.e defined |
---|
| 1734 | !> in dimension configuraton file |
---|
| 1735 | !> |
---|
| 1736 | !> @author J.Paul |
---|
[12080] | 1737 | !> @date October, 2016 - Initial Version |
---|
| 1738 | !> @date May, 2019 |
---|
| 1739 | !> - use number of element for each dimention allowed, instead of while loop |
---|
[7646] | 1740 | ! |
---|
| 1741 | !> @param[in] cd_name dimension name |
---|
| 1742 | !> @param[in] cd_dim array dimension name allowed |
---|
[12080] | 1743 | !> @param[in] id_ndim number of elt in array dimension name allowed |
---|
[7646] | 1744 | !> @return true if dimension is allowed |
---|
| 1745 | !------------------------------------------------------------------- |
---|
[12080] | 1746 | |
---|
[7646] | 1747 | IMPLICIT NONE |
---|
| 1748 | |
---|
| 1749 | ! Argument |
---|
| 1750 | CHARACTER(LEN=*), INTENT(IN) :: cd_name |
---|
| 1751 | CHARACTER(LEN=*), DIMENSION(:), INTENT(IN) :: cd_dim |
---|
[12080] | 1752 | INTEGER(i4) , INTENT(IN) :: id_ndim |
---|
[7646] | 1753 | |
---|
| 1754 | ! function |
---|
[12080] | 1755 | LOGICAL :: lf_allowed |
---|
[7646] | 1756 | |
---|
| 1757 | ! loop indices |
---|
| 1758 | INTEGER(i4) :: ji |
---|
| 1759 | !---------------------------------------------------------------- |
---|
| 1760 | |
---|
[12080] | 1761 | lf_allowed=.FALSE. |
---|
| 1762 | DO ji=1,id_ndim |
---|
[7646] | 1763 | IF( TRIM(fct_lower(cd_name)) == TRIM(fct_lower(cd_dim(ji))) )THEN |
---|
[12080] | 1764 | lf_allowed=.TRUE. |
---|
[7646] | 1765 | EXIT |
---|
| 1766 | ENDIF |
---|
| 1767 | ENDDO |
---|
| 1768 | |
---|
| 1769 | END FUNCTION dim__is_allowed |
---|
[12080] | 1770 | !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
---|
[4213] | 1771 | END MODULE dim |
---|
| 1772 | |
---|