source: palm/trunk/SOURCE/pmc_general_mod.f90 @ 3016

Last change on this file since 3016 was 2841, checked in by knoop, 7 years ago

Bugfix: wrong placement of include 'mpif.h' corrected

  • Property svn:keywords set to Id
File size: 7.7 KB
Line 
1 MODULE pmc_general
2
3!------------------------------------------------------------------------------!
4! This file is part of the PALM model system.
5!
6! PALM is free software: you can redistribute it and/or modify it under the
7! terms of the GNU General Public License as published by the Free Software
8! Foundation, either version 3 of the License, or (at your option) any later
9! version.
10!
11! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
12! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
14!
15! You should have received a copy of the GNU General Public License along with
16! PALM. If not, see <http://www.gnu.org/licenses/>.
17!
18! Copyright 1997-2018 Leibniz Universitaet Hannover
19!------------------------------------------------------------------------------!
20!
21! Current revisions:
22! ------------------
23!
24!
25! Former revisions:
26! -----------------
27! $Id: pmc_general_mod.f90 2841 2018-02-27 15:02:57Z Giersch $
28! Bugfix: wrong placement of include 'mpif.h' corrected
29!
30! 2801 2018-02-14 16:01:55Z thiele
31! Introduce particle transfer in nested models.
32!
33! 2718 2018-01-02 08:49:38Z maronga
34! Corrected "Former revisions" section
35!
36! 2696 2017-12-14 17:12:51Z kanani
37! Change in file header (GPL part)
38!
39! 2599 2017-11-01 13:18:45Z hellstea
40! Some cleanup and commenting improvements only.
41!
42! 2101 2017-01-05 16:42:31Z suehring
43!
44! 2000 2016-08-20 18:09:15Z knoop
45! Forced header and separation lines into 80 columns
46!
47! 1901 2016-05-04 15:39:38Z raasch
48! Code clean up. The words server/client changed to parent/child.
49!
50! 1900 2016-05-04 15:27:53Z raasch
51! re-formatted to match PALM style, file renamed again
52!
53! 1808 2016-04-05 19:44:00Z raasch
54! MPI module used by default on all machines
55!
56! 1786 2016-03-08 05:49:27Z raasch
57! change in child-parent data transfer: parent now gets data from child
58! instead of that child puts it to the parent
59!
60! 1779 2016-03-03 08:01:28Z raasch
61! PMC_MPI_REAL removed, dim_order removed from type arraydef,
62! array management changed from linked list to sequential loop
63!
64! 1766 2016-02-29 08:37:15Z raasch
65! +po_data in type arraydef
66!
67! 1764 2016-02-28 12:45:19Z raasch
68! cpp-statement added (nesting can only be used in parallel mode),
69! all kinds given in PALM style
70!
71! 1762 2016-02-25 12:31:13Z hellstea
72! Initial revision by K. Ketelsen
73!
74! Description:
75! ------------
76!
77! Structure definition and utilities of Palm Model Coupler
78!------------------------------------------------------------------------------!
79
80#if defined( __parallel )
81    USE, INTRINSIC ::  ISO_C_BINDING
82
83    USE kinds
84
85#if !defined( __mpifh )
86    USE MPI
87#endif
88
89    IMPLICIT NONE
90
91#if defined( __mpifh )
92    INCLUDE "mpif.h"
93#endif
94
95    PRIVATE
96    SAVE
97
98    INTEGER(iwp), PARAMETER, PUBLIC :: da_desclen       =  8  !<
99    INTEGER(iwp), PARAMETER, PUBLIC :: da_namelen       = 16  !<
100    INTEGER(iwp), PARAMETER, PUBLIC :: pmc_da_name_err  = 10  !<
101    INTEGER(iwp), PARAMETER, PUBLIC :: pmc_max_array    = 32  !< max # of arrays which can be coupled
102    INTEGER(iwp), PARAMETER, PUBLIC :: pmc_max_models   = 64  !<
103    INTEGER(iwp), PARAMETER, PUBLIC :: pmc_status_ok    =  0  !<
104    INTEGER(iwp), PARAMETER, PUBLIC :: pmc_status_error = -1  !<
105
106
107    TYPE, PUBLIC :: xy_ind  !< pair of indices in horizontal plane
108       INTEGER(iwp) ::  i
109       INTEGER(iwp) ::  j
110    END TYPE
111
112    TYPE, PUBLIC ::  arraydef
113       INTEGER(iwp)                   :: coupleindex  !<
114       INTEGER(iwp)                   :: nrdims       !< number of dimensions
115       INTEGER(iwp)                   :: dimkey       !< key for NR dimensions and array type
116       INTEGER(iwp), DIMENSION(4)     :: a_dim        !< size of dimensions
117       TYPE(C_PTR)               :: data         !< pointer of data in parent space
118       TYPE(C_PTR), DIMENSION(2) :: po_data      !< base pointers,
119                                                 !< pmc_s_set_active_data_array
120                                                 !< sets active pointer
121       INTEGER(idp)              :: SendIndex    !< index in send buffer
122       INTEGER(idp)              :: RecvIndex    !< index in receive buffer
123       INTEGER(iwp)              :: SendSize     !< size in send buffer
124       INTEGER(iwp)              :: RecvSize     !< size in receive buffer
125       TYPE(C_PTR)               :: SendBuf      !< data pointer in send buffer
126       TYPE(C_PTR)               :: RecvBuf      !< data pointer in receive buffer
127       CHARACTER(LEN=8)          :: Name         !< name of array
128       TYPE(arraydef), POINTER   :: next
129    END TYPE arraydef
130
131    TYPE(arraydef), PUBLIC, POINTER  :: next
132
133    TYPE, PUBLIC ::  pedef
134       INTEGER(iwp) :: nr_arrays = 0  !< number of arrays which will be transfered
135       INTEGER(iwp) :: nrele          !< number of elements, same for all arrays
136       TYPE(xy_ind), POINTER, DIMENSION(:)   ::  locInd      !< xy index local array for remote PE
137       TYPE(arraydef), POINTER, DIMENSION(:) ::  array_list  !< list of data arrays to be transfered
138    END TYPE pedef
139
140    TYPE, PUBLIC ::  childdef
141       INTEGER(idp) ::  totalbuffersize    !<
142       INTEGER(iwp) ::  model_comm         !< communicator of this model
143       INTEGER(iwp) ::  inter_comm         !< inter communicator model and child
144       INTEGER(iwp) ::  intra_comm         !< intra communicator model and child
145       INTEGER(iwp) ::  model_rank         !< rank of this model
146       INTEGER(iwp) ::  model_npes         !< number of PEs this model
147       INTEGER(iwp) ::  inter_npes         !< number of PEs child model
148       INTEGER(iwp) ::  intra_rank         !< rank within intra_comm
149       INTEGER(iwp) ::  win_parent_child   !< MPI RMA for preparing data on parent AND child side
150       TYPE(pedef), DIMENSION(:), POINTER ::  pes  !< list of all child PEs
151    END TYPE childdef
152
153    TYPE, PUBLIC ::  da_namedef  !< data array name definition
154       INTEGER(iwp)              ::  couple_index  !< unique number of array
155       CHARACTER(LEN=da_desclen) ::  parentdesc    !< parent array description
156       CHARACTER(LEN=da_namelen) ::  nameonparent  !< name of array within parent
157       CHARACTER(LEN=da_desclen) ::  childdesc     !< child array description
158       CHARACTER(LEN=da_namelen) ::  nameonchild   !< name of array within child
159    END TYPE da_namedef
160
161    INTERFACE pmc_g_setname
162       MODULE PROCEDURE pmc_g_setname
163    END INTERFACE pmc_g_setname
164
165    INTERFACE pmc_sort
166       MODULE PROCEDURE sort_2d_i
167    END INTERFACE pmc_sort
168
169    PUBLIC pmc_g_setname, pmc_sort
170
171 CONTAINS
172
173
174   
175 SUBROUTINE pmc_g_setname( mychild, couple_index, aname )
176
177    IMPLICIT NONE
178
179    CHARACTER(LEN=*)              ::  aname         !<
180    INTEGER(iwp), INTENT(IN)      ::  couple_index  !<
181    TYPE(childdef), INTENT(INOUT) ::  mychild       !<
182
183    INTEGER(iwp) ::  i  !<
184
185    TYPE(arraydef), POINTER ::  ar   !<
186    TYPE(pedef), POINTER    ::  ape  !<
187
188!
189!-- Assign array to next free index in array list.
190!-- Set name of array in arraydef structure
191    DO  i = 1, mychild%inter_npes
192       ape => mychild%pes(i)
193       ape%nr_arrays = ape%nr_arrays + 1
194       ape%array_list(ape%nr_arrays)%name        = aname
195       ape%array_list(ape%nr_arrays)%coupleindex = couple_index
196    ENDDO
197
198 END SUBROUTINE pmc_g_setname
199
200
201
202 SUBROUTINE sort_2d_i( array, sort_ind )
203
204    IMPLICIT NONE
205
206    INTEGER(iwp), INTENT(IN)                    ::  sort_ind
207    INTEGER(iwp), DIMENSION(:,:), INTENT(INOUT) ::  array
208
209    INTEGER(iwp) ::  i  !<
210    INTEGER(iwp) ::  j  !<
211    INTEGER(iwp) ::  n  !<
212
213    INTEGER(iwp), DIMENSION(SIZE(array,1)) ::  tmp  !<
214
215    n = SIZE(array,2)
216    DO  j = 1, n-1
217       DO  i = j+1, n
218          IF ( array(sort_ind,i) < array(sort_ind,j) )  THEN
219             tmp = array(:,i)
220             array(:,i) = array(:,j)
221             array(:,j) = tmp
222          ENDIF
223       ENDDO
224    ENDDO
225
226 END  SUBROUTINE sort_2d_i
227
228#endif
229 END MODULE pmc_general
Note: See TracBrowser for help on using the repository browser.