Table of Contents
- Module ppm_module_alloc
- Module ppm_module_check_id
- Module ppm_module_color_edge
- Module ppm_module_copy_image_subs
- Module ppm_module_data
- Module ppm_module_data_io
- Module ppm_module_data_loadbal
- Module ppm_module_data_mesh
- Module ppm_module_data_neighlist
- Module ppm_module_data_rmsh
- Module ppm_module_data_state
- Module ppm_module_data_tree
- Module ppm_module_decomp
- Module ppm_module_define_subs_bc
- Module ppm_module_error
- Module ppm_module_finalize
- Module ppm_module_find_duplicates
- Module ppm_module_find_neigh
- Module ppm_module_impose_part_bc
- Module ppm_module_init
- Module ppm_module_interp_m2p
- Module ppm_module_interp_p2m
- Module ppm_module_io
- Defined Types
- Defined Module Interfaces
- Defined Module Subroutines
- Interface ppm_doio
- Interface ppm_io
- Interface ppm_io_close
- Interface ppm_io_delete
- Interface ppm_io_inquire
- Interface ppm_io_open
- Interface ppm_io_read_ascii
- Interface ppm_io_read_binary
- Interface ppm_io_set_unit
- Interface ppm_io_unused_unit
- Interface ppm_io_write_ascii
- Interface ppm_io_write_binary
- Defined Module Variables
- Module ppm_module_is_initialized
- Module ppm_module_loadbal
- Module ppm_module_log
- Module ppm_module_map
- Module ppm_module_map_connect
- Module ppm_module_map_field
- Module ppm_module_map_field_ghost
- Module ppm_module_map_field_global
- Module ppm_module_map_part
- Module ppm_module_map_part_ghost
- Module ppm_module_map_part_global
- Module ppm_module_map_part_partial
- Module ppm_module_map_part_util
- Module ppm_module_mesh
- Module ppm_module_mesh_alloc
- Module ppm_module_mesh_block_intersect
- Module ppm_module_mesh_define
- Module ppm_module_mesh_derive
- Module ppm_module_mesh_finalize
- Module ppm_module_mesh_on_subs
- Module ppm_module_mesh_store
- Module ppm_module_mktopo
- Module ppm_module_neighlist
- Module ppm_module_print_defines
- Module ppm_module_rmsh
- Module ppm_module_scale_domain
- Module ppm_module_substart
- Module ppm_module_substop
- Module ppm_module_time
- Module ppm_module_topo
- Module ppm_module_topo_alloc
- Module ppm_module_topo_box2subs
- Module ppm_module_topo_check
- Module ppm_module_topo_copy
- Module ppm_module_topo_cost
- Module ppm_module_topo_get
- Module ppm_module_topo_metis_s2p
- Module ppm_module_topo_store
- Module ppm_module_topo_subs2proc
- Module ppm_module_tree
- Module ppm_module_tree_alloc
- Module ppm_module_tree_boxcost
- Module ppm_module_tree_boxcut
- Module ppm_module_tree_cutdir
- Module ppm_module_tree_cutpos
- Module ppm_module_tree_divcheck
- Module ppm_module_tree_done
- Module ppm_module_typedef
- Module ppm_module_user
- Module ppm_module_user_util
- Module ppm_module_util_cart2sph
- Module ppm_module_util_collapse_list
- Module ppm_module_util_commopt
- Module ppm_module_util_cubeq_real
- Module ppm_module_util_eigen_2sym
- Module ppm_module_util_eigen_3sym
- Module ppm_module_util_invert_list
- Module ppm_module_util_matinv_2x2
- Module ppm_module_util_matinv_3x3
- Module ppm_module_util_qsort
- Module ppm_module_util_quadeq_real
- Module ppm_module_util_rank
- Module ppm_module_util_sort
- Module ppm_module_util_time
- Module ppm_module_write
This module provides all PPM allocation routines. These routines allow for allocation, reallocation, growing and shrinking of one- to five- dimensional arrays in all intrinsic data types.
When extending the PPM core or numerical routines these routines must be used. PPM clients may take advantage of these functionalities.
| name | description |
|---|---|
| name | description |
|---|---|
Checks the arguments of the ppm_alloc routines |
Subroutines contained in this interface:
| name | description |
|---|---|
(Re)allocates the memory of 1D real single arrays | |
(Re)allocates the memory of 1D real double arrays | |
(Re)allocates the memory of 1D complex single arrays | |
(Re)allocates the memory of 1D complex double arrays | |
(Re)allocates the memory of 1D integer arrays | |
(Re)allocates the memory of 1D logical arrays | |
(Re)allocates the memory of 1D real single arrays | |
(Re)allocates the memory of 1D real double arrays | |
(Re)allocates the memory of 1D complex single arrays | |
(Re)allocates the memory of 1D complex double arrays | |
(Re)allocates the memory of 1D integer arrays | |
(Re)allocates the memory of 1D logical arrays | |
(Re)allocates the memory of 2D real single arrays | |
(Re)allocates the memory of 2D real double arrays | |
(Re)allocates the memory of 2D complex single arrays | |
(Re)allocates the memory of 2D complex double arrays | |
(Re)allocates the memory of 2D integer arrays | |
(Re)allocates the memory of 2D logical arrays | |
(Re)allocates the memory of 2D real single arrays | |
(Re)allocates the memory of 2D real double arrays | |
(Re)allocates the memory of 2D complex single arrays | |
(Re)allocates the memory of 2D complex double arrays | |
(Re)allocates the memory of 2D integer arrays | |
(Re)allocates the memory of 2D logical arrays | |
(Re)allocates the memory of 3D real single arrays | |
(Re)allocates the memory of 3D real double arrays | |
(Re)allocates the memory of 3D complex single arrays | |
(Re)allocates the memory of 3D complex double arrays | |
(Re)allocates the memory of 3D integer arrays | |
(Re)allocates the memory of 3D logical arrays | |
(Re)allocates the memory of 3D real single arrays | |
(Re)allocates the memory of 3D real double arrays | |
(Re)allocates the memory of 3D complex single arrays | |
(Re)allocates the memory of 3D complex double arrays | |
(Re)allocates the memory of 3D integer arrays | |
(Re)allocates the memory of 3D logical arrays | |
(Re)allocates the memory of 4D real single arrays | |
(Re)allocates the memory of 4D real double arrays | |
(Re)allocates the memory of 4D complex single arrays | |
(Re)allocates the memory of 4D complex double arrays | |
(Re)allocates the memory of 4D integer arrays | |
(Re)allocates the memory of 4D logical arrays | |
(Re)allocates the memory of 4D real single arrays | |
(Re)allocates the memory of 4D real double arrays | |
(Re)allocates the memory of 4D complex single arrays | |
(Re)allocates the memory of 4D complex double arrays | |
(Re)allocates the memory of 4D integer arrays | |
(Re)allocates the memory of 4D logical arrays | |
(Re)allocates the memory of 5D real single arrays | |
(Re)allocates the memory of 5D real double arrays | |
(Re)allocates the memory of 5D complex single arrays | |
(Re)allocates the memory of 5D complex double arrays | |
(Re)allocates the memory of 5D integer arrays | |
(Re)allocates the memory of 5D logical arrays | |
(Re)allocates the memory of 5D real single arrays | |
(Re)allocates the memory of 5D real double arrays | |
(Re)allocates the memory of 5D complex single arrays | |
(Re)allocates the memory of 5D complex double arrays | |
(Re)allocates the memory of 5D integer arrays | |
(Re)allocates the memory of 5D logical arrays | |
(Re)allocates the memory of one-dimensional arrays |
Subroutine ppm_alloc_1dd
(Re)allocates the memory of 1D real double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1ddc
(Re)allocates the memory of 1D complex double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1di
(Re)allocates the memory of 1D integer arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dl
(Re)allocates the memory of 1D logical arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dld
(Re)allocates the memory of 1D real double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dldc
(Re)allocates the memory of 1D complex double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dli
(Re)allocates the memory of 1D integer arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dll
(Re)allocates the memory of 1D logical arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dls
(Re)allocates the memory of 1D real single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dlsc
(Re)allocates the memory of 1D complex single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer array | (:) | (IN) | Upper index limit in leading dim. (>ldl(1)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)).
iopt
integer, , (IN)
Allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1ds
(Re)allocates the memory of 1D real single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_1dsc
(Re)allocates the memory of 1D complex single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Number of desired elements in leading dimension of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:), no intent declared
Pointer to array which is to be (re)allocated.
lda
integer array, (:), (IN)
Number of desired elements in leading dimension of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dd
(Re)allocates the memory of 2D real double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
real array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2ddc
(Re)allocates the memory of 2D complex double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
complex array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2di
(Re)allocates the memory of 2D integer arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
integer array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dl
(Re)allocates the memory of 2D logical arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
logical array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dld
(Re)allocates the memory of 2D real double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dldc
(Re)allocates the memory of 2D complex double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dli
(Re)allocates the memory of 2D integer arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dll
(Re)allocates the memory of 2D logical arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dls
(Re)allocates the memory of 2D real single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dlsc
(Re)allocates the memory of 2D complex single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:2)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:2)).
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2ds
(Re)allocates the memory of 2D real single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
real array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_2dsc
(Re)allocates the memory of 2D complex single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Status upon return of subroutine, 0 on success |
adata
complex array, (:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Status upon return of subroutine, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dd
(Re)allocates the memory of 3D real double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3ddc
(Re)allocates the memory of 3D complex double arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
complex array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3di
(Re)allocates the memory of 3D integer arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
integer array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dl
(Re)allocates the memory of 3D logical arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
logical array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dld
(Re)allocates the memory of 3D real double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dldc
(Re)allocates the memory of 3D complex double arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dli
(Re)allocates the memory of 3D integer arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dll
(Re)allocates the memory of 3D logical arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dls
(Re)allocates the memory of 3D real single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dlsc
(Re)allocates the memory of 3D complex single arrays (pointers) based on absolute lower and upper index bounds.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:3)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:3)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3ds
(Re)allocates the memory of 3D real single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_3dsc
(Re)allocates the memory of 3D complex single arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
complex array, (:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dd
(Re)allocates the memory of 4D real double arrays (pointers) based on the number of elements.
![[Note]](images/note.png) | Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
real array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4ddc
(Re)allocates the memory of 4D complex double arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
complex array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4di
(Re)allocates the memory of 4D integer arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
integer array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dl
(Re)allocates the memory of 4D logical arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
logical array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dld
(Re)allocates the memory of 4D real double arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dldc
(Re)allocates the memory of 4D complex double arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dli
(Re)allocates the memory of 4D integer arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dll
(Re)allocates the memory of 4D logical arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dls
(Re)allocates the memory of 4D real single arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dlsc
(Re)allocates the memory of 4D complex single arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:4)). | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:4)).
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4ds
(Re)allocates the memory of 4D real single arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
real array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_4dsc
(Re)allocates the memory of 4D complex single arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns 0 upon success |
adata
complex array, (:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dd
(Re)allocates the memory of 5D real double arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5ddc
(Re)allocates the memory of 5D complex double arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
complex array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5di
(Re)allocates the memory of 5D integer arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
integer array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dl
(Re)allocates the memory of 5D logical arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
logical array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dld
(Re)allocates the memory of 5D real double arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dldc
(Re)allocates the memory of 5D complex double arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dli
(Re)allocates the memory of 5D integer arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
integer array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dll
(Re)allocates the memory of 5D logical arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
logical array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dls
(Re)allocates the memory of 5D real single arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
real array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dlsc
(Re)allocates the memory of 5D complex single arrays (pointers) based on absolute lower and upper index bounds.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated. | |||
integer array | (:) | (IN) | Lower index limits | ||
integer array | (:) | (IN) | Upper index limits (>ldl(1:5)). | ||
integer | (IN) | allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
adata
complex array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated.
ldl
integer array, (:), (IN)
Lower index limits
ldu
integer array, (:), (IN)
Upper index limits (>ldl(1:5)).
iopt
integer, , (IN)
allocation mode. One of: * ppm_param_alloc_fit * ppm_param_alloc_fit_preserve * ppm_param_alloc_grow * ppm_param_alloc_grow_preserve * ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5ds
(Re)allocates the memory of 5D real single arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_5dsc
(Re)allocates the memory of 5D complex single arrays (pointers) based on the number of elements.
| Note |
|---|---|
if adata is already associated the memory requirement of this routine is 2*size(adata) |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
complex array | (:,:,:,:,:) | Pointer to array which is to be (re)allocated | |||
integer array | (:) | (IN) | Number of desired elements in all dimensions of array. (>0) | ||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success |
adata
complex array, (:,:,:,:,:), no intent declared
Pointer to array which is to be (re)allocated
lda
integer array, (:), (IN)
Number of desired elements in all dimensions of array. (>0)
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_argcheck
Checks the arguments of the ppm_alloc routines
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
character | (IN) | name of calling subroutine | |||
integer | (IN) | Allocation mode. One of: | |||
integer array | (:) | (IN) | Lower index limit in leading dim. | ||
integer | (IN) | Helps to determine the dimension of the caller subroutine (1-5) | |||
integer | (OUT) | Returns status, 0 upon success. | |||
integer array | (:) | (IN) | X | Upper index limit in leading dim. (>ldl(1)). |
caller
character, , (IN)
name of calling subroutine
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_alloc_fit_preserve
- ppm_param_alloc_grow
- ppm_param_alloc_grow_preserve
- ppm_param_dealloc
ldl
integer array, (:), (IN)
Lower index limit in leading dim.
dimension
integer, , (IN)
Helps to determine the dimension of the caller subroutine (1-5)
info
integer, , (OUT)
Returns status, 0 upon success.
(Optional) ldu
integer array, (:), (IN)
Upper index limit in leading dim. (>ldl(1)). OPTIONAL in ppm_alloc_*dl.f
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_alloc_topo
(Re)allocates the memory of one-dimensional arrays (pointers) based on the number of elements.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
ppm_t_topo | |||||
integer | (IN) | Allocation mode. One of: | |||
integer | (OUT) | Returns status, 0 upon success. |
topo
ppm_t_topo, , no intent declared
iopt
integer, , (IN)
Allocation mode. One of:
- ppm_param_alloc_fit
- ppm_param_dealloc
info
integer, , (OUT)
Returns status, 0 upon success.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_mesh_alloc, ppm_module_substop, ppm_module_substart
This module provides the utility routines, which check topology and mesh IDs for their validity.
| name | description |
|---|---|
checks mesh ID | |
checks topology ID |
checks mesh ID
Subroutines contained in this interface:
| name | description |
|---|---|
This subroutine is used to check a given mesh ID for its validity. |
checks topology ID
Subroutines contained in this interface:
| name | description |
|---|---|
This subroutine is used to check a given topology ID for its validity. |
Subroutine ppm_check_meshid
This subroutine is used to check a given mesh ID for its validity.
| Note |
|---|---|
It is recommended to not use this routine too often, it should be typically placed into DEBUG code and only at critical places in the code |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID on which the mesh is defined. | |||
integer | (IN) | Mesh ID to be checked. | |||
logical | (OUT) | Returns | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID on which the mesh is defined.
meshid
integer, , (IN)
Mesh ID to be checked.
valid
logical, , (OUT)
Returns TRUE if the given meshid is valid and defined,
FALSE otherwise.
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_check_topoid
This subroutine is used to check a given topology ID for its validity.
| Note |
|---|---|
It is recommended to not use this routine too often, it should be typically placed into DEBUG code and only at critical places in the code |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID to be checked | |||
logical | (OUT) | Returns | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID to be checked
valid
logical, , (OUT)
Returns TRUE if the given meshid is valid and defined,
FALSE otherwise.
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_write, ppm_module_substop, ppm_module_substart
Colors edges of a graph using binary heap lists, given number of vertices, number of edges, edge list of the graph and optres array as input, respectively.
| name | description |
|---|---|
declaration of type: list
declaration of type: vertex
| name | type | dimension | description |
|---|---|---|---|
integer | color of the vertex | ||
integer | degree of the vertex | ||
integer | dsat-value of the vertex | ||
logical | TRUE if the vertex is colored | ||
integer array |
| list of vertices that the vertex is connected to | |
integer | location of vertex in heap list |
color
integer,
color of the vertex
degree
integer,
degree of the vertex
dsat
integer,
dsat-value of the vertex
iscolored
logical,
TRUE if the vertex is colored
list
integer array, (:)
list of vertices that the vertex is connected to
loc_heap
integer,
location of vertex in heap list
Subroutines contained in this interface:
| name | description |
|---|---|
Given the edge array as input and coloring array to be |
Subroutine ppm_color_edge
Given the edge array as input and coloring array to be modified, colors edges and updates coloring array such that coloring array looks like (p1,p2,c1, …, pX,pY,cZ)
| Note |
|---|---|
This subroutine was introduced in PPM library to replace coloring algorithm of Vizing which was in C++ |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | ||||
integer | (IN) | ||||
integer array | (:) | (INOUT) | |||
integer array | (:) | (INOUT) |
numv
integer, , (IN)
nume
integer, , (IN)
edge_array
integer array, (:), (INOUT)
coloring
integer array, (:), (INOUT)
Used Modules
has no uses
This module provides the decomposition routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine copies the sub domains to ghost sub domains | |
This routine copies the sub domains to ghost sub domains |
Subroutine copy_imgsubs_d
This routine copies the sub domains to ghost sub domains in the case of periodic boundary condition and stores the original ID of the sub domain - this to allow the find neighbours to search (without wrapping space) the list of sub domains and still retrieve the real ID of sub domain.
| Note |
|---|---|
This is a happy going routine: we are comparing the equality of floating point numbers but it works since the value of subs are assigned from the phys min/max and not computed (byte copy). |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | Min. extent of the sub domain including after the call to this | |||
real array | (:,:) | Max. extent of the sub domain including after the call to this | |||
integer | (IN) | Total number of sub domains | |||
integer array | (:) | Real id of the sub domain | |||
integer | (OUT) | Total number of sub domains plus the ghost sub domains | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), no intent declared
Min. extent of the sub domain including after the call to this routine the ghost sub domains
max_sub
real array, (:,:), no intent declared
Max. extent of the sub domain including after the call to this routine the ghost sub domains
nsubs
integer, , (IN)
Total number of sub domains
subid
integer array, (:), no intent declared
Real id of the sub domain
nsubsplus
integer, , (OUT)
Total number of sub domains plus the ghost sub domains
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine copy_imgsubs_s
This routine copies the sub domains to ghost sub domains in the case of periodic boundary condition and stores the original ID of the sub domain - this to allow the find neighbours to search (without wrapping space) the list of sub domains and still retrieve the real ID of sub domain.
| Note |
|---|---|
This is a happy going routine: we are comparing the equality of floating point numbers but it works since the value of subs are assigned from the phys min/max and not computed (byte copy). |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | Min. extent of the sub domain including after the call to this | |||
real array | (:,:) | Max. extent of the sub domain including after the call to this | |||
integer | (IN) | Total number of sub domains | |||
integer array | (:) | Real id of the sub domain | |||
integer | (OUT) | Total number of sub domains plus the ghost sub domains | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), no intent declared
Min. extent of the sub domain including after the call to this routine the ghost sub domains
max_sub
real array, (:,:), no intent declared
Max. extent of the sub domain including after the call to this routine the ghost sub domains
nsubs
integer, , (IN)
Total number of sub domains
subid
integer array, (:), no intent declared
Real id of the sub domain
nsubsplus
integer, , (OUT)
Total number of sub domains plus the ghost sub domains
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Declares global data types and variables.
| Note |
|---|---|
Most of the declared variables in this module should not be accessed directly by the PPM client developer, they are used internally in the library. |
| name | type | dimension | description |
|---|---|---|---|
integer array | (:) | Used for the original on-processor particle IDs in the order in which | |
integer array | (:) | dimensions of the original on-processor particle arrays. | |
integer | the total number of particle fields packed in | ||
integer array | (:) | types of the data on the sendbuffer | |
integer | |||
integer | are we in Debugging mode? | ||
integer | Dimensionality | ||
real array | (:) | ghost offset (double precison) | |
real array | (:) | ghost offset | |
integer array | (:,:) | invert map of ghost for symmetry | |
logical | Has ppm_init been called? | ||
integer array | (:) | ||
integer array | (:) | ||
integer | Precision | ||
integer | |||
integer | |||
integer | MPI Precision | ||
real | |||
real | |||
integer | ID of the next available topology to be used by | ||
integer | |||
integer | the size of the recv buffer (not the array but the number of | ||
integer | |||
integer | the size of the send buffer (not the array but the number of | ||
integer | |||
real | |||
real | |||
integer array | (:) | pointer to particles within the recv buffer | |
real array | (:) | ||
integer array | (:) | pointer to particles within the send buffer | |
integer | |||
real array | (:) | recv buffer for particles | |
real array | (:) | recv buffer for particles | |
integer | the actual size of the receive buffer array | ||
real array | (:) | send buffer for particles | |
real array | (:) | send buffer for particles | |
integer | the actual size of the send buffer array | ||
integer | |||
integer | |||
ppm_ptr_t_topo array | (:) | the PPM topologies array |
ppm_buffer2part
integer array, (:)
Used for the original on-processor particle IDs in the order in which they are in the sendbuffer. Used to push additional particle data on the buffer in the correct order.
ppm_buffer_dim
integer array, (:)
dimensions of the original on-processor particle arrays.
ppm_buffer_set
integer,
the total number of particle fields packed in the send buffer, ie. xp, vp is two sets
ppm_buffer_type
integer array, (:)
types of the data on the sendbuffer
ppm_comm
integer,
ppm_debug
integer,
are we in Debugging mode?
ppm_dim
integer,
Dimensionality
ppm_ghost_offsetd
real array, (:)
ghost offset (double precison)
ghost particles may have a spatial offset compared to their real
particle - we need to store this offset in terms of the buffer id
in order to be able to push/send/pop ghost coordinates in the
ghost_get and ghost_put mapping; this is needed when using Verlet
lists: here nothing is remapped and for symmetry we need both to
put the particle forces etc. and to get the updated particle
position; for the asymmetric case we do not put the forces back but
we need to get the updated positions of the ghost - NOT getting
ghosts - because a new mapping is NOT needed but simply reusing
the old mapping push/send/popping the updated coordinates
The offsets are stored as the pdata in the psendbuffer, i.e.,
ppm_ghost_offset(ibuffer+0) = xp_offset(1,)
ppm_ghost_offset(ibuffer+1) = xp_offset(2,)
ppm_ghost_offset(ibuffer+2) = xp_offset(3,)
ppm_ghost_offsets
real array, (:)
ghost offset
ghost particles may have a spatial offset compared to their real
particle - we need to store this offset in terms of the buffer id
in order to be able to push/send/pop ghost coordinates in the
ghost_get and ghost_put mapping; this is needed when using Verlet
lists: here nothing is remapped and for symmetry we need both to
put the particle forces etc. and to get the updated particle
position; for the asymmetric case we do not put the forces back but
we need to get the updated positions of the ghost - NOT getting
ghosts - because a new mapping is NOT needed but simply reusing
the old mapping push/send/popping the updated coordinates
The offsets are stored as the pdata in the psendbuffer, i.e.,
ppm_ghost_offset(ibuffer+0) = xp_offset(1,)
ppm_ghost_offset(ibuffer+1) = xp_offset(2,)
ppm_ghost_offset(ibuffer+2) = xp_offset(3,)
ppm_ghosthack
integer array, (:,:)
invert map of ghost for symmetry
ppm_initialized
logical,
Has ppm_init been called?
ppm_irecvlist
integer array, (:)
ppm_isendlist
integer array, (:)
ppm_kind
integer,
Precision
ppm_logfile
integer,
ppm_map_type
integer,
ppm_mpi_kind
integer,
MPI Precision
ppm_myepsd
real,
ppm_myepss
real,
ppm_next_avail_topo
integer,
ID of the next available topology to be used by ppm_topo_alloc.
At initialization this is set to ppm_param_undefined If it points within (1,SIZE(ppm_topo)) this slot is (re)used to store the new topology, if it is > SIZE(ppm_topo) then the ppm_topo array must be extended
ppm_nproc
integer,
ppm_nrecvbuffer
integer,
the size of the recv buffer (not the array but the number of used elements)
In terms of entries in the buffer not the number of particles
ppm_nrecvlist
integer,
ppm_nsendbuffer
integer,
the size of the send buffer (not the array but the number of used elements)
In terms of entries in the buffer not the number of particles
ppm_nsendlist
integer,
ppm_pi_d
real,
ppm_pi_s
real,
ppm_precvbuffer
integer array, (:)
pointer to particles within the recv buffer
In terms of particle not the actual position in the buffer
ppm_proc_speed
real array, (:)
ppm_psendbuffer
integer array, (:)
pointer to particles within the send buffer
In terms of particle not the actual position in the buffer
ppm_rank
integer,
ppm_recvbufferd
real array, (:)
recv buffer for particles
ppm_recvbuffers
real array, (:)
recv buffer for particles
ppm_recvbufsize
integer,
the actual size of the receive buffer array
ppm_sendbufferd
real array, (:)
send buffer for particles
ppm_sendbuffers
real array, (:)
send buffer for particles
ppm_sendbufsize
integer,
the actual size of the send buffer array
ppm_stderr
integer,
ppm_stdout
integer,
ppm_topo
ppm_ptr_t_topo array, (:)
the PPM topologies array
Used Modules
This module contains data structures and definitions that are used in the PPM I/O routines.
| Note |
|---|---|
The members of this modules should not be accessed directly by the PPM client developer. They are managed internally by the library. |
| name | type | dimension | description |
|---|---|---|---|
real array | (:) | ||
complex array | (:) | ||
integer array | (:) | ||
integer array | (:) | ||
integer array | (:) | ||
real array | (:) | ||
complex array | (:) |
dbuffer
real array, (:)
dcbuffer
complex array, (:)
ppm_io_format
integer array, (:)
ppm_io_mode
integer array, (:)
ppm_io_unit
integer array, (:)
sbuffer
real array, (:)
scbuffer
complex array, (:)
Used Modules
This module holds data used by the load balancing routines.
| Note |
|---|---|
The variables declared in this modules should not be directly accessed by the user. They are managed interally by the library. |
This module holds mesh mapping, receive buffers and mesh ghost layer mapping buffers.
| Note |
|---|---|
The variables declared in this module should not be accessed by the PPM client developer. They are managed interally by the library. |
| name | type | dimension | description |
|---|---|---|---|
integer array | (:,:) | ||
integer array | (:,:) | ||
integer array | (:) | ||
integer array | (:,:) | ||
integer array | (:,:) | ||
integer array | (:) | list of source subs to send from local processor (local sub number |
ppm_mesh_irecvblksize
integer array, (:,:)
ppm_mesh_irecvblkstart
integer array, (:,:)
ppm_mesh_irecvtosub
integer array, (:)
ppm_mesh_isendblksize
integer array, (:,:)
ppm_mesh_isendblkstart
integer array, (:,:)
ppm_mesh_isendfromsub
integer array, (:)
list of source subs to send from local processor (local sub number on source processor)
Used Modules
has no uses
This module provides data used by the neighbor search routines.
| Note |
|---|---|
The variables declared in this module should not be accessed by the PPM client developer. They are managed internally by the library. |
| name | description |
|---|---|
This module holds data needed by the (re)meshing routines.
| Note |
|---|---|
The variables declared in this modules should not be directly accessed by the user. They are managed interally by the library. |
| name | type | dimension | description |
|---|---|---|---|
integer array | (5) | ||
integer array | (:,:) | ||
integer | |||
integer array | (4) | ||
integer array | (:) | ||
real | |||
real array | (:,:,:,:) | ||
real array | (:,:,:,:) | ||
real array | (:,:,:,:,:) | ||
real array | (:,:,:,:,:) | ||
real array | (:,:,:) | ||
real array | (:,:,:) | ||
real array | (:,:,:) | ||
real array | (:,:,:) | ||
real array | (:,:,:) | ||
real array | (:,:,:) |
imasf
integer array, (5)
list_sub
integer array, (:,:)
max_defkernels
integer,
ppm_rmsh_kernelsize
integer array, (4)
store_info
integer array, (:)
t0
real,
tuc_2dd
real array, (:,:,:,:)
tuc_2ds
real array, (:,:,:,:)
tuc_3dd
real array, (:,:,:,:,:)
tuc_3ds
real array, (:,:,:,:,:)
wx1_d
real array, (:,:,:)
wx1_s
real array, (:,:,:)
wx2_d
real array, (:,:,:)
wx2_s
real array, (:,:,:)
wx3_d
real array, (:,:,:)
wx3_s
real array, (:,:,:)
Used Modules
This module contains data structures and definitions that are PRIVATE to the ppm_map_part_store and ppm_map_part_load routines.
| Note |
|---|---|
The variables declared in this modules should not be directly accessed by the user. They are managed interally by the library. |
| name | type | dimension | description |
|---|---|---|---|
integer array | (:) | ||
integer | |||
integer array | (:) | ||
integer array | (:) | ||
integer | |||
integer | |||
integer | |||
integer | |||
integer array | (:) |
ppm_buffer2part_state
integer array, (:)
ppm_buffer_set_state
integer,
ppm_irecvlist_state
integer array, (:)
ppm_isendlist_state
integer array, (:)
ppm_map_type_state
integer,
ppm_nrecvlist_state
integer,
ppm_nsendbuffer_state
integer,
ppm_nsendlist_state
integer,
ppm_psendbuffer_state
integer array, (:)
Used Modules
has no uses
This module contains all data structures and definitions that are used in the tree routines.
| Note |
|---|---|
The variables declared in this modules should not be directly accessed by the user. They are managed interally by the library. |
| name | type | dimension | description |
|---|---|---|---|
integer array | (:) | ||
integer array | (:) | ||
logical | |||
logical | |||
integer array | (:) | ||
integer array | (:) | ||
integer array | (:) | ||
integer array | (:,:) | ||
integer array | (:,:) | ||
integer array | (:) | ||
real array | (:) | ||
real array | (:) | ||
integer array | (:,:) | ||
integer array | (:) |
boxlist
integer array, (:)
cbox
integer array, (:)
have_mesh
logical,
have_particles
logical,
lhbx_cut
integer array, (:)
lpdx_cut
integer array, (:)
ndiv
integer array, (:)
nm_box
integer array, (:,:)
nmc
integer array, (:,:)
npbx
integer array, (:)
pcst_d
real array, (:)
pcst_s
real array, (:)
tree_lhbx
integer array, (:,:)
tree_lpdx
integer array, (:)
Used Modules
This module provides the PPM decomposition routines.
PPM core provides 4 different decomposition routines that are called within the topology routines.
Subroutines contained in this interface:
| name | description |
|---|---|
This routine splits a (parent) box in its 4 or 8 children for | |
This routine splits a (parent) box in its 4 or 8 children for |
Subroutines contained in this interface:
| name | description |
|---|---|
Decomposes space using a Cartesian domain decomposition topology. | |
Decomposes space using a Cartesian domain decomposition topology. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine performs a domain decomposition using a | |
This routine performs a domain decomposition using a |
Subroutines contained in this interface:
| name | description |
|---|---|
Performs a tree-like decomposition. | |
Performs a tree-like decomposition. |
Subroutine decomp_bsplit_d
This routine splits a (parent) box in its 4 or 8 children for 2D and 3D problems. The particles contained within the parent box are sorted into the respective child boxes.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (INOUT) | Particle coordinates | ||
integer array | (:) | (INOUT) | ppb(i_box) returns the first index of the particle in the box of | ||
integer array | (:) | (INOUT) | npbx(i_box) returns the number of particles in the box of index ibox | ||
integer | (IN) | ID of the parent box | |||
integer | (INOUT) | Current number of boxes | |||
real array | (:,:) | (INOUT) | Smallest extremum of the sub-domains | ||
real array | (:,:) | (INOUT) | Largest extremum of the sub-domains | ||
integer | (OUT) | Returns status, 0 upon success |
xp
real array, (:,:), (INOUT)
Particle coordinates
ppb
integer array, (:), (INOUT)
ppb(i_box) returns the first index of the particle in the box of index ibox
npbx
integer array, (:), (INOUT)
npbx(i_box) returns the number of particles in the box of index ibox
kbox
integer, , (IN)
ID of the parent box
nbox
integer, , (INOUT)
Current number of boxes
min_box
real array, (:,:), (INOUT)
Smallest extremum of the sub-domains
max_box
real array, (:,:), (INOUT)
Largest extremum of the sub-domains
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_util_sort, ppm_module_substart
Subroutine decomp_bsplit_s
This routine splits a (parent) box in its 4 or 8 children for 2D and 3D problems. The particles contained within the parent box are sorted into the respective child boxes.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (INOUT) | Particle coordinates | ||
integer array | (:) | (INOUT) | ppb(i_box) returns the first index of the particle in the box of | ||
integer array | (:) | (INOUT) | npbx(i_box) returns the number of particles in the box of index ibox | ||
integer | (IN) | ID of the parent box | |||
integer | (INOUT) | Current number of boxes | |||
real array | (:,:) | (INOUT) | Smallest extremum of the sub-domains | ||
real array | (:,:) | (INOUT) | Largest extremum of the sub-domains | ||
integer | (OUT) | Returns status, 0 upon success |
xp
real array, (:,:), (INOUT)
Particle coordinates
ppb
integer array, (:), (INOUT)
ppb(i_box) returns the first index of the particle in the box of index ibox
npbx
integer array, (:), (INOUT)
npbx(i_box) returns the number of particles in the box of index ibox
kbox
integer, , (IN)
ID of the parent box
nbox
integer, , (INOUT)
Current number of boxes
min_box
real array, (:,:), (INOUT)
Smallest extremum of the sub-domains
max_box
real array, (:,:), (INOUT)
Largest extremum of the sub-domains
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_util_sort, ppm_module_substart
Subroutine decomp_cart_d
Decomposes space using a Cartesian domain decomposition topology.
![[Tip]](images/tip.png) | Tip |
|---|---|
In the user_defined case, the routine must be called with a non-zero
number of subdomains in |
| Note |
|---|---|
This routine is unaware of particles and simply decomposes space into equal grid volumes. When used for particles, this should be followed by a check of the cost balancing and possibly iterated with increasing ndom. |
| Note |
|---|---|
The computational domain is subdivided in exactly as many subdomains as there are processors. This is done to minimize memory usage of ghost layers (grids need ghost layers also at intra-processor subdomain boundaries!) and to get good convergence of the grid solver (artificial internal boundary conditionds at subdomain boundaries deteriorate convergence). A quad-/oct-tree decomposition of the computational domain is made until the remaining number of subs does not contain anymore a power of 2 factor. The remaining factor is used to do a parallel slab decomposition, such that the surface-to-volume ratio is minimized (in terms of numbers of grid points). This way, nproc equally sized subdomains with minimal collective surface nodes are created. The pencil decomposition works exactly the same except that cuts in one direction are prohibited. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:) | (IN) | Number of mesh points (not cells) in each direction of the | ||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
integer | (IN) | Domain decomposition can be one of: | |||
real array | (:,:) | Minimum extend of the subs | |||
real array | (:,:) | Maximum extend of the subs | |||
integer | (INOUT) | Total number of subdomains | |||
integer | (OUT) | Retuns status, 0 upon success | |||
integer | (IN) | X | Number of subdomains to be created. If not specified, |
nm
integer array, (:), (IN)
Number of mesh points (not cells) in each direction of the global comput. domain. (including those ON the boundaries)
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
decomp
integer, , (IN)
Domain decomposition can be one of:
- ppm_param_decomp_xpencil
- ppm_param_decomp_ypencil
- ppm_param_decomp_zpencil
- ppm_param_decomp_cuboid
- ppm_param_decomp_user_defined
min_sub
real array, (:,:), no intent declared
Minimum extend of the subs
max_sub
real array, (:,:), no intent declared
Maximum extend of the subs
nsubs
integer, , (INOUT)
Total number of subdomains
info
integer, , (OUT)
Retuns status, 0 upon success
(Optional) ndom
integer, , (IN)
Number of subdomains to be created. If not specified, the number of subdomains will be equal to the number of processors.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine decomp_cart_s
Decomposes space using a Cartesian domain decomposition topology.
| Tip |
|---|---|
In the user_defined case, the routine must be called with a non-zero
number of subdomains in |
| Note |
|---|---|
This routine is unaware of particles and simply decomposes space into equal grid volumes. When used for particles, this should be followed by a check of the cost balancing and possibly iterated with increasing ndom. |
| Note |
|---|---|
The computational domain is subdivided in exactly as many subdomains as there are processors. This is done to minimize memory usage of ghost layers (grids need ghost layers also at intra-processor subdomain boundaries!) and to get good convergence of the grid solver (artificial internal boundary conditionds at subdomain boundaries deteriorate convergence). A quad-/oct-tree decomposition of the computational domain is made until the remaining number of subs does not contain anymore a power of 2 factor. The remaining factor is used to do a parallel slab decomposition, such that the surface-to-volume ratio is minimized (in terms of numbers of grid points). This way, nproc equally sized subdomains with minimal collective surface nodes are created. The pencil decomposition works exactly the same except that cuts in one direction are prohibited. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:) | (IN) | Number of mesh points (not cells) in each direction of the | ||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
integer | (IN) | Domain decomposition can be one of: | |||
real array | (:,:) | Minimum extend of the subs | |||
real array | (:,:) | Maximum extend of the subs | |||
integer | (INOUT) | Total number of subdomains | |||
integer | (OUT) | Retuns status, 0 upon success | |||
integer | (IN) | X | Number of subdomains to be created. If not specified, |
nm
integer array, (:), (IN)
Number of mesh points (not cells) in each direction of the global comput. domain. (including those ON the boundaries)
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
decomp
integer, , (IN)
Domain decomposition can be one of:
- ppm_param_decomp_xpencil
- ppm_param_decomp_ypencil
- ppm_param_decomp_zpencil
- ppm_param_decomp_cuboid
- ppm_param_decomp_user_defined
min_sub
real array, (:,:), no intent declared
Minimum extend of the subs
max_sub
real array, (:,:), no intent declared
Maximum extend of the subs
nsubs
integer, , (INOUT)
Total number of subdomains
info
integer, , (OUT)
Retuns status, 0 upon success
(Optional) ndom
integer, , (IN)
Number of subdomains to be created. If not specified, the number of subdomains will be equal to the number of processors.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine decomp_pcell_d
This routine performs a domain decomposition using a pruned (incomplete) cell index list.
![[Caution]](images/caution.png) | Caution |
|---|---|
The way we compute the min_sub, max_sub may have problems with roundoff errors! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Position of the particles | ||
integer | (IN) | Number of particles | |||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
real | (IN) | Size (width) of the ghost layer | |||
real array | (:,:) | Minimum extent of the subdomain | |||
real array | (:,:) | Maximum extent of the subdomain | |||
integer | (OUT) | Total number of subdomains | |||
integer | (OUT) | Return status, 0 on success | |||
real array | (:) | (IN) | X | Argument of length Npart, specifying the |
xp
real array, (:,:), (IN)
Position of the particles
npart
integer, , (IN)
Number of particles
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
ghostsize
real, , (IN)
Size (width) of the ghost layer
min_sub
real array, (:,:), no intent declared
Minimum extent of the subdomain
max_sub
real array, (:,:), no intent declared
Maximum extent of the subdomain
nsubs
integer, , (OUT)
Total number of subdomains
info
integer, , (OUT)
Return status, 0 on success
(Optional) pcost
real array, (:), (IN)
Argument of length Npart, specifying the computational cost of each particle
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine decomp_pcell_s
This routine performs a domain decomposition using a pruned (incomplete) cell index list.
| Caution |
|---|---|
The way we compute the min_sub, max_sub may have problems with roundoff errors! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Position of the particles | ||
integer | (IN) | Number of particles | |||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
real | (IN) | Size (width) of the ghost layer | |||
real array | (:,:) | Minimum extent of the subdomain | |||
real array | (:,:) | Maximum extent of the subdomain | |||
integer | (OUT) | Total number of subdomains | |||
integer | (OUT) | Return status, 0 on success | |||
real array | (:) | (IN) | X | Argument of length Npart, specifying the |
xp
real array, (:,:), (IN)
Position of the particles
npart
integer, , (IN)
Number of particles
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
ghostsize
real, , (IN)
Size (width) of the ghost layer
min_sub
real array, (:,:), no intent declared
Minimum extent of the subdomain
max_sub
real array, (:,:), no intent declared
Maximum extent of the subdomain
nsubs
integer, , (OUT)
Total number of subdomains
info
integer, , (OUT)
Return status, 0 on success
(Optional) pcost
real array, (:), (IN)
Argument of length Npart, specifying the computational cost of each particle
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine decomp_tree_d
Performs a tree-like decomposition. It subdivides space until the number of leaves in the tree exceeds the number of processors and until the variance of the number of particles in the leaves is below a certain tolerance.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Position of the particles | ||
integer | (IN) | Number of particles | |||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
real | (IN) | Minimum box size | |||
real | (IN) | Maximum relative variance of the box cost allowed before | |||
real array | (:,:) | Minimum extent of the subdomain | |||
real array | (:,:) | Maximum extent of the subdomain | |||
integer | (OUT) | Total number of subdomains | |||
integer | (OUT) | Return status, 0 on success | |||
real array | (:) | (IN) | X | Argument of length Npart, specifying the |
xp
real array, (:,:), (IN)
Position of the particles
npart
integer, , (IN)
Number of particles
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
minboxsize
real, , (IN)
Minimum box size
tolerance
real, , (IN)
Maximum relative variance of the box cost allowed before terminating the tree; tolerance >= 0
min_sub
real array, (:,:), no intent declared
Minimum extent of the subdomain
max_sub
real array, (:,:), no intent declared
Maximum extent of the subdomain
nsubs
integer, , (OUT)
Total number of subdomains
info
integer, , (OUT)
Return status, 0 on success
(Optional) pcost
real array, (:), (IN)
Argument of length Npart, specifying the computational cost of each particle.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine decomp_tree_s
Performs a tree-like decomposition. It subdivides space until the number of leaves in the tree exceeds the number of processors and until the variance of the number of particles in the leaves is below a certain tolerance.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Position of the particles | ||
integer | (IN) | Number of particles | |||
real array | (:) | (IN) | Minimum coordinate of the physical/computational domain | ||
real array | (:) | (IN) | Maximum coordinate of the physical/computational domain | ||
real | (IN) | Minimum box size | |||
real | (IN) | Maximum relative variance of the box cost allowed before | |||
real array | (:,:) | Minimum extent of the subdomain | |||
real array | (:,:) | Maximum extent of the subdomain | |||
integer | (OUT) | Total number of subdomains | |||
integer | (OUT) | Return status, 0 on success | |||
real array | (:) | (IN) | X | Argument of length Npart, specifying the |
xp
real array, (:,:), (IN)
Position of the particles
npart
integer, , (IN)
Number of particles
min_phys
real array, (:), (IN)
Minimum coordinate of the physical/computational domain
max_phys
real array, (:), (IN)
Maximum coordinate of the physical/computational domain
minboxsize
real, , (IN)
Minimum box size
tolerance
real, , (IN)
Maximum relative variance of the box cost allowed before terminating the tree; tolerance >= 0
min_sub
real array, (:,:), no intent declared
Minimum extent of the subdomain
max_sub
real array, (:,:), no intent declared
Maximum extent of the subdomain
nsubs
integer, , (OUT)
Total number of subdomains
info
integer, , (OUT)
Return status, 0 on success
(Optional) pcost
real array, (:), (IN)
Argument of length Npart, specifying the computational cost of each particle.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
This module provides the decomposition routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine defines the boundary conditions of the | |
This routine defines the boundary conditions of the |
Subroutine define_subsbc_d
This routine defines the boundary conditions of the
subs on all processors. Thus subs that have
faces at the physical boundary are marked with +1 and
internal faces with the value 0. This information is
obtained by comparing the coordinates of the subvs with
the values of min_phys and max_phys.
![[Warning]](images/warning.png) | Warning |
|---|---|
If the user created the subs the comparison of floats in the present
routine might fail (round off errors) and the comparison should be
replaced by a |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | (IN) | Min. extent of the sub domain | ||
real array | (:,:) | (IN) | Max. extent of the sub domain | ||
integer | (IN) | The total number of (real) sub domains | |||
integer array | (:,:) | Boundary defintion of each sub | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), (IN)
Min. extent of the sub domain
max_sub
real array, (:,:), (IN)
Max. extent of the sub domain
nsubs
integer, , (IN)
The total number of (real) sub domains
subs_bc
integer array, (:,:), no intent declared
Boundary defintion of each sub
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine define_subsbc_s
This routine defines the boundary conditions of the
subs on all processors. Thus subs that have
faces at the physical boundary are marked with +1 and
internal faces with the value 0. This information is
obtained by comparing the coordinates of the subvs with
the values of min_phys and max_phys.
| Warning |
|---|---|
If the user created the subs the comparison of floats in the present
routine might fail (round off errors) and the comparison should be
replaced by a |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | (IN) | Min. extent of the sub domain | ||
real array | (:,:) | (IN) | Max. extent of the sub domain | ||
integer | (IN) | The total number of (real) sub domains | |||
integer array | (:,:) | Boundary defintion of each sub | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), (IN)
Min. extent of the sub domain
max_sub
real array, (:,:), (IN)
Max. extent of the sub domain
nsubs
integer, , (IN)
The total number of (real) sub domains
subs_bc
integer array, (:,:), no intent declared
Boundary defintion of each sub
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
This module provides the error routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine is called whenever an error occurs. It prints the error |
Subroutine ppm_error
This routine is called whenever an error occurs. It prints the error message, writes a log entry and terminates the program if the error was fatal.
| Note |
|---|---|
Line number is only included in error message if debug level > 0. Warnings and Notices are not printed to stderr (but only to the log file) unless debug level is > 0 or > 1, respectively. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Error number | |||
character | (IN) | Name of calling subroutine | |||
character | (IN) | Error message | |||
integer | (IN) | Line number of error | |||
integer | (INOUT) | On entry: error severity level. |
errno
integer, , (IN)
Error number
caller
character, , (IN)
Name of calling subroutine
mesg
character, , (IN)
Error message
line
integer, , (IN)
Line number of error
info
integer, , (INOUT)
On entry: error severity level.
- ppm_error_fatal
- ppm_error_error
- ppm_error_warning
- ppm_error_notice
On exit: new error level (maybe different from entry level if this routine had additional errors.)
Used Modules
| name | type | dimension | description |
|---|---|---|---|
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
character array | (1100) | ||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer | |||
integer |
ppm_err_alloc
integer,
ppm_err_argument
integer,
ppm_err_bad_mesh
integer,
ppm_err_bad_meshop
integer,
ppm_err_bad_schko
integer,
ppm_err_bad_sum
integer,
ppm_err_buffer_empt
integer,
ppm_err_close
integer,
ppm_err_converge
integer,
ppm_err_data_miss
integer,
ppm_err_dealloc
integer,
ppm_err_delete
integer,
ppm_err_div_zero
integer,
ppm_err_few_subs
integer,
ppm_err_file
integer,
ppm_err_index_corr
integer,
ppm_err_io
integer,
ppm_err_io_data
integer,
ppm_err_map_incomp
integer,
ppm_err_mat_singul
integer,
ppm_err_mesg
character array, (1100)
ppm_err_mesh_miss
integer,
ppm_err_mpi_fail
integer,
ppm_err_mpi_term
integer,
ppm_err_multipleinit
integer,
ppm_err_no_data
integer,
ppm_err_no_subs
integer,
ppm_err_no_topo
integer,
ppm_err_no_unit
integer,
ppm_err_node_number
integer,
ppm_err_nofftw
integer,
ppm_err_nofishpack
integer,
ppm_err_nohypre
integer,
ppm_err_nomap
integer,
ppm_err_nomathkeisan
integer,
ppm_err_nometis
integer,
ppm_err_nompi
integer,
ppm_err_notready
integer,
ppm_err_open
integer,
ppm_err_outof_units
integer,
ppm_err_part_lost
integer,
ppm_err_part_range
integer,
ppm_err_part_unass
integer,
ppm_err_ppm_noinit
integer,
ppm_err_read_eor
integer,
ppm_err_rev_time
integer,
ppm_err_rhs_compat
integer,
ppm_err_sqrt_neg
integer,
ppm_err_sub_failed
integer,
ppm_err_subs_incomp
integer,
ppm_err_subs_map
integer,
ppm_err_test_fail
integer,
ppm_err_tol_warn
integer,
ppm_err_topo_missm
integer,
ppm_err_unit_open
integer,
ppm_err_wrong_dim
integer,
ppm_err_wrong_prec
integer,
ppm_err_wrong_type
integer,
Used Modules
has no uses
This module provides the finalization routine callable from outside
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine terminates the ppm library including |
Subroutine ppm_finalize
This routine terminates the ppm library including deallocating memory and closing files.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (OUT) | Returns 0 upon success |
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_mesh_finalize, ppm_module_substart
This module provides the routines to find doublicate entries in 2D arrays - callable from the outside.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine can be used to find duplicate entries |
Subroutine ppm_find_duplicates_d
This routine can be used to find duplicate entries
in a 2D array of leading dimension 2 or 3.
The comparison is done up to the precision specified
to ppm_init. Fast O(N) search using cell lists is used.
| Note |
|---|---|
In the case of nident = 0, ident(:,:) will not be allocated upon return! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Data to be checked for duplicates. Both single and double precision | ||
integer | (IN) | Leading dimension of data. Must be either 2 or 3. | |||
integer | (IN) | Number of data items (second dimension of the array). | |||
integer | (OUT) | Number of identities found | |||
integer array | (:,:) | Indices of identical data entries. First index: 1,2 [first | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:), (IN)
Data to be checked for duplicates. Both single and double precision REAL are supported. Leading dimension must be either 2 or 3.
lda
integer, , (IN)
Leading dimension of data. Must be either 2 or 3.
ndata
integer, , (IN)
Number of data items (second dimension of the array).
nident
integer, , (OUT)
Number of identities found
ident
integer array, (:,:), no intent declared
Indices of identical data entries. First index: 1,2 [first and second index of the identity], second index: 1…nident [identity ID]. This will only be allocated IF at least one duplicate is found!
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_util_rank, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_find_duplicates_s
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:,:) | (IN) | Data to be checked for duplicates. Both single and double precision | ||
integer | (IN) | Leading dimension of data. Must be either 2 or 3. | |||
integer | (IN) | Number of data items (second dimension of the array). | |||
integer | (OUT) | Number of identities found | |||
integer array | (:,:) | Indices of identical data entries. First index: 1,2 [first | |||
integer | (OUT) | Returns status, 0 upon success |
adata
real array, (:,:), (IN)
Data to be checked for duplicates. Both single and double precision REAL are supported. Leading dimension must be either 2 or 3.
lda
integer, , (IN)
Leading dimension of data. Must be either 2 or 3.
ndata
integer, , (IN)
Number of data items (second dimension of the array).
nident
integer, , (OUT)
Number of identities found
ident
integer array, (:,:), no intent declared
Indices of identical data entries. First index: 1,2 [first and second index of the identity], second index: 1…nident [identity ID]. This will only be allocated IF at least one duplicate is found!
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_util_rank, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
This module provides the decomposition routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine find the neighbours of a sub domain. |
Subroutine ppm_find_neigh_d
This routine find the neighbours of a sub domain. It does that by comparing the coordinates of the bounding box of the sub domains using an N-square algorithm! Moreover, since the routine is called before any mapping has been performed, all the subs (nsubs) must be searched!
| Note |
|---|---|
No sub is listed as a neighbor of itself. |
| Note |
|---|---|
The side effect of this routine is that the lists
The lists that are built contain unique entries. This means that a sub can occur at most once in the neighbor list of a particular other sub. This needs to be taken into account when doing periodic ghosts. This routine uses cell lists of the sub centers for fast search. The size of the cells is the extent(1:3) of the largest sub that exists. Therefore: if we have one large sub and tons of small ones, this routine will perform poorly. (N**2 in the worst case). |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | Min. extent of the sub domain | |||
real array | (:,:) | Max. extent of the sub domain | |||
integer | (IN) | Total number of (real) sub domains | |||
integer array | (:) |
| |||
integer array | (:,:) | Points to the | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), no intent declared
Min. extent of the sub domain
max_sub
real array, (:,:), no intent declared
Max. extent of the sub domain
nsubs
integer, , (IN)
Total number of (real) sub domains
nneigh
integer array, (:), no intent declared
nneigh(isub) returns the total number
of neighbouring subs of isub
ineigh
integer array, (:,:), no intent declared
Points to the nneigh(:) subs of isub
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_util_rank, ppm_module_error, ppm_module_neighlist, ppm_module_alloc, ppm_module_substop, ppm_module_copy_image_subs, ppm_module_substart
Subroutine ppm_find_neigh_s
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | (IN) | Min. extent of the physical domain | ||
real array | (:) | (IN) | Max. extent of the physical domain | ||
integer array | (:) | (IN) | Boundary condition definition | ||
real array | (:,:) | Min. extent of the sub domain | |||
real array | (:,:) | Max. extent of the sub domain | |||
integer | (IN) | Total number of (real) sub domains | |||
integer array | (:) |
| |||
integer array | (:,:) | Points to the | |||
integer | (OUT) | Returns status, 0 upon success |
min_phys
real array, (:), (IN)
Min. extent of the physical domain
max_phys
real array, (:), (IN)
Max. extent of the physical domain
bcdef
integer array, (:), (IN)
Boundary condition definition
min_sub
real array, (:,:), no intent declared
Min. extent of the sub domain
max_sub
real array, (:,:), no intent declared
Max. extent of the sub domain
nsubs
integer, , (IN)
Total number of (real) sub domains
nneigh
integer array, (:), no intent declared
nneigh(isub) returns the total number
of neighbouring subs of isub
ineigh
integer array, (:,:), no intent declared
Points to the nneigh(:) subs of isub
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_util_rank, ppm_module_error, ppm_module_neighlist, ppm_module_alloc, ppm_module_substop, ppm_module_copy_image_subs, ppm_module_substart
This module includes the source code user callable ppm_impose_part_bc routine to map the particles back inside the computational domain for periodic BC.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine imposes periodic boundary conditions for | |
This routine imposes periodic boundary conditions for |
Subroutine ppm_impose_part_bc_d
This routine imposes periodic boundary conditions for the particles. That is it moves/wraps any particles outside the computational box into the box. The routine assumes that the particles are located within the size of one computational box.
| Note |
|---|---|
This routine is a user callable routine. |
| Caution |
|---|---|
(This concerns only PPM developers) The routine is sensitive the round off errors! So be careful not to change the order of the IF statements (see code comments) and make sure the compiler is not doing something wrong as well! Originally when particles would be close/at the boundary, the routine would fail to map all particles, but succed if called a 2nd time. The changed in the order of the IF statements removed this double calling sequence. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID | |||
real array | (:,:) | (INOUT) | Particle coordinates | ||
integer | (IN) | Number of particles | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID
xp
real array, (:,:), (INOUT)
Particle coordinates
npart
integer, , (IN)
Number of particles
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_substop, ppm_module_substart
Subroutine ppm_impose_part_bc_s
This routine imposes periodic boundary conditions for the particles. That is it moves/wraps any particles outside the computational box into the box. The routine assumes that the particles are located within the size of one computational box.
| Note |
|---|---|
This routine is a user callable routine. |
| Caution |
|---|---|
(This concerns only PPM developers) The routine is sensitive the round off errors! So be careful not to change the order of the IF statements (see code comments) and make sure the compiler is not doing something wrong as well! Originally when particles would be close/at the boundary, the routine would fail to map all particles, but succed if called a 2nd time. The changed in the order of the IF statements removed this double calling sequence. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID | |||
real array | (:,:) | (INOUT) | Particle coordinates | ||
integer | (IN) | Number of particles | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID
xp
real array, (:,:), (INOUT)
Particle coordinates
npart
integer, , (IN)
Number of particles
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_substop, ppm_module_substart
This module provides the init routine - callable from the outside.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
Initialisation of the ppm library. |
Subroutine ppm_init
Initialisation of the ppm library.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | dimension of the problem (2 or 3) | |||
integer | (IN) | desired precision ppm_kind_double or ppm_kind_single | |||
integer | (IN) | log10 of the numerical tolerance for real comparisons (> machine eps). | |||
integer | (IN) | MPI communicator | |||
integer | (IN) | The debug level (0,1 or 2) | |||
integer | (OUT) | returns status 0 upon success | |||
integer | X | OPTIONAL. Unit number where to print log messages to. | |||
integer | X | OPTIONAL. Unit number where to print the stderr to | |||
integer | X | OPTIONAL. Unit number where to print the stdout to |
dim
integer, , (IN)
dimension of the problem (2 or 3)
prec
integer, , (IN)
desired precision ppm_kind_double or ppm_kind_single
tolexp
integer, , (IN)
log10 of the numerical tolerance for real comparisons (> machine eps). E.g. for a tolerance of 10(-14), tolexp = -14. Everything .LT. 10tolexp will be considered zero (0) and its inversion is considered dangerous.
comm
integer, , (IN)
MPI communicator
debug
integer, , (IN)
The debug level (0,1 or 2)
info
integer, , (OUT)
returns status 0 upon success
(Optional) logfile
integer, , no intent declared
OPTIONAL. Unit number where to print log messages to.
(Optional) stderr
integer, , no intent declared
OPTIONAL. Unit number where to print the stderr to
(Optional) stdout
integer, , no intent declared
OPTIONAL. Unit number where to print the stdout to
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_io, ppm_module_log, ppm_module_print_defines, ppm_module_write, ppm_module_substart
Contains the mesh to particle interpolation routines. Currently we support 2nd order B-spline and M’4 interpolation schemes.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. | |
Mesh to particle interpolation following the 2nd order B-spline scheme. |
Subroutines contained in this interface:
| name | description |
|---|---|
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. | |
Mesh to particle interpolation following the M’4 scheme. |
Subroutines contained in this interface:
| name | description |
|---|---|
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. | |
This subroutine carries out mesh to particle interpolation. |
Subroutine m2p_ds_2d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:) | particle weights onto which to interpolate | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:), no intent declared
particle weights onto which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_ds_3d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:) | particle weights onto which to interpolate | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:), no intent declared
particle weights onto which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_dv_2d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:,:) | particle weights onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_dv_3d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:,:) | particle weights onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_ds_2d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_ds_3d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_dv_2d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_dv_3d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_ss_2d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_ss_3d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_sv_2d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_bsp2_sv_3d
Mesh to particle interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh | |||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_ds_2d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_ds_3d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_dv_2d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_dv_3d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_ss_2d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_ss_3d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_sv_2d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_interp_mp4_sv_3d
Mesh to particle interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | particle weights onto which to interpolate | |||
real array | (ppm_dim) | ||||
integer array | (:) | (IN) | ghost size | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
lda
integer, , (IN)
leading dimension of up
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
dx
real array, (ppm_dim), no intent declared
ghostsize
integer array, (:), (IN)
ghost size
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_ss_2d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:) | particle weights onto which to interpolate | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:), no intent declared
particle weights onto which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_ss_3d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:) | particle weights onto which to interpolate | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:), no intent declared
particle weights onto which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_sv_2d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:,:) | particle weights onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine m2p_sv_3d
This subroutine carries out mesh to particle interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles. | |||
real array | (:,:) | particle weights onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | ghost size | ||
real array | (:,:,:,:,:) | (IN) | field from which to interpolate | ||
integer | (OUT) | Returns 0 upon success |
topoid
integer, , (IN)
topology identifier of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles.
up
real array, (:,:), no intent declared
particle weights onto which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights. One of:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
ghostsize
integer array, (:), (IN)
ghost size
field_up
real array, (:,:,:,:,:), (IN)
field from which to interpolate
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Contains the particle to mesh interpolation routines. Currently we support 2nd order B-spline and M’4 interpolation schemes.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. | |
Particle to mesh interpolation following the 2nd order B-spline scheme. |
Subroutines contained in this interface:
| name | description |
|---|---|
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. | |
Particle to mesh interpolation following the M’4 scheme. |
Subroutines contained in this interface:
| name | description |
|---|---|
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. | |
This subroutine carries out particle to mesh interpolation. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine does particle to mesh interpolation. Vector cases for | |
This routine does particle to mesh interpolation. Vector cases for | |
This routine does particle to mesh interpolation. Vector cases for | |
This routine does particle to mesh interpolation. Vector cases for |
Subroutine p2m_ds_2d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_ds_3d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_dv_2d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:,:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:,:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_dv_3d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:,:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:,:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_ds_2d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_ds_3d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_dv_2d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_dv_3d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_ss_2d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_ss_3d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_sv_2d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_bsp2_sv_3d
Particle to mesh interpolation following the 2nd order B-spline scheme.
The interpolation scheme is only implemented for 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_ds_2d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_ds_3d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_dv_2d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_dv_3d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_ss_2d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_ss_3d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_sv_2d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_interp_mp4_sv_3d
Particle to mesh interpolation following the M’4 scheme.
The interpolation scheme is only implemented for 2D and 3D spaces. To increase performance the inner loops over the number of properties to be interpolated are unrolled for 2,3,4 and 5-vectors.
| Note |
|---|---|
This routine only performs the actual interpolation. It should not be
called directly from routines but instead the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
real array | (:,:) | (IN) | particle positions | ||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (IN) | leading dimension of up | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (ppm_dim) | (IN) | mesh spacing | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
xp
real array, (:,:), (IN)
particle positions
up
real array, (:,:), (IN)
particle weights from which to interpolate
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
lda
integer, , (IN)
leading dimension of up
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
dx
real array, (ppm_dim), (IN)
mesh spacing
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_renorm_ds_3d
This routine does particle to mesh interpolation. Vector cases for lda < 5 are explicitly unrolled for the 3D version. All 3D versions are explicitly unrolled over the kernel, the 2D versions are not.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_renorm_dv_3d
This routine does particle to mesh interpolation. Vector cases for lda < 5 are explicitly unrolled for the 3D version. All 3D versions are explicitly unrolled over the kernel, the 2D versions are not.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_renorm_ss_3d
This routine does particle to mesh interpolation. Vector cases for lda < 5 are explicitly unrolled for the 3D version. All 3D versions are explicitly unrolled over the kernel, the 2D versions are not.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_renorm_sv_3d
This routine does particle to mesh interpolation. Vector cases for lda < 5 are explicitly unrolled for the 3D version. All 3D versions are explicitly unrolled over the kernel, the 2D versions are not.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_ss_2d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_ss_3d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:), (IN)
particle weights from which to interpolate
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_sv_2d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:,:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:,:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
Subroutine p2m_sv_3d
This subroutine carries out particle to mesh interpolation.
Currently 2 interpolation schemes are supported:
- ppm_param_rmsh_kernel_bsp2
- ppm_param_rmsh_kernel_mp4
| Warning |
|---|---|
This routine assumes that |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology identifier (user numbering) of target | |||
integer | (IN) | id of the mesh (user) | |||
real array | (:,:) | (IN) | particle positions | ||
integer | (IN) | number of particles | |||
real array | (:,:) | (IN) | particle weights from which to interpolate | ||
integer | (IN) | leading dimension of up | |||
integer | (IN) | Choice of the kernel used to compute the weights. | |||
integer array | (:) | (IN) | The size (width) of the ghost layer | ||
real array | (:,:,:,:,:) | field onto which to interpolate | |||
integer | (OUT) | Returns status, 0 upon success | |||
integer array | (:,:) | X | Boundary conditions used for this interpolation routine, they may be |
topoid
integer, , (IN)
topology identifier (user numbering) of target
meshid
integer, , (IN)
id of the mesh (user)
xp
real array, (:,:), (IN)
particle positions
np
integer, , (IN)
number of particles
up
real array, (:,:), (IN)
particle weights from which to interpolate
lda
integer, , (IN)
leading dimension of up
kernel
integer, , (IN)
Choice of the kernel used to compute the weights.
ghostsize
integer array, (:), (IN)
The size (width) of the ghost layer
field_up
real array, (:,:,:,:,:), no intent declared
field onto which to interpolate
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) p2m_bcdef
integer array, (:,:), no intent declared
Boundary conditions used for this interpolation routine, they may be different than the boundary conditions set in the topology. The values in this array can be one of:
- ppm_param_bcdef_symmetry
- ppm_param_bcdef_antisymmetry
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_check_id, ppm_module_alloc, ppm_module_data_rmsh, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_map, ppm_module_substart
This module provides the interfaces to all PPM I/O routines.
This module contains all data structures and definitions that are private to the I/O routines.
| name | description |
|---|---|
Internal routine that performs actual I/O | |
Performs parallel I/O of scalars and vectors | |
Closes a file | |
Deletes a file | |
Inquires the state of a I/O Unit | |
Opens a file | |
Reads ASCII arrays from an I/O Unit | |
Reads binary arrays from an I/O Unit | |
Sets I/O units for stout, stderr and log file | |
Routine that finds the first unused I/O unit | |
Writes ASCII arrays to an I/O Unit | |
Writes binary arrays to an I/O Unit |
Internal routine that performs actual I/O
Subroutines contained in this interface:
| name | description |
|---|---|
Internal routine that performs the actual I/O. | |
Internal routine that performs the actual I/O. | |
Internal routine that performs the actual I/O. | |
Internal routine that performs the actual I/O. | |
Internal routine that performs the actual I/O. | |
Internal routine that performs the actual I/O. |
Performs parallel I/O of scalars and vectors of Fortran intrinsic types
Subroutines contained in this interface:
| name | description |
|---|---|
Performs parallel I/O (read or write) of real single scalars | |
Performs parallel I/O (read or write) of real double scalars | |
Performs parallel I/O (read or write) of integer scalars | |
Performs parallel I/O (read or write) of logical scalars | |
Performs parallel I/O (read or write) of complex single scalars | |
Performs parallel I/O (read or write) of complex double scalars | |
Performs parallel I/O (read or write) of character scalars | |
Performs parallel I/O (read or write) of real single 1D vectors | |
Performs parallel I/O (read or write) of real double 1D vectors | |
Performs parallel I/O (read or write) of integer 1D vectors | |
Performs parallel I/O (read or write) of logical 1D vectors | |
Performs parallel I/O (read or write) of complex single 1D vectors | |
Performs parallel I/O (read or write) of complex double 1D vectors | |
Performs parallel I/O (read or write) of real single 2D vectors | |
Performs parallel I/O (read or write) of real dbouble 2D vectors | |
Performs parallel I/O (read or write) of integer 2D vectors | |
Performs parallel I/O (read or write) of logical 2D vectors | |
Performs parallel I/O (read or write) of complex single 2D vectors | |
Performs parallel I/O (read or write) of complex double 2D vectors | |
Performs parallel I/O (read or write) of real single 3D vectors | |
Performs parallel I/O (read or write) of real double 3D vectors | |
Performs parallel I/O (read or write) of integer 3D vectors | |
Performs parallel I/O (read or write) of logical 3D vectors | |
Performs parallel I/O (read or write) of complex single 3D vectors | |
Performs parallel I/O (read or write) of complex double 3D vectors | |
Performs parallel I/O (read or write) of real single 4D vectors | |
Performs parallel I/O (read or write) of real double 4D vectors | |
Performs parallel I/O (read or write) of integer 4D vectors | |
Performs parallel I/O (read or write) of logical 4D vectors | |
Performs parallel I/O (read or write) of complex single 4D vectors | |
Performs parallel I/O (read or write) of complex double 4D vectors | |
Performs parallel I/O (read or write) of real single 5D vectors | |
Performs parallel I/O (read or write) of real double 5D vectors | |
Performs parallel I/O (read or write) of integer 5D vectors | |
Performs parallel I/O (read or write) of logical 5D vectors | |
Performs parallel I/O (read or write) of complex single 5D vectors | |
Performs parallel I/O (read or write) of complex double 5D vectors |
Closes a file
Subroutines contained in this interface:
| name | description |
|---|---|
This routine closes an IO channel. |
Deletes a file
Subroutines contained in this interface:
| name | description |
|---|---|
This routine deletes a file. |
Inquires the state of a I/O Unit
Subroutines contained in this interface:
| name | description |
|---|---|
This routine inquires the state of a given ppm I/O unit. |
Opens a file
Subroutines contained in this interface:
| name | description |
|---|---|
This routine opens an IO channel for parallel reading and/or writing |
Reads ASCII arrays from an I/O Unit
Subroutines contained in this interface:
| name | description |
|---|---|
Provides the atomic reading functionality for ASCII 1D arrays. | |
Provides the atomic reading functionality for ASCII 1D arrays. | |
Provides the atomic reading functionality for ASCII 1D arrays. | |
Provides the atomic reading functionality for ASCII 1D arrays. | |
Provides the atomic reading functionality for ASCII 1D arrays. | |
Provides the atomic reading functionality for ASCII 1D arrays. |
Reads binary arrays from an I/O Unit
Subroutines contained in this interface:
| name | description |
|---|---|
Provides the atomic reading functionality for binary 1D arrays. | |
Provides the atomic reading functionality for binary 1D arrays. | |
Provides the atomic reading functionality for binary 1D arrays. | |
Provides the atomic reading functionality for binary 1D arrays. | |
Provides the atomic reading functionality for binary 1D arrays. | |
Provides the atomic reading functionality for binary 1D arrays. |
Sets I/O units for stout, stderr and log file
Subroutines contained in this interface:
| name | description |
|---|---|
This routine is called by the user to set the IO |
Routine that finds the first unused I/O unit
Subroutines contained in this interface:
| name | description |
|---|---|
This routine finds the next available unit number |
Writes ASCII arrays to an I/O Unit
Subroutines contained in this interface:
| name | description |
|---|---|
Provides the atomic writing functionality for ascii 1D arrays. | |
Provides the atomic writing functionality for ascii 1D arrays. | |
Provides the atomic writing functionality for ascii 1D arrays. | |
Provides the atomic writing functionality for ascii 1D arrays. | |
Provides the atomic writing functionality for ascii 1D arrays. | |
Provides the atomic writing functionality for ascii 1D arrays. |
Writes binary arrays to an I/O Unit
Subroutines contained in this interface:
| name | description |
|---|---|
Provides the atomic writing functionality for binary 1D arrays. | |
Provides the atomic writing functionality for binary 1D arrays. | |
Provides the atomic writing functionality for binary 1D arrays. | |
Provides the atomic writing functionality for binary 1D arrays. | |
Provides the atomic writing functionality for binary 1D arrays. | |
Provides the atomic writing functionality for binary 1D arrays. |
Subroutine io_readascii_d
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readascii_dc
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readascii_i
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
integer array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
integer array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readascii_l
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
logical array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
logical array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readascii_s
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readascii_sc
Provides the atomic reading functionality for ASCII 1D arrays.
| Note |
|---|---|
Never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_d
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_dc
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_i
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
integer array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
integer array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_l
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
logical array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
logical array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_s
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_readbin_sc
Provides the atomic reading functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (OUT) | Data vector to be read. 1d array of either single, double, | ||
integer | (IN) | Length of record to be read | |||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) |
| |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (OUT)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. Needs to be allocated to proper size before calling this routine. Its size determines the number of elements read from the file.
nrec
integer, , (IN)
Length of record to be read
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
.TRUE. if a CHARACTER string is to be read and has to be
converted to an INTEGER array before returning it.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_d
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_dc
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_i
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
integer array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
integer array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_l
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
logical array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
logical array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_s
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writeascii_sc
Provides the atomic writing functionality for ascii 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (IN) | Data vector to be read. 1d array of either single, double, | ||
character | (IN) | Format string for I/O. List-directed I/O is used if | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (IN)
Data vector to be read. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
iofmt
character, , (IN)
Format string for I/O. List-directed I/O is used if length zero string is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_d
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_dc
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_i
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
integer array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
integer array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_l
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
logical array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
logical array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_s
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
real array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
real array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine io_writebin_sc
Provides the atomic writing functionality for binary 1D arrays.
| Note |
|---|---|
It is never used by the user program directly. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Fortran I/O unit to be used | |||
complex array | (:) | (IN) | Data vector to be written. 1d array of either single, double, | ||
integer | (IN) | Precision for I/O. One of: | |||
logical | (IN) | .TRUE. if the integer array actually is a CHARACTER string | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
Fortran I/O unit to be used
adata
complex array, (:), (IN)
Data vector to be written. 1d array of either single, double, single complex, double complex, integer or logical elements. All elements of it will be written.
ioprec
integer, , (IN)
Precision for I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Integer and Logical cases are not influenced by this. No conversions are done if any value other than the above is given.
lchar
logical, , (IN)
TRUE. if the integer array actually is a CHARACTER string. and should be converted back before output.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_doio_d
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_doio_dc
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_doio_i
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_doio_l
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_doio_s
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_doio_sc
Internal routine that performs the actual I/O. It should never be called by the client program directly, but via ppm_io. It only handles 1D arrays. Everything else is converted to a 1D array by the calling routine ppm_io.
| Caution |
|---|---|
Uses non-blocking MPI to overlap MPI-IO and file-IO. For this reason it needs two buffers. If memory is a problem, using only one and blocking MPI might be better. |
| Warning |
|---|---|
This routine uses MPI_Irecv and thus, all buffer arrays need to be ALLOCATABLEs and not POINTERs! Using Fortran90 POINTER structures in conjunction with non-blocking MPI_Irecv does NOT WORK! (see http://parallel.ru/docs/Parallel/mpi2/node236.html) |
| Note |
|---|---|
This routine makes use of MPI_Cancel to cancel pending send and receive actions when an I/O error occured on Root. Canceling a send action is expensive and only supported in versions newer than mpich 1.2.0. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:) | (INOUT) | Data to be written/read. | ||
integer | (IN) | I/O action. One of: ppm_param_io_read/ppm_param_io_write | |||
integer | (IN) | I/O distribution. | |||
character | (IN) | Format string (for ASCII I/O). List-directed I/O is used if | |||
integer | (IN) | Precision for binary I/O. | |||
logical | (IN) |
| |||
integer | (IN) | MPI tag to be used for this I/O. | |||
integer | (OUT) | Returns 0 upon success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:), (INOUT)
Data to be written/read.
actn
integer, , (IN)
I/O action. One of: ppm_param_io_read/ppm_param_io_write
dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
iofmt
character, , (IN)
Format string (for ASCII I/O). List-directed I/O is used if string of length 0 is given.
ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
- ppm_param_undefined
If undefined is given, no conversion is done.
lchar
logical, , (IN)
.TRUE. if the integer vector actually corresponds to a character
string. In this case the string will be converted back to characters
before it is written out. .FALSE. if it is a true INTEGER vector.
mptag
integer, , (IN)
MPI tag to be used for this I/O.
info
integer, , (OUT)
Returns 0 upon success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_io_0dc
Performs parallel I/O (read or write) of character scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
character | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
character, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0dd
Performs parallel I/O (read or write) of real double scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0ddc
Performs parallel I/O (read or write) of complex double scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0di
Performs parallel I/O (read or write) of integer scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0dl
Performs parallel I/O (read or write) of logical scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0ds
Performs parallel I/O (read or write) of real single scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_0dsc
Performs parallel I/O (read or write) of complex single scalars on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex | (INOUT) | data to be written/read. Overloaded types are: single, | |||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex, , (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1dd
Performs parallel I/O (read or write) of real double 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1ddc
Performs parallel I/O (read or write) of complex double 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1di
Performs parallel I/O (read or write) of integer 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1dl
Performs parallel I/O (read or write) of logical 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1ds
Performs parallel I/O (read or write) of real single 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_1dsc
Performs parallel I/O (read or write) of complex single 1D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2dd
Performs parallel I/O (read or write) of real dbouble 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2ddc
Performs parallel I/O (read or write) of complex double 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2di
Performs parallel I/O (read or write) of integer 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2dl
Performs parallel I/O (read or write) of logical 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2ds
Performs parallel I/O (read or write) of real single 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_2dsc
Performs parallel I/O (read or write) of complex single 2D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3dd
Performs parallel I/O (read or write) of real double 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3ddc
Performs parallel I/O (read or write) of complex double 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3di
Performs parallel I/O (read or write) of integer 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3dl
Performs parallel I/O (read or write) of logical 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3ds
Performs parallel I/O (read or write) of real single 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_3dsc
Performs parallel I/O (read or write) of complex single 3D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4dd
Performs parallel I/O (read or write) of real double 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4ddc
Performs parallel I/O (read or write) of complex double 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4di
Performs parallel I/O (read or write) of integer 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4dl
Performs parallel I/O (read or write) of logical 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4ds
Performs parallel I/O (read or write) of real single 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_4dsc
Performs parallel I/O (read or write) of complex single 4D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5dd
Performs parallel I/O (read or write) of real double 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5ddc
Performs parallel I/O (read or write) of complex double 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5di
Performs parallel I/O (read or write) of integer 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
integer array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
integer array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5dl
Performs parallel I/O (read or write) of logical 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
logical array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
logical array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5ds
Performs parallel I/O (read or write) of real single 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
real array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
real array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_5dsc
Performs parallel I/O (read or write) of complex single 5D vectors on a distributed or centralized unit opened with ppm_io_open.
| Note |
|---|---|
Many arguments are optional. It is adivised to use explicit argument naming when using this routine. Example:
|
| Warning |
|---|---|
RESHAPE operates on the stack, so on machines with limited stack size this limits the max possible data size. Therefore we use DO loops (not slower) to emain on the heap. On vector machines we still use RESHAPE because it is faster. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | I/O unit (as returned by ppm_io_open). | |||
complex array | (:,:,:,:,:) | (INOUT) | data to be written/read. Overloaded types are: single, | ||
integer | (IN) | X | I/O action. One of: | ||
integer | (IN) | X | I/O distribution. For read one of: | ||
character | (IN) | X | Format string (for ASCII I/O). Default is (*) | ||
integer | (IN) | X | Precision for binary I/O. One of: | ||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
I/O unit (as returned by ppm_io_open).
adata
complex array, (:,:,:,:,:), (INOUT)
data to be written/read. Overloaded types are: single, double, integer, single complex, double complex, logical, character. Can be either scalar, 1d, 2d, 3d, 4d or 5d. Character strings can only be scalar (i.e. no array of strings).
(Optional) actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_read
- ppm_param_io_write
If not specified, default is ppm_param_io_read
(Optional) dist
integer, , (IN)
I/O distribution. For read one of:
- ppm_param_io_same
- ppm_param_io_split
If not specified, default is ppm_param_io_same.
For write one of:
- ppm_param_io_root
- ppm_param_io_concat
- ppm_param_io_sum
If not specified, default is ppm_param_io_concat
(Optional) iofmt
character, , (IN)
Format string (for ASCII I/O). Default is (*)
(Optional) ioprec
integer, , (IN)
Precision for binary I/O. One of:
- ppm_param_io_single
- ppm_param_io_double
Default is leave-as-is.
stat
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_alloc, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_close
This routine closes an IO channel.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | IO unit to be closed. | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (IN)
IO unit to be closed.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_io_delete
This routine deletes a file.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
character | (IN) | Name of the file to be deleted | |||
integer | (IN) | I/O mode. One of: | |||
integer | (OUT) | Return status, 0 on success |
filename
character, , (IN)
Name of the file to be deleted
mode
integer, , (IN)
I/O mode. One of:
- ppm_param_io_distributed
- ppm_param_io_centralized
In the distributed mode, every processor deletes the file locally. In the centralized mode, only processor 0 deletes the file.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_inquire
This routine inquires the state of a given ppm I/O unit.
| Note |
|---|---|
All output arguments are optional. It is adivised to use explicit argument naming when using this routine. Example: |
CALL ppm_inquire(20,MODE=imode,STAT=info)
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | IO unit to be inquired | |||
logical | (OUT) | Either: | |||
integer | (OUT) | I/O mode. One of: | |||
integer | (OUT) | I/O format. One of: | |||
integer | (OUT) | Return code. 0 on success. |
iunit
integer, , (IN)
IO unit to be inquired
isopen
logical, , (OUT)
Either:
-
.TRUE.if the unit is open on the local processor. -
.FALSE.otherwise
mode
integer, , (OUT)
I/O mode. One of:
- ppm_param_io_centralized
- ppm_param_io_distributed
- ppm_param_undefined
pfmt
integer, , (OUT)
I/O format. One of:
- ppm_param_io_ascii
- ppm_param_io_binary
- ppm_param_undefined
stat
integer, , (OUT)
Return code. 0 on success.
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_io_open
This routine opens an IO channel for parallel reading and/or writing and associates the given I/O unit with the file indicated.
| Note |
|---|---|
There are lots of |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (INOUT) | Fortran IO unit to be used. If -1 is given on input, the | |||
character | (IN) | Name of the file to which IO refers | |||
integer | (IN) | I/O action. One of: | |||
integer | (IN) | Position for I/O in file. This is only relavent for writing | |||
integer | (IN) | Format of I/O. One of: | |||
integer | (IN) | Parallel mode. Specifies whether every processor writes its data | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (INOUT)
Fortran IO unit to be used. If -1 is given on input, the routine will find an unused unit and return it here.
filename
character, , (IN)
Name of the file to which IO refers
actn
integer, , (IN)
I/O action. One of:
- ppm_param_io_write
- ppm_param_io_read
- ppm_param_io_read_write
posn
integer, , (IN)
Position for I/O in file. This is only relavent for writing action. One of:
- ppm_param_io_replace
- ppm_param_io_append
pfmt
integer, , (IN)
Format of I/O. One of:
- ppm_param_io_ascii
- ppm_param_io_binary
pmode
integer, , (IN)
Parallel mode. Specifies whether every processor writes its data to a local file or if all data is routed to rank 0, which is writing everything into one single file. One of:
- ppm_param_io_distributed
- ppm_param_io_centralized
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_data_io, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_io_set_unit
This routine is called by the user to set the IO
units for stdout, stderr and log file as used by
ppm_error, ppm_log and ppm_write.
| Note |
|---|---|
Any unit can be given a negative number in which case the corresponding output is supressed. |
| Caution |
|---|---|
If units are files, the files are automatically opened and replaced. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | X | Unit number for stdout | ||
integer | (IN) | X | Unit number for stderr | ||
integer | (IN) | X | Unit number for logfile | ||
integer | (OUT) | Return status, 0 on success |
(Optional) stdout
integer, , (IN)
Unit number for stdout
(Optional) stderr
integer, , (IN)
Unit number for stderr
(Optional) logfile
integer, , (IN)
Unit number for logfile
info
integer, , (OUT)
Return status, 0 on success
Used Modules
Subroutine ppm_io_unused_unit
This routine finds the next available unit number starting from the given one and counting upwards.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (INOUT) | On input: starting number. | |||
integer | (OUT) | Return status, 0 on success |
iunit
integer, , (INOUT)
On input: starting number.
On output: next free unit number.
-1 is returned if no free unit number .LE. 255 was found.
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
This module provides the routines callable from the outside.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
Returns global initialization status of ppm |
Subroutine ppm_is_initialized
Returns global initialization status of ppm
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
logical | (OUT) |
| |||
integer | (OUT) | Return status, 0 on success |
initd
logical, , (OUT)
TRUE if ppm is initialized (i.e. ppm_init has been called,
but not yet ppm_finalize). Otherwise FALSE
info
integer, , (OUT)
Return status, 0 on success
Used Modules
This module contains all routines needed for dynamic load balancing.
Currently only the SOR (stop at rise) method is provided as the heuristic to estimate the time when the domain needs to be redecomposed.
Subroutines contained in this interface:
| name | description |
|---|---|
This routine can be used to estimate the relative speeds | |
This routine can be used to estimate the relative speeds |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine calculates the computational cost of each subdomain | |
This routine calculates the computational cost of each subdomain |
Subroutines contained in this interface:
| name | description |
|---|---|
Inquires about the load balance status and returns advise whether | |
Inquires about the load balance status and returns advise whether |
Subroutines contained in this interface:
| name | description |
|---|---|
Sets/updates the internal estimate for the computational cost | |
Sets/updates the internal estimate for the computational cost |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine can be used by the user to set the relative speeds of | |
This routine can be used by the user to set the relative speeds of |
Subroutine est_procspeed_d
This routine can be used to estimate the relative speeds of the processors. It is also being used in subs2proc for load balancing. The estimation is done by computing a number of Lennard-Jones PP interactions.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Relative speeds of all processors from 0 to ppm_nproc-1. The numbers | |||
integer | (OUT) | return status, 0 on success | |||
real | (IN) | X | OPTIONAL Minimum time for which benchmark is required to run on each | ||
real | (IN) | X | OPTIONAL Benchmark stops as soon as slowest processor has run for | ||
integer | (IN) | X | Initial number of LJ-particles to use. OPTIONAL. Default is |
procspeed
real array, (:), no intent declared
Relative speeds of all processors from 0 to ppm_nproc-1. The numbers do sum up to 1.
info
integer, , (OUT)
return status, 0 on success
(Optional) mintime
real, , (IN)
OPTIONAL Minimum time for which benchmark is required to run on each processor. Default is 0.1 seconds.
(Optional) maxtime
real, , (IN)
OPTIONAL Benchmark stops as soon as slowest processor has run for this time (provided that mintime requirement is met). Default is 5 seconds
(Optional) npart
integer, , (IN)
Initial number of LJ-particles to use. OPTIONAL. Default is 1000. Set this to a smaller value when running on a slow processor. Increase is done automatically to meet the time requirements.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_util_time, ppm_module_write, ppm_module_substart
Subroutine est_procspeed_s
This routine can be used to estimate the relative speeds of the processors. It is also being used in subs2proc for load balancing. The estimation is done by computing a number of Lennard-Jones PP interactions.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (:) | Relative speeds of all processors from 0 to ppm_nproc-1. The numbers | |||
integer | (OUT) | return status, 0 on success | |||
real | (IN) | X | OPTIONAL Minimum time for which benchmark is required to run on each | ||
real | (IN) | X | OPTIONAL Benchmark stops as soon as slowest processor has run for | ||
integer | (IN) | X | Initial number of LJ-particles to use. OPTIONAL. Default is |
procspeed
real array, (:), no intent declared
Relative speeds of all processors from 0 to ppm_nproc-1. The numbers do sum up to 1.
info
integer, , (OUT)
return status, 0 on success
(Optional) mintime
real, , (IN)
OPTIONAL Minimum time for which benchmark is required to run on each processor. Default is 0.1 seconds.
(Optional) maxtime
real, , (IN)
OPTIONAL Benchmark stops as soon as slowest processor has run for this time (provided that mintime requirement is met). Default is 5 seconds
(Optional) npart
integer, , (IN)
Initial number of LJ-particles to use. OPTIONAL. Default is 1000. Set this to a smaller value when running on a slow processor. Increase is done automatically to meet the time requirements.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_util_time, ppm_module_write, ppm_module_substart
Subroutine loadbal_inq_d
Inquires about the load balance status and returns advise whether redecomposing the problem is recommended (based on some decision heuristic the user chooses).
| Tip |
|---|---|
The user should time (using ppm_time) computations for the topology/topologies considered for dyanmic remaping. The elapsed time is given to this routine. |
| Note |
|---|---|
This estimate is currently a scalar, so only one topology/set of
topologies can be monitored. Introducing a topology set ID and making
the internal estimates a vector, this can later be extended to
multiple topology sets if needed. The topology set
ID for which to evaluate the load balance will then be an additional
argument to this routine. This routine does two global MPI
communication operations ( |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real | (IN) | Elapsed time (as measured by | |||
integer | (IN) | Number of time steps since last redecomposition. (>0) | |||
integer | (IN) | Decision heuristic for redecomposition advise. One of: | |||
logical | (IN) |
| |||
real | (OUT) | Load imbalance defined as the ratio of computation time of the | |||
logical | (OUT) |
| |||
integer | (OUT) | Estimated (linear extrapolation) number of time steps to go until next | |||
integer | (OUT) | Returns status, 0 upon success |
ctime
real, , (IN)
Elapsed time (as measured by ppm_time) for all computation in one
time step on the local processor.
nstep
integer, , (IN)
Number of time steps since last redecomposition. (>0) If this routine is not called every time step, linear interpolation of the load imbalance will be used to reconstruct missing data points.
heuristic
integer, , (IN)
Decision heuristic for redecomposition advise. One of:
- ppm_param_loadbal_sar (Stop-at-Rise heuristic)
lflush
logical, , (IN)
TRUE to flush internal statistics (e.g. the first time this routine
is called after actually doing a redecomposition of the problem),
FALSE to continue gathering statistics.
imbal
real, , (OUT)
Load imbalance defined as the ratio of computation time of the bottleneck processor to the average computation time of all processors.
lredecomp
logical, , (OUT)
TRUE if the choosen heuristic recommends problem redecomposition.
Otherwise FALSE. Redecomposition means: do the ppm_topo_mktopo again.
nredest
integer, , (OUT)
Estimated (linear extrapolation) number of time steps to go until next advised redecomposition. -1 is returned if the chosen heuristic does not support this kind of information. Be careful with this value!
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_data_loadbal, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine loadbal_inq_s
Inquires about the load balance status and returns advise whether redecomposing the problem is recommended (based on some decision heuristic the user chooses).
| Tip |
|---|---|
The user should time (using ppm_time) computations for the topology/topologies considered for dyanmic remaping. The elapsed time is given to this routine. |
| Note |
|---|---|
This estimate is currently a scalar, so only one topology/set of
topologies can be monitored. Introducing a topology set ID and making
the internal estimates a vector, this can later be extended to
multiple topology sets if needed. The topology set
ID for which to evaluate the load balance will then be an additional
argument to this routine. This routine does two global MPI
communication operations ( |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real | (IN) | Elapsed time (as measured by | |||
integer | (IN) | Number of time steps since last redecomposition. (>0) | |||
integer | (IN) | Decision heuristic for redecomposition advise. One of: | |||
logical | (IN) |
| |||
real | (OUT) | Load imbalance defined as the ratio of computation time of the | |||
logical | (OUT) |
| |||
integer | (OUT) | Estimated (linear extrapolation) number of time steps to go until next | |||
integer | (OUT) | Returns status, 0 upon success |
ctime
real, , (IN)
Elapsed time (as measured by ppm_time) for all computation in one
time step on the local processor.
nstep
integer, , (IN)
Number of time steps since last redecomposition. (>0) If this routine is not called every time step, linear interpolation of the load imbalance will be used to reconstruct missing data points.
heuristic
integer, , (IN)
Decision heuristic for redecomposition advise. One of:
- ppm_param_loadbal_sar (Stop-at-Rise heuristic)
lflush
logical, , (IN)
TRUE to flush internal statistics (e.g. the first time this routine
is called after actually doing a redecomposition of the problem),
FALSE to continue gathering statistics.
imbal
real, , (OUT)
Load imbalance defined as the ratio of computation time of the bottleneck processor to the average computation time of all processors.
lredecomp
logical, , (OUT)
TRUE if the choosen heuristic recommends problem redecomposition.
Otherwise FALSE. Redecomposition means: do the ppm_topo_mktopo again.
nredest
integer, , (OUT)
Estimated (linear extrapolation) number of time steps to go until next advised redecomposition. -1 is returned if the chosen heuristic does not support this kind of information. Be careful with this value!
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_data_loadbal, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine ppm_get_cost_d
This routine calculates the computational cost of each subdomain and each processor.
| Note |
|---|---|
If Np > 0, cost is computed based on particles. If mesh_id > -1, cost based on mesh points is computed and added to the particle cost. If neither particles nor mesh are given, cost of a subdomain is equal to its volume. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID for which to compute the cost. | |||
integer | (IN) | mesh ID for which to compute the cost. | |||
real array | (:,:) | (IN) | Particle positions | ||
integer | (IN) | Number of particles. Set to ⇐ 0 if mesh-based costs are desired. | |||
real array | (:) | Aggregate cost for each subdomain | |||
real array | (:) | Aggregate cost for each processor | |||
integer | (OUT) | Returns status, 0 upon success | |||
real array | (:) | (IN) | X | per-particle costs. |
topoid
integer, , (IN)
Topology ID for which to compute the cost.
If ppm_param_topo_undefined all particle positions on the processor
are considered to compute the cost
meshid
integer, , (IN)
mesh ID for which to compute the cost. If -1 is passed, only particles are considered and the mesh is ignored. If there are no particles and mesh_id is -1, the costs are computed based on the geometry: cost(sub) = volume(sub).
xp
real array, (:,:), (IN)
Particle positions
np
integer, , (IN)
Number of particles. Set to ⇐ 0 if mesh-based costs are desired.
cost
real array, (:), no intent declared
Aggregate cost for each subdomain
proc_cost
real array, (:), no intent declared
Aggregate cost for each processor
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) pcost
real array, (:), (IN)
per-particle costs. If not present, a cost of 1.0 per particle is assumed.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_topo_cost, ppm_module_write, ppm_module_substart
Subroutine ppm_get_cost_s
This routine calculates the computational cost of each subdomain and each processor.
| Note |
|---|---|
If Np > 0, cost is computed based on particles. If mesh_id > -1, cost based on mesh points is computed and added to the particle cost. If neither particles nor mesh are given, cost of a subdomain is equal to its volume. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID for which to compute the cost. | |||
integer | (IN) | mesh ID for which to compute the cost. | |||
real array | (:,:) | (IN) | Particle positions | ||
integer | (IN) | Number of particles. Set to ⇐ 0 if mesh-based costs are desired. | |||
real array | (:) | Aggregate cost for each subdomain | |||
real array | (:) | Aggregate cost for each processor | |||
integer | (OUT) | Returns status, 0 upon success | |||
real array | (:) | (IN) | X | per-particle costs. |
topoid
integer, , (IN)
Topology ID for which to compute the cost.
If ppm_param_topo_undefined all particle positions on the processor
are considered to compute the cost
meshid
integer, , (IN)
mesh ID for which to compute the cost. If -1 is passed, only particles are considered and the mesh is ignored. If there are no particles and mesh_id is -1, the costs are computed based on the geometry: cost(sub) = volume(sub).
xp
real array, (:,:), (IN)
Particle positions
np
integer, , (IN)
Number of particles. Set to ⇐ 0 if mesh-based costs are desired.
cost
real array, (:), no intent declared
Aggregate cost for each subdomain
proc_cost
real array, (:), no intent declared
Aggregate cost for each processor
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) pcost
real array, (:), (IN)
per-particle costs. If not present, a cost of 1.0 per particle is assumed.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_topo_cost, ppm_module_write, ppm_module_substart
Subroutine ppm_set_proc_speed_d
This routine can be used by the user to set the relative speeds of the processors (is used in subs2proc for load balancing).
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (0:) | (IN) | Relative speeds of all processors from 0 to ppm_nproc-1. The numbers | ||
integer | (OUT) | Returns status, 0 upon success |
proc_speed
real array, (0:), (IN)
Relative speeds of all processors from 0 to ppm_nproc-1. The numbers must sum up to 1.
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine ppm_set_proc_speed_s
This routine can be used by the user to set the relative speeds of the processors (is used in subs2proc for load balancing).
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real array | (0:) | (IN) | Relative speeds of all processors from 0 to ppm_nproc-1. The numbers | ||
integer | (OUT) | Returns status, 0 upon success |
proc_speed
real array, (0:), (IN)
Relative speeds of all processors from 0 to ppm_nproc-1. The numbers must sum up to 1.
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_substop, ppm_module_substart
Subroutine set_dcost_d
Sets/updates the internal estimate for the computational cost associated with redecomposing the problem. The user can choose the update method.
| Tip |
|---|---|
The user should time (using |
| Note |
|---|---|
This estimate is currently a scalar, so only one topology/set of topologies can be monitored. Introducing a topology set ID and making the internal estimates a vector, this can later be extended to multiple topology sets if needed. The topology set ID (in external numbering) for which to update the cost estimate will then be an additional argument to this routine. |
| Note |
|---|---|
This routine does a global MPI operation ( |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real | (IN) | Elapsed time (as measured by | |||
integer | (IN) | How to update the internal estimate. | |||
integer | (OUT) | Returns status, 0 upon success |
dcost
real, , (IN)
Elapsed time (as measured by ppm_time)
for defining the topology/ies of interest on the local processor.
method
integer, , (IN)
How to update the internal estimate. One of:
- ppm_param_update_replace (overwrite old value with new one)
- ppm_param_update_average (compute running average)
- ppm_param_update_expfavg (running average with exponential forgetting)
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_data_loadbal, ppm_module_substop, ppm_module_write, ppm_module_substart
Subroutine set_dcost_s
Sets/updates the internal estimate for the computational cost associated with redecomposing the problem. The user can choose the update method.
| Tip |
|---|---|
The user should time (using |
| Note |
|---|---|
This estimate is currently a scalar, so only one topology/set of topologies can be monitored. Introducing a topology set ID and making the internal estimates a vector, this can later be extended to multiple topology sets if needed. The topology set ID (in external numbering) for which to update the cost estimate will then be an additional argument to this routine. |
| Note |
|---|---|
This routine does a global MPI operation ( |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
real | (IN) | Elapsed time (as measured by | |||
integer | (IN) | How to update the internal estimate. | |||
integer | (OUT) | Returns status, 0 upon success |
dcost
real, , (IN)
Elapsed time (as measured by ppm_time)
for defining the topology/ies of interest on the local processor.
method
integer, , (IN)
How to update the internal estimate. One of:
- ppm_param_update_replace (overwrite old value with new one)
- ppm_param_update_average (compute running average)
- ppm_param_update_expfavg (running average with exponential forgetting)
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_data_loadbal, ppm_module_substop, ppm_module_write, ppm_module_substart
This module provides the utility routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine writes a log message to the ppm log file |
Subroutine ppm_log
This routine writes a log message to the ppm log file (as defined using ppm_set_unit)
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
character | (IN) | Name of calling subroutine | |||
character | (IN) | Log message | |||
integer | (INOUT) | Returns status, 0 upon success |
caller
character, , (IN)
Name of calling subroutine
mesg
character, , (IN)
Log message
info
integer, , (INOUT)
Returns status, 0 upon success
Used Modules
This module contains all user-callable routines for mapping particles and fields.
You may either USE this module or directly the modules for the
subroutines you will be using.
| name | type | dimension | description |
|---|---|---|---|
no variables | |||
Used Modules
ppm_module_map_connect, ppm_module_map_field_global, ppm_module_map_part_util, ppm_module_map_part_ghost, ppm_module_map_part, ppm_module_map_part_global, ppm_module_map_field, ppm_module_map_field_ghost, ppm_module_map_part_partial, ppm_module_impose_part_bc
This module provides the mapping routines for connections
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine distributes the connections to all processors such |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine prunes all connections that are not needed |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine sends and receives the connection data |
Subroutine ppm_map_connect_distrib
This routine distributes the connections to all processors such that every processor has all the connections it has at least one particle for.
This routine directly sends and receives the connection data as integers
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:) | Connection data | |||
integer | (IN) | Leading dimension of cd(:,:) | |||
integer | (INOUT) | Number of connections | |||
integer array | (:) | (IN) | Local to global particle number mapping | ||
integer | (IN) | Number of particles | |||
integer | (OUT) | Returns status, 0 upon success |
cd
integer array, (:,:), no intent declared
Connection data
lda
integer, , (IN)
Leading dimension of cd(:,:)
ncon
integer, , (INOUT)
Number of connections
id
integer array, (:), (IN)
Local to global particle number mapping
npart
integer, , (IN)
Number of particles
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart, ppm_module_util_invert_list
Subroutine ppm_map_connect_prune
This routine prunes all connections that are not needed on this processor according to the current topology and whether symmetry will be used or not.
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | ID of current topology | |||
integer array | (:,:) | Connection data | |||
integer | (IN) | Leading dimension of cd(:,:) | |||
integer | (INOUT) | Number of connections | |||
integer array | (:) | (IN) | Local to global particle number mapping | ||
integer | (IN) | Number of particles | |||
logical | (IN) | Is symmetric? | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
ID of current topology
cd
integer array, (:,:), no intent declared
Connection data
lda
integer, , (IN)
Leading dimension of cd(:,:)
ncon
integer, , (INOUT)
Number of connections
id
integer array, (:), (IN)
Local to global particle number mapping
npart
integer, , (IN)
Number of particles
lsymm
logical, , (IN)
Is symmetric?
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart, ppm_module_util_invert_list
Subroutine ppm_map_connect_send
This routine sends and receives the connection data
according to the information stored in ppm_buffer2part
| Note |
|---|---|
This routine directly sends and receives the connection data as integers |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer array | (:,:) | Connection data | |||
integer | (IN) | The leading dimension of cd(:,:) | |||
integer | (INOUT) | Number of connections | |||
integer array | (:) | (IN) | Local to global particle number mapping | ||
integer | (IN) | Number of particles | |||
integer | (OUT) | Returns status, 0 upon success |
cd
integer array, (:,:), no intent declared
Connection data
lda
integer, , (IN)
The leading dimension of cd(:,:)
ncon
integer, , (INOUT)
Number of connections
id
integer array, (:), (IN)
Local to global particle number mapping
npart
integer, , (IN)
Number of particles
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_substart, ppm_module_util_invert_list
This module contains interfaces to the field mapping routines
and all data structures and definitions that
are PRIVATE to the mesh routines.
| Note |
|---|---|
The terminology distinguishes between meshes and fields (the data living on the meshes). Several fields can use the same mesh. Meshes are defined as ppm-internal TYPES, whereas fields are user-provided arrays. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine must be called before the ppm_map_field_globalstored |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 2D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data | |
This routine pops the list buffer for 3D mesh data |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine pushes field data onto the send buffer for 2D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. | |
This routine pushes field data onto the send buffer for 3D meshes. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine performs the actual send/recv of the |
Subroutine ppm_map_field_init
This routine must be called before the ppm_map_field_globalstored routine.
| Warning |
|---|---|
This routine has not been tested, reviewed, or checked. Comments and documentation are wrong. This routine might kill your cat or worse. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_d
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_dc
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_i
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
integer array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
integer array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_l
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
logical array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
logical array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_s
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_sca_sc
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:) | Field data. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_d
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_dc
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_i
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
integer array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
integer array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_l
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
logical array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
logical array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_s
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_2d_vec_sc
This routine pops the list buffer for 2D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Size of the ghost layer (in mesh points) in each dimension. | ||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Size of the ghost layer (in mesh points) in each dimension.
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_d
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_dc
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_i
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
integer array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
integer array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_l
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
logical array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
logical array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_s
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_sca_sc
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:) | Field data. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_d
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_dc
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_i
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
integer array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
integer array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_l
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
logical array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
logical array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_s
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
real array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
real array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_pop_3d_vec_sc
This routine pops the list buffer for 3D mesh data
| Note |
|---|---|
The on-processor data is in the first part of the buffer Reallocates the fdata array if needed. The user does not need to care about its size. If we want to change this to improve callability from C, argument checks should be added for the SIZE of fdata. If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimemsion ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of destination | |||
integer | (IN) | Mesh ID of destination | |||
complex array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer array | (:) | (IN) | Number of mesh points in the ghost layer in each dimension | ||
integer | (OUT) | Return status, 0 on success | |||
logical array | (:,:,:,:) | X | Logical mask. |
target_topoid
integer, , (IN)
Topology ID of destination
target_meshid
integer, , (IN)
Mesh ID of destination
fdata
complex array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
ghostsize
integer array, (:), (IN)
Number of mesh points in the ghost layer in each dimension
info
integer, , (OUT)
Return status, 0 on success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_d
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
real array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
real array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_dc
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
complex array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
complex array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_i
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
integer array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
integer array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_l
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
logical array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
logical array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_s
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
real array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
real array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_sca_sc
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
complex array | (:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
complex array, (:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_d
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
real array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_dc
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_i
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
integer array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
integer array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_l
This routine pushes field data onto the send buffer for 2D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
logical array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
logical array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_s
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
real array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_2d_vec_sc
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Mesh ID of source | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (IN) | The leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
Topology ID of source
meshid
integer, , (IN)
Mesh ID of source
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-3th index: mesh (i,j) relative to istart-1 of the sub (i.e. (i,j)=(1,1) corresponds to istart) 4th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
The leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-2nd index: mesh (i,j) 3rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_d
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
real array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_dc
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_i
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
integer array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
integer array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_l
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
logical array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
logical array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_s
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
real array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
real array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_sca_sc
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
complex array | (:,:,:,:) | Field data. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
complex array, (:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_d
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
real array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
real array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_dc
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
complex array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
complex array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_i
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
integer array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
integer array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_l
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
logical array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
logical array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_s
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
real array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
real array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_push_3d_vec_sc
This routine pushes field data onto the send buffer for 3D meshes.
| Note |
|---|---|
The on-processor data is stored in the first part of the buffer If the call to invert_list is too slow here, this could be done by topo_store and stored for each topology. At the expense of some extra memory. The fdata arrays are passed as When Ndata is determined, the mask is not considered. This could lead to a too large sendbuffer being allocated in the last push and could be optimized later. |
| Warning |
|---|---|
DIM is the dimension of the fdata array and not the space dimension ppm_dim! |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | topology ID of source | |||
integer | (IN) | mesh ID of source | |||
complex array | (:,:,:,:,:) | Field data. | |||
integer | (IN) | the leading dimension of the fdata. | |||
integer | (OUT) | Returns status, 0 upon success | |||
logical array | (:,:,:,:) | X | Logical mask. |
topoid
integer, , (IN)
topology ID of source
meshid
integer, , (IN)
mesh ID of source
fdata
complex array, (:,:,:,:,:), no intent declared
Field data.
1st index: lda 2nd-4th index: mesh (i,j,k) relative to istart-1 of the sub (i.e. (i,j,k)=(1,1,1) corresponds to istart) 5th: isub 1…nsublist (all subs on this processor).
For scalar fields, the first index is omitted (the others shift accordingly).
lda
integer, , (IN)
the leading dimension of the fdata. lda=1 for the case of scalar data
info
integer, , (OUT)
Returns status, 0 upon success
(Optional) mask
logical array, (:,:,:,:), no intent declared
Logical mask.
Only the mesh nodes for which this is .TRUE. will be mapped. If not given, all points are mapped.
1st-3nd index: mesh (i,j,k) 4rd: isub.
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_util_invert_list, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_send
This routine performs the actual send/recv of the mesh blocks and all pushed data.
| Note |
|---|---|
The first part of the buffer contains the on processor data. |
| Note |
|---|---|
Using non-blocking communication (ISend,Irecv) could possibly speed-up this routine since only a Send/Recv/SendRecv is done where needed (we know a priori how much data we are going to receive). Skipped actions could then already loop to the next item and would not have to wait for others. |
| Tip |
|---|---|
If you want to only send certain meshnodes you have to first call ppm_map_field_push for a logical mask, then call ppm_map_field_pop and recover the new mask. First 3 (2 for 2D meshes) indices are mesh (i,j[,k]), last one is subid for all subs on the local processor. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (OUT) | Return status, 0 upon success |
info
integer, , (OUT)
Return status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_substop, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
This module contains interfaces to the field ghost mapping routines
and all data structures and definitions that
are PRIVATE to the mesh routines.
| Note |
|---|---|
The terminology distinguishes between meshes and fields (the data living on the meshes). Several fields can use the same mesh. Meshes are defined as per-topology ppm-internal types, whereas fields are user-provided arrays. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine receives/updates the values of the ghost mesh points of |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine sets up the lists needed for sending and receiving |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine sends the values of ghost mesh points |
Subroutine ppm_map_field_ghost_get
This routine receives/updates the values of the ghost mesh points of each sub from its corresponding neighbor subs (i.e. adds ghost layers to the subs of the current topology).
![[Important]](images/important.png) | Important |
|---|---|
|
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID | |||
integer | (IN) | Mesh ID | |||
integer array | (:) | (IN) | Size of the ghost layer in numbers of grid points in all space | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID
meshid
integer, , (IN)
Mesh ID
ghostsize
integer array, (:), (IN)
Size of the ghost layer in numbers of grid points in all space dimensions (1…ppm_dim).
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_substart
Subroutine ppm_map_field_ghost_init
This routine sets up the lists needed for sending and receiving
ghost mesh points on a given topology/mesh combination.
These lists are stored for later use by ppm_map_field_ghost_get and
ppm_map_field_ghost_put.
| Important |
|---|---|
This routine should never be called by the user, the library will
call this routine before the first |
| Note |
|---|---|
The lists are now saved in the mesh structure for which the ghost mappings are initialized. There is no need to reinitialize after doing global mappings |
| Warning |
|---|---|
The new version of this routine might cause some memory overhead |
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. The names send and recv are correct for the ghost get map. For the put case, they need to be interpreted the other way round. The shift cases for periodic images are currently hard coded. Probably there is a more elegant way of doing this. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID | |||
integer | (IN) | Mesh ID | |||
integer array | (:) | (IN) | Size of the ghost layer in numbers of grid points in all space | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID
meshid
integer, , (IN)
Mesh ID
ghostsize
integer array, (:), (IN)
Size of the ghost layer in numbers of grid points in all space dimensions (1…ppm_dim).
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_util_commopt, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_ghost_put
This routine sends the values of ghost mesh points back to their origin in order to add their contribution to the corresponding real mesh point.
| Important |
|---|---|
|
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID | |||
integer | (IN) | Mesh ID | |||
integer array | (:) | (IN) | Size of the ghost layer in numbers of grid points in all space | ||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID
meshid
integer, , (IN)
Mesh ID
ghostsize
integer array, (:), (IN)
Size of the ghost layer in numbers of grid points in all space dimensions (1…ppm_dim).
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_data_mesh, ppm_module_substart
This module contains the interface and the needed work arrays for the field global mappings.
| Note |
|---|---|
The terminology distinguishes between meshes and fields (the data living on the meshes). Several fields can use the same mesh. Meshes are defined as ppm-internal TYPES, whereas fields are user-provided arrays. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine maps field data between two topologies (which |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine maps field data between two topologies |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine maps field data between two topologies (which however |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine maps field data between two topologies (which |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine maps field data between two topologies |
Subroutine ppm_map_field_global
This routine maps field data between two topologies (which
however need compatible meshes defined on them) using a global
mapping (i.e. every processor communicates with every other).
Source mesh must be on the current field topology. Global lists
with all mesh blocks that have to be sent and/or received are
built in this routine. ppm_map_field_push, ppm_map_field_pop and
ppm_map_field_send will use these lists.
| Note |
|---|---|
The first part of the send/recv lists contains on-processor data. |
| Caution |
|---|---|
Side effect: this routine uses the same global send/recv buffers, pointers and lists as the particle mapping routines (reason: these buffers can be large ⇒ memory issues). Field and particle mappings can therefore never overlap, but one must be completed before the other starts. |
| Note |
|---|---|
A map_field_partial could be constructed as follows: every processor
known both |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target topo ID |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_global_symm
This routine maps field data between two topologies (which however need compatible meshes defined on them) using a global mapping (i.e. every processor communicates with every other). Source mesh must be on the current field topology. Global lists with all mesh blocks that have to be send and/or received are built in this routine. Push, pop and send will use these lists.
| Warning |
|---|---|
This routine has not been tested, reviewed, or checked. Comments and documentation are wrong. This routine might kill your cat or worse. |
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
| Caution |
|---|---|
Side effect: this routine uses the same global send/recv buffers, pointers and lists as the particle mapping routines (reason: these buffers can be large ⇒ memory issues). Field and particle mappings can therefore never overlap, but one must be completed before the other starts. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Return status, 0 upon success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target topo ID |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Return status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_global_useperiod
This routine maps field data between two topologies (which however need compatible meshes defined on them) using a global mapping (i.e. every processor communicates with every other). Source mesh must be on the current field topology. Global lists with all mesh blocks that have to be send and/or received are built in this routine. Push, pop and send will use these lists.
| Warning |
|---|---|
This routine has not been tested, reviewed, or checked. Comments and documentation are wrong. This routine might kill your cat or worse. |
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
| Caution |
|---|---|
Side effect: this routine uses the same global send/recv buffers, pointers and lists as the particle mapping routines (reason: these buffers can be large ⇒ memory issues). Field and particle mappings can therefore never overlap, but one must be completed before the other starts. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_global_useperiod_store
This routine maps field data between two topologies (which however need compatible meshes defined on them) using a global mapping (i.e. every processor communicates with every other). Source mesh must be on the current field topology. Global lists with all mesh blocks that have to be send and/or received are built in this routine. Push, pop and send will use these lists.
| Warning |
|---|---|
This routine has not been tested, reviewed, or checked. Comments and documentation are wrong. This routine might kill your cat or worse. |
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
| Caution |
|---|---|
Side effect: this routine uses the same global send/recv buffers, pointers and lists as the particle mapping routines (reason: these buffers can be large ⇒ memory issues). Field and particle mappings can therefore never overlap, but one must be completed before the other starts. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Returns status, 0 upon success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Returns status, 0 upon success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
Subroutine ppm_map_field_globalstored
This routine maps field data between two topologies (which however need compatible meshes defined on them) using a global mapping (i.e. every processor communicates with every other). Source mesh must be on the current field topology. Global lists with all mesh blocks that have to be send and/or received are built in this routine. Push, pop and send will use these lists.
| Warning |
|---|---|
This routine assumes that ppm_map_field_init was called before |
| Warning |
|---|---|
This routine has not been tested, reviewed, or checked. Comments and documentation are wrong. This routine might kill your cat or worse. |
| Note |
|---|---|
The first part of the send/recv lists contains the on-processor data. |
| Caution |
|---|---|
Side effect: this routine uses the same global send/recv buffers, pointers and lists as the particle mapping routines (reason: these buffers can be large ⇒ memory issues). Field and particle mappings can therefore never overlap, but one must be completed before the other starts. |
Arguments
| name | type | dimension | intent | optional | description |
|---|---|---|---|---|---|
integer | (IN) | Topology ID of source | |||
integer | (IN) | Topology ID of target | |||
integer | (IN) | Mesh ID of source | |||
integer | (IN) | Mesh ID of target | |||
integer | (OUT) | Return status, 0 on success |
topoid
integer, , (IN)
Topology ID of source
| Caution |
|---|---|
used to be target |
target_topoid
integer, , (IN)
Topology ID of target
meshid
integer, , (IN)
Mesh ID of source
target_meshid
integer, , (IN)
Mesh ID of target
info
integer, , (OUT)
Return status, 0 on success
Used Modules
ppm_module_data, ppm_module_error, ppm_module_typedef, ppm_module_alloc, ppm_module_check_id, ppm_module_substop, ppm_module_mesh_block_intersect, ppm_module_data_mesh, ppm_module_write, ppm_module_substart
This module provides the basic mapping routines for particles, namely the push, sned and pop routine.
The module also holds the needed work arrays for these routines.
| name | description |
|---|---|
Subroutines contained in this interface:
| name | description |
|---|---|
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. | |
This routine pops the contents of the receive buffer. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. | |
This routine pushes particle data onto the send buffer. |
Subroutines contained in this interface:
| name | description |
|---|---|
This routine performs the actual send/recv of the particles and all |
Subroutine ppm_map_part_pop_1dd
This routine pops the contents of the receive buffer.
| Note |
|---|---|
The first part of the buffer contains the on processor data. The packing could be performed more efficiently. |
| Note |
|---|---|
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="cor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
| Note |
|---|---|
The first part of the buffer contains the on processor data. The packing could be performed more efficiently. (does the size(,) stuff also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="ccor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
| Note |
|---|---|
The first part of the buffer contains the on processor data. The packing could be performed more efficiently. (does the size(,) stuff also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="ior">ppitle="Module pppm_mod/a>, Calling ppm_map_pa, Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
| Note |
|---|---|
The first part of the buffer contains the on processor data. The packing could be performed more efficiently. (does the size(,) stuff also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="lor">ppitle="Module pppm_mod/a>, Calling ppm_map_palogiceft.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
| Note |
|---|---|
The first part of the buffer contains the on processor data. The packing could be performed more efficiently. (does the size(,) stuff also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="sor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
| Note |
|---|---|
The first part of the buffer contains the on processor
data. The packing could be performed more efficiently.(does the size(,) stuff
also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align="scor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mges/>Nonumbnamefpm_map_part(tr>
integer, , (IN)
Mgesnewonumbnamefpm_map_part(tr>
![[Note]](images/lds/note.png) | Note |
|---|---|
The first part of the buffer contains the on processor
data. The packing could be performed more efficiently.(does the size(,) stuff
also work if the array was allocated in a C client?) | Note |
Maybe remove the |
| Warning | ||||||
|---|---|---|---|---|---|---|---|
DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" align2"cor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receive b2ffcer. The first part of the buffer contains the on processor
data. The packing could be performed more efficiently.(does the size(,) stuff
also work if the array was allocated in a C client?) Maybe remove the DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid integer (IN) integer (IN) Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Note Note lda from the argument list (since
it is only used to check against ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?)Warning optional description <]" srcowspan="2" align2"ccor">ppitle="Module pppm_mod/a>, <]" srcowspan="2" align2"ccor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Nonumbnamefpm_map_part(tr>
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receive b2fier. The first part of the buffer contains the on processor
data. The packing could be performed more efficiently.(does the size(,) stuff
also work if the array was allocated in a C client?) Maybe remove the DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid integer (IN) integer (IN) Calling ppm_map_pa, Topology ID of source integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Note Note lda from the argument list (since
it is only used to check against ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?)Warning optional description <]" srcowspan="2" align2"ior">ppitle="Module pppm_mod/a>, <]" srcowspan="2" align2"ior">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Nonumbnamefpm_map_part(tr>
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receive b2fler. The first part of the buffer contains the on processor
data. The packing could be performed more efficientlyinst ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?) Maybe remove the DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid integer (IN) integer (IN) Calling ppm_map_palogiceft.png"r, , (IN) Topology ID of source integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Note Note lda from the argument list (since
it is only used to check against ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?)Warning optional description <]" srcowspan="2" align2"lor">ppitle="Module pppm_mod/a>, <]" srcowspan="2" align2"lor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Nonumbnamefpm_map_part(tr>
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receive b2fser. The first part of the buffer contains the on processor
data. The packing could be performed more efficientlyinst ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?) Maybe remove the DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid integer (IN) integer (IN) Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Note Note lda from the argument list (since
it is only used to check against ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?)Warning optional description <]" srcowspan="2" align2"sor">ppitle="Module pppm_mod/a>, <]" srcowspan="2" align2"sor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Nonumbnamefpm_map_part(tr>
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receive b2fscer. The first part of the buffer contains the on processor
data. The packing could be performed more efficientlainst ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?) Maybe remove the DIM is ialstored_arg_target_topoid" title="target_topoid">target_topoid integer (IN) integer (IN) Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Note Note lda from the argument list (since
it is only used to check against ppm_buffer_dim
anyway) and check size(pdata,1) against
ppm_buffer_dim. (does the size(,) stuff
also work if the array was allocated in a C client?)Warning optional description <]" srcowspan="2" align2"scor">ppitle="Module pppm_mod/a>, <]" srcowspan="2" align2"scor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Nonumbnamefpm_map_part(tr>
topoid
integer, , (IN)
Topology ID of source
| ppitle=iv> |
integer, , (IN)
Mgesl(IN="le" title="Suoud/a>,>ass="link" href="#ppm_mod> integer, , (IN) Mges/>Nonumbnamefpm_map_part(tr> integer, , (IN) Mgesnewonumbnamefpm_map_part(tr> This routine pops the contents of the receivush_1dder. Maybe remove the integer (IN) integer (IN) Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerass="link" href="#ppm_mod> ass="link" href="#ppm_mod> Ng" /> Note Noteoptional description <]" srcowspan="2" alush_1ddor">ppitle="Module pppm_mod/a>,
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1ddor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_1ddcor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1ddcor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_1dior">ppitle="Module pppm_mod/a>, Calling ppm_map_pa, Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1dior">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_1dlor">ppitle="Module pppm_mod/a>, Calling ppm_map_palogiceft.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1dlor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_1dsor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1dsor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_1dscor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_1dscor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Numbnamefpm_map_par
If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2ddor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2ddor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2ddcor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2ddcor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2dior">ppitle="Module pppm_mod/a>, Calling ppm_map_pa, Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2dior">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2dlor">ppitle="Module pppm_mod/a>, Calling ppm_map_palogiceft.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2dlor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2dsor">ppitle="Module pppm_mod/a>, Calling ppm_map_pareeft.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2dsor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||
|---|---|---|---|---|---|---|---|
Maybe remove the | integer | (IN) | optional | description | |||
integer | (IN) | <]" srcowspan="2" alush_2dscor">ppitle="Module pppm_mod/a>, Calling ppm_map_paalign=xt.png"r, , (IN) Topology ID of source integer |
integer, , (IN)
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srcowspan="2" alush_2dscor">ppushpptable>pushpp Calling ppm_map_palogiceftored_arg_topoid"> topoidinteger, , (IN) Topology ID of source integer | stroto>Xh> |
integer |
Proutines con>
Cl /> integer, , (IN) Mgesl(IN="le" title="Suoutines con>
integer, , (IN)
Numbnamefpm_map_parass="link" href="#ppm_mod> If>
| Note | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Maybe remove the | |||||||||||
integer | (IN) | <]" srcowspan=]" sr"endor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid integer, , (IN) Topology ID of source integer | Nonumbnamefpm_map_pars/notinese.png" /mary="Caution">> | <]" srcowspan="2" a"endor">pm"2" ="Module m"2" =>m"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid integer, , (IN) Topology ID of source <]" srcowspan="2" a"endor">py> | |
topoid
integer, , (IN)
Topology ID of source
topoid
integer, , (IN)
Topology ID of source
| p tioidf_modu tioididh5> integer, , (IN) "tiology IDid vaign="center" valign="top"]" srghost_powspan="2" aghost_putor">pi>ppm_module_error, ppm_56m_moduypedef, ppm_module_alloc, ppm_module_check_id, m_module_chpm_mdefk_id, ppm_module_mesh_block_check_idfer conta_intersect" title=check_idf>ect" title=check_id_block_intersect">ppm_module_mesh_block_le_data_mesh, ppm_module/trl_almmign_mesh, ass="link" /trl_almmigntle="Module ppm_module_write">ppm_modulewriuffer conta, ass="link" wriuftle="Module ppm_module_write">ppm_module">
<]" srglob c_rowspan="2" aglob c_dor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) | Topology ID of source integer <]" srglob c_rowspan="2" aglob c_dor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid | integer, , (IN) Topology ID of source integer <]" srglob c_rowspan="2" aglob c_dor">py> | |
topoid
integer, , (IN)
Topology ID of source
| <]" srglob c_rowspan="2" aglob c_dor">p_tyrdefe]" s2re.ptable>_tyrdefe]" s2re.p Topology ID of source | p argetp tioidf_modu argetp tioididh5> integer, , (IN) ID mg vaexist |
" wiposite="Suoutines_map_pargn="lign="center" valign="top"]" srglob c_rowspan="2" aglob c_dor">pn"2" =iv> integer, , (IN) Numbnamefpm_map_pars(/noloceftre.png" /)id vaign="center" valign="top"]" srglob c_rowspan="2" aglob c_dor">pi>ppm_module_error, p_tyrdefe]" s2re.p">modu(Ogn="lef) _tyrdefe]" s2re.p , <,
| Note | intent | optional | description | ||||
|---|---|---|---|---|---|---|---|
integer | (IN) | <]" srglob c_rowspan="2" aglob c_sor">p argetp tioidfer conta argetp tioidf> argetp tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid integer, , (IN) Topology ID of source integer |
Topology ID of source
integer
integer, , (IN)
Topology ID of source
integer
topoid
integer, , (IN)
Topology ID of source
| <]" srglob c_rowspan="2" aglob c_sor">p_tyrdefe]" s2re.ptable>_tyrdefe]" s2re.p Topology ID of source | p argetp tioidf_modu argetp tioididh5> integer, , (IN) ID mg vaexist |
" wiposite="Suoutines_map_pargn="lign="center" valign="top"]" srglob c_rowspan="2" aglob c_sor">pn"2" =iv> integer, , (IN) Numbnamefpm_map_pars(/noloceftre.png" /)id vaign="center" valign="top"]" srglob c_rowspan="2" aglob c_sor">pi>ppm_module_error, p_tyrdefe]" s2re.pt>modu(Ogn="lef) _tyrdefe]" s2re.p , <,
| Note | optional | description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
integer | (IN) | <]" srglob c_rowspan="2" arepan_dor">p tioidfer conta tioidf> tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid integer, , (IN) Topology ID of source integer | "tiology t: ntifinamefpn="tr>ate="Sttiologyft" valign="top"> | <]" srglob c_rowspan="2" arepan_dor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) Topology ID of source integer | <]" srglob c_rowspan="2" arepan_dor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid integer, , (IN) Topology ID of source integer | <]" srglob c_rowspan="2" arepan_dor">py> |
topoid
integer, , (IN)
Topology ID of source
| p tioidf>modu tioididh5> integer, , (IN) "tiology t: ntifinamefpn="tr>ate="Sttiologyft" vaign="center" valign="top"]" srglob c_rowspan="2" arepan_dor">pxnl_moduxnid/a>, |
" wiposite="Suoutines_map_pargn="lign="center" valign="top"]" srglob c_rowspan="2" arepan_dor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pars(/nore.png" /)id vaign="center" valign="top"]" srglob c_rowspan="2" arepan_dor">pi>ppm_module_error, ppm_60m_moduypedef, ppm_module_alloc, ppm_module_check_id, ect" title=check_id_block_intersect">ppm_module_mesh_block_le_data_mesh, ppm_module tio_checktitle="Module ppm_module_chptio_checkt>m_module_chptio_checktle="Module ppm_module_write">ppm_module"> integer (IN) integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integerxp>Ng" />"lef>
Note optional description <]" srglob c_rowspan="2" arepan_sor">p tioidfer conta tioidf> tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid "tiology t: ntifinamefpn="tr>ate="Sttiologyft" valign="top"> <]" srglob c_rowspan="2" arepan_sor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) <]" srglob c_rowspan="2" arepan_sor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid <]" srglob c_rowspan="2" arepan_sor">py>
topoid
integer, , (IN)
Topology ID of source
| p tioidf>modu tioididh5> integer, , (IN) "tiology t: ntifinamefpn="tr>ate="Sttiologyft" vaign="center" valign="top"]" srglob c_rowspan="2" arepan_sor">pxnl_moduxnid/a>, |
" wiposite="Suoutines_map_pargn="lign="center" valign="top"]" srglob c_rowspan="2" arepan_sor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pars(/nore.png" /)id vaign="center" valign="top"]" srglob c_rowspan="2" arepan_sor">pi>ppm_module_error, ppm_61m_moduypedef, ppm_module_alloc, ppm_module_check_id, ect" title=check_id_block_intersect">ppm_module_mesh_block_le_data_mesh, ppm_module tio_checktitle="Module ppm_module_chptio_checkt>m_module_chptio_checktle="Module ppm_module_write">ppm_module"> (IN) integer integer (IN) integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integeroptional description ppm_62m_moduypedef, optional descriy> .="m>.="m>.h30" summary="Note_moduledefr> optional descriy> <]" srm_map c_ifaca_powspan="2" am_map clborder="I .="m>.="m>.h30" summary="Note_moduledefr> optional descriy> .="m>.h30" summary="Note_modul valign="top"><]" srm_map c_ifaca_powspan="2" am_map cl>.oduI descriy> <]" srm_map c_ents of the receim_map c_dfer conta> <]" srm_map c_ents of the receim_map c_sfer conta> <]" srm_map c_ents of the receim_map c_df>. xp>Ng" />"lef>
Note nouf "utins="Ste.png" / /a>,ft" valign="top" intent optional description <]" srm_map c_rowspan="2" am_map c_dor">p tioidfer conta tioidf> tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid ID mg tinettiologyid valign="top"> <]" srm_map c_rowspan="2" am_map c_dor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) atargn="leign="top"> <]" srm_map c_rowspan="2" am_map c_dor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid <]" srm_map c_rowspan="2" am_map c_dor">py>
topoid
integer, , (IN)
Topology ID of source
| p tioidf>modu tioididh5> integer, , (IN) ID mg tinettiologyid vaign="center" valign="top"]" srm_map c_rowspan="2" am_map c_dor">pxnl_moduxnid/a>, |
P_map_pas" ionr>atargn="lign="center" valign="top"]" srm_map c_rowspan="2" am_map c_dor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pars(/notineloceftre.png" /)id vaign="center" valign="top"]" srm_map c_rowspan="2" am_map c_dor">pi>ppm_module_error, ppm_63m_moduypedef, ppm_module_alloc, ppm_module_check_id, m_module_chpm_mdefk_id, ppm_module_mesh_block_check_idfer conta_intersect" title=check_idf>ect" title=check_id_block_intersect">ppm_module_mesh_block_le_data_mesh, ppm_module/trl_almmign_mesh, ass="link" /trl_almmigntle="Module ppm_module_write">ppm_modulewriuffer conta, ass="link" wriuftle="Module ppm_module_write">ppm_module"> integer (IN) integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integerxp>Ng" />"lef>
N/th> intent optional description <]" srm_map c_rowspan="2" am_map c_sor">p tioidfer conta tioidf> tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid ID mg tinettiologyid valign="top"> <]" srm_map c_rowspan="2" am_map c_sor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) atargn="leign="top"> <]" srm_map c_rowspan="2" am_map c_sor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid <]" srm_map c_rowspan="2" am_map c_sor">py>
topoid
integer, , (IN)
Topology ID of source
| p tioidf>modu tioididh5> integer, , (IN) ID mg tinettiologyid vaign="center" valign="top"]" srm_map c_rowspan="2" am_map c_sor">pxnl_moduxnid/a>, |
P_map_pas" ionr>atargn="lign="center" valign="top"]" srm_map c_rowspan="2" am_map c_sor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pars(/notineloceftre.png" /)id vaign="center" valign="top"]" srm_map c_rowspan="2" am_map c_sor">pi>ppm_module_error, ppm_64m_moduypedef, ppm_module_alloc, ppm_module_check_id, m_module_chpm_mdefk_id, ppm_module_mesh_block_check_idfer conta_intersect" title=check_idf>ect" title=check_id_block_intersect">ppm_module_mesh_block_le_data_mesh, ppm_module/trl_almmign_mesh, ass="link" /trl_almmigntle="Module ppm_module_write">ppm_modulewriuffer conta, ass="link" wriuftle="Module ppm_module_write">ppm_module"> (IN) integer integer (IN)optional description ppm_65m_moduypedef, optional descriy> .="m>.="m>.h30" summary="Note_moduledefr> optional descriy> <]" sr/trl_ifaca_powspan="2" acanceclborder="I <]" sr/trl_ifaca_powspan="2" aeqdistriblborder="I <]" sr/trl_ifaca_powspan="2" agetp <]" sr/trl_ifaca_powspan="2" aloadlborder="I <]" sr/trl_ifaca_powspan="2" ar <]" sr/trl_ifaca_powspan="2" atoorelborder="I .="m>.="m>.h30" summary="Note_moduledefr> optional descriy> .="margin-leorderptop >.="m>.="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" acancecl>.oduI descriy> <]" sr/trl_ents of the receicanceclborder="> .="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" aeqdistribla.oduI descriy> <]" sr/trl_ents of the receieqdistrib_dfer conta> <]" sr/trl_ents of the receieqdistrib_sfer conta> .="margin-leorderptop >.="m>.="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" agetp descriy> <]" sr/trl_ents of the receigetp <]" sr/trl_ents of the receigetp .="margin-leorderptop >.="m>.="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" aloadl>.oduI descriy> <]" sr/trl_ents of the receiloadlborder="> .="margin-leorderptop >.="m>.="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" ar descriy> <]" sr/trl_ents of the receir <]" sr/trl_ents of the receir .="margin-leorderptop >.="m>.="m>.h30" summary="Note_modul valign="top"><]" sr/trl_ifaca_powspan="2" atoorel>.oduI descriy> <]" sr/trl_ents of the receitoorelborder="> <]" sr/trl_ents of the receicancecl>. r" valign="top" width="25"> Note nouf yd. T>(ir de.meshate="Sunlyehotpenthi
t="[fin.miz hanywayft" valign="top" intent optional description <]" sr/trl_t="[Note]" srcancecor">py>
topoid
integer, , (IN)
Topology ID of source
py>module_error, ppm_66m_moduypedef, ppm_module_alloc, ppm_module">
topoidinteger, , (IN) Topology ID of source pxnl>moduxnid/a>, | |
" wiposite="sSuoutines_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" sreqdistrib_dor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" sreqdistrib_dor">py>module_error, ppm_67m_moduypedef, ppm_module_alloc, ppm_module_mesh_block__id" title="Module ppm_module_check_id">ppm_module_check_id, ppm_module"> integer integer integer (IN) Topology ID of source integer integer, , (IN) Topology ID of source integerr" valign="top" width="25"> Ng" />"lef>
Note nouf "utins="Ste.png" /
/a>,ft" valign="top" nouf g uougn="top" width="25"> intent optional description <]" sr/trl_t="span="2" aeqdistrib_sor">pxnlborder="xnl>xnid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) <]" sr/trl_t="span="2" aeqdistrib_sor">pn"2" ="Module n"2" =>n"2" id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid <]" sr/trl_t="span="2" aeqdistrib_sor">py>
topoid
integer, , (IN)
Topology ID of source
" wiposite="sSuoutines_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" sreqdistrib_sor">pn"2" =iv> integer, , (IN) " winumbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" sreqdistrib_sor">py>module_error, ppm_68m_moduypedef, ppm_module_alloc, ppm_module_mesh_block__id" title="Module ppm_module_check_id">ppm_module_check_id, ppm_module"> integer integer (IN) integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integerr" valign="top" width="25"> i
Note <"> " valign="top">warnip> "> intent optional description <]" sr/trl_t="span="2" agetp Ttiology IDgn="leign="top"> <]" sr/trl_t="span="2" agetp einottiologyid valign="top"> <]" sr/trl_t="span="2" agetp Lenggn=efplistd:class="caut"top"> <]" sr/trl_t="span="2" agetp atargn="llign="top"> <]" sr/trl_t="span="2" agetp <]" sr/trl_t="span="2" agetp
topoid
integer, , (IN)
Topology ID of source
integer, , (IN)
Ttiology IDgn="lign="center" valign="top"]" sr/trl_t="[Note]" srgetp integert.png",> Listmefp integer, , (IN) Lenggn=efplistd:class=ign="center" valign="top"]" sr/trl_t="[Note]" srgetp P_map_pas" ionr>atargn="lign="center" valign="top"]" sr/trl_t="span="2" agetp integer, , (IN) Numbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" srgetp integer (IN) integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer, , (IN) Ttiology IDgn="lign="center" valign="top"]" sr/trl_t="[Note]" srgetp integert.png",> Listmefp integer, , (IN) Lenggn=efplistd:class=ign="center" valign="top"]" sr/trl_t="[Note]" srgetp P_map_pas" ionr>atargn="lign="center" valign="top"]" sr/trl_t="span="2" agetp integer, , (IN) Numbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" srgetp integer (IN) integer, , (IN) Topology ID of source integer integer (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source P_map_pas" ionr>atargn="lign="center" valign="top"]" sr/trl_t="span="2" ar integer, , (IN) " wil(IN integer, , (IN) Numbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer, , (IN) Pe.png" /eto sendstogn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer, , (IN) Pe.png" /eto receive fromgn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer integer (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source P_map_pas" ionr>atargn="lign="center" valign="top"]" sr/trl_t="span="2" ar integer, , (IN) " wil(IN integer, , (IN) Numbnamefpm_map_pargn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer, , (IN) Pe.png" /eto sendstogn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer, , (IN) Pe.png" /eto receive fromgn="lign="center" valign="top"]" sr/trl_t="[Note]" srr integer (IN) integer, , (IN) Topology ID of source (IN) (IN) integer integer (IN) Topology ID of source Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integert.png",> New size uoumeshtdefr>itopoi.png"r, , ign="center" valign="teshe_mesh_rowspeshe_mesh_equior">piop/t>modulop/idh5> integer, , (IN) Amesh ac" va. One uo:r, , > (IN) integer integer integer (IN) integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source Topology ID of source Topology ID of source Topology ID of source integer Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source Topology ID of source integer integer integer, , (IN) Source tiology t: ntifiert" vaign="center" valign="teshebeshk>i="lesec"_t="[Neshebeshk>i="lesec"or">ptop tioid<>id="top tioididh5> integer, , (IN) "/>get tiology t: ntifiert" vaign="center" valign="teshebeshk>i="lesec"_t="[Neshebeshk>i="lesec"or">pfrompNeshid<>id="frompNeshididh5> integer, , (IN) Source Neshst: ntifiert" vaign="center" valign="teshebeshk>i="lesec"_t="[Neshebeshk>i="lesec"or">ptopNeshid<>id="topNeshididh5> integer, , (IN) "/>get Neshst: ntifiert" vaign="center" valign="teshebeshk>i="lesec"_t="[Neshebeshk>i="lesec"or">pi integer, , (IN) Source integer, , (IN) Destinatopoi integert.png",> Shift offset eft tinesource integert.png",> Size uoutineghost layle inonumbnas uougrid ioiten ino.messpace
tle="topos (1…t="[tle). e integer, , (INlink" href=Numbnamefpmesh beshks inotinslistssso fart" vaign="center" valign="teshebeshk>i="lesec"_t="[Neshebeshk>i="lesec"or">pi integert.png",> integert.png",> integert.png",> integert.png",> integert.png",> Use (IN) integer gn="top" width="25"> integer (IN) integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source Topology ID of source integer Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer, , (IN) "tiology ID eft which to creatnemesht" vaign="center" valign="teshedefr><_t="[Neshedefr> integer, , (INlink" href=Mesh ID uoutinenewemesh. Ifo.LE. 0 poiinput,
tiner integert.png",> Numbnamefpmesh POINTS in each /le="topo. > integert.png",> integert.png",> (IN) integer gn="top" width="25"> integer (IN) integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (IN) Topology ID of source integer, , (IN) Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer, , (IN) "tiology ID eft which meshshas been creatnd,t" vaign="center" valign="teshederiv<_t="[Neshederiv integer, , (IN) Mesh id uoutine emplateemesh. IttwimesNOTsbn ov25writ" vft" vaign="center" valign="teshederiv<_t="[Neshederiv integer, , (INlink" href=Out NeshsID. Ifo⇐ 0 poiinput,utin
r integer, , (IN) Ac" va. One uo:r, , > integert.png",> Factor by which to refr>e/" arsenutinemesh inoeach /lrec" vaf
Fors" arsening insnumbnamefpmesh ioiten unotinsoldemesh must
bn divisi/td>byoti/thfactor inoev25y /lrec" va.t" va/gn="center" valign="teshederiv<_t="[Neshederiv (IN) integer integer, , (IN) Topology ID of source (IN) integer gn="top" width="25"> integer (IN) Topology ID of source integer Topology ID of source integer Topology ID of source integer Topology ID of source integer Topology ID of source integer integer, , (IN) Topology ID of source integer integer, , (INlink" href=Mesh ID uoutinenewemesh. Ifo.LE. 0 poiinput,
tmm_msid ylee remoe remoe remo> integer, , (INlink" href=Mesh ID uoutinenewemesh. Ifo.LE. 0 poiinput,
ton" style="margi Topology ID of source Topology ID of s>fpmesh ioiten inoeach /lrec" va poieach Topology I>fpmeclass="cauoiten valign="to" va poieach To/p> Topol/p> To/p>/p> Topology ID ofoi. given id="Nes/p> Ac" va. One uo:r, , > Topology ID o="link" href="#ppm_module_alloc" title="Module ppm_module_alloc">ppm_module_alloc (IN) integer (IN) Topology ID of source integer integer Topology ID of source integer integer Topology ID of source integer integer, , (IN)Topology ID of source integer integer, , (INlink" href=Mesh ID uoutinenewemesh. Ifo.LE. 0 poiinput,
tmm_msid ylee remoe remoe remo> integer, , (INlink" href=Mesh ID uoutinenewemesh. Ifo.LE. 0 poiinput,
ton" style="margi Topology ID of source Topologs ID of s>fpmesh ioiten inoeach /lrec" va poieach Topology I>fpmeclass="cauoiten valign="to" va poieach To/p> Topol/p> To/p>/p> Topologs ID ofoi. given id="Nes/p> Ac" va. One uo:r, , > Topologs ID o="link" href="#ppm_module_alloc" title="Module ppm_module_alloc">ppm_module_alloc (IN) integer esheon_rowsab" v
a gen"litedtd alie="m41er"> pnmtable>nmi7="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) Topology ID of source integer int align="> int, , (IN) Topology ID of source integer, , (INlink" href=r"top">optional integer int"ppm_ , (IN) Ac" va. One uo:r, , > Ac" va. One uom__Nesh=odu>no emealign⇐ 0ie="input,sheo
ite"_rowspeshnumbna"m4newhd ali (IN) (IN) integerr" valign="top" width="25"> i
N/th> intent optional description <]" sr/trl_t="span="2" agetp Ttiology IDgn="leign="top"> <]" sr/trl_t="span="2" agetp einottiologyid valign="top"> <]" sr/trl_t="span="2" agetp Lenggn=efplistd:class="caut"top"> <]" sr/trl_t="span="2" agetp atargn="llign="top"> <]" sr/trl_t="span="2" agetp <]" sr/trl_t="span="2" agetp topoid
p tioidf>modu tioididh5> r" valign="top" width="25"> Note intent optional description <]" sr/trl_t="[Note]" srloador">py> topoid
py>, ppm_71m_moduypedef, ppm_module_alloc, ppm_module_check_id, ppm_module_mesh_block_le_data_mesh, ppm_module/a>,_state="Module ppm_module_alloc">ppm__state=odule_alloc,_statetle="Module ppm_module_write">ppm_module"> r" valign="top" width="25"> lda>Ng" />" />get,isource>"lef>
NotPrrptr="otinesendsand receive listssand p>(e"[Notes eft send ,in;otd the r nouf T wifirst m_maSuoutine"[Notes" srar>"utins="Ste.png" /e/a>,.
Inoti/thcasns.mesm_map_parswimesbnesendsto " />getft" valign="top" intent optional description <]" sr/trl_t="span="2" ar atargn="llign="top"> <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar topoid
pxnl_moduxnid/a>, pn"2" =iv> r" valign="top" width="25"> lda>Ng" />" />get,isource>"lef>
NotPrrptr="otinesendsand receive listssand p>(e"[Notes eft send ,in;otd the r nouf T wifirst m_maSuoutine"[Notes" srar>"utins="Ste.png" /e/a>,.
Inoti/thcasns.mesm_map_parswimesbnesendsto " />getft" valign="top" intent optional description <]" sr/trl_t="span="2" ar atargn="llign="top"> <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar <]" sr/trl_t="span="2" ar topoid
pxnl_moduxnid/a>, pn"2" =iv> r" valign="top" width="25"> Note intent optional description <]" sr/trl_t="[Note]" srtooreor">py> topoid
py>, ppm_74m_moduypedef, ppm_module_alloc, ppm_module_check_id, ppm_module_mesh_block_le_data_mesh, ppm_module/a>,_state="Module ppm_module_alloc">ppm__state=odule_alloc,_statetle="Module ppm_module_write">ppm_module"> description ppm_75m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> optional descriy> optional description ppm_76m_moduypedef, peshederive=>ule_alloc">peshederivetle="Module ppm_module_write">ppm_modulepeshetooref"Module ppm_module_alloc">peshetooref>ule_alloc">peshetooretle="Module ppm_module_write">ppm_modulepesheon> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> optional descriy> descriy> r" valign="top" width="25"> NotDoe"otine(re)_meshatopoiuouapng"s uoutm_mapn="top" width="25"> intent optional description pequiomeshin; margiequiomeshi>equiomesh pldalborder="ldal>ldaid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) itopoi.png"r, , (IN)<"top"> piop/table>iop/id="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid pi> topoid
pequiomeshi_moduequiomesh
rowspara"e_mesh_fit_preserve
ppm_77m_moduypedef, ppm_module_alloc, ppm_module_check_id, description ppm_78m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> i="lesec"f>ule_aeshebeshk>i="lesec"tle=ppm_module_map_field_global_ppm_map_field_t" valign="top" optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_modul valign="topeshebeshk>i="lesec"_ifaca_h="80eshebeshk>i="lesec"f>moduI="lefacaeh="80eshebeshk>i="lesec"tl ylee remoe remoe remopp> descriy> i="lesec"f"Module > i="lesec"f>. i="lesec"tlb>r" valign="top" width="25"> Note <"> " valign="top">warnip> "> (rotinsfrompNeshsand p>(etopNeshsare
" mpati/td>(i.e. have tinesk" hNm). e intent optional description pfromp tioidfromp tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid ptop tioidtop tioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid get tiology t: ntifiert" valign="top"> pfrompNeshidfrompNeshidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid ptopNeshidtopNeshidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid get Neshst: ntifiert" valign="top"> pl ,iwimesbnesent)einoglobal numbnaip>"> valign="top"> pj "> valign="top"> poffsettable>offsetid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) valign="top"> pghostsizetable>ghostsizeid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) pnsend> pl pl pl pl ploffsettable>ioffsetid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) pl> topoid
plsymmtable>lsymmid="ppm_module_map_field_global_ppm_map_field_logic.mt.png"r, , (IN) h align=strop><">strop>>X>>t" valign=op"> pfromp tioid<>id="fromp tioididh5> ppm_79m_moduypedef, ppm_module_alloc, ppm_module_check_id, description ppm_80m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> <="Module I="lefacaeh="80eshedefr><=>ule_aeshedefr> optional descriy> <_ifaca_h="80eshedefr><=>moduI="lefacaeh="80eshedefr> descriy> Note .intent optional description topoid
ppm_81m_moduypedef, ppm_module_alloc, ppm_module_check_id, description ppm_82m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> ="noNeshederiv optional descriy> descriy> Note .intent optional description ptoioidtoioidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid "tiology ID eft which meshshas been creatnd,t" valign="top"> ptemplatepNeshidtemplatepNeshidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Mesh id uoutine emplateemesh. IttwimesNOTsbn ov25writ" vft" valign="top"> pnewpNeshid="Module newpNeshid=>newpNeshidid="ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid pac"f"Module ac"f>ac"tle=ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Ac" va. One uo:r, , (IN)<"top"> pfactorfactorid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) e/" arsenutinemesh inoeach /lrec" vaft" valign="top"> pl> topoid
ptoioid<>id="toioididh5>
t="[para"[Neshe" arsen
m/uln="2" align="center" valign="teshederiv<_t="[Neshederiv ppm_83m_moduypedef, ppm_module_alloc, ppm_module_check_id, description ppm_84m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> optional descriy> topoid
pl>, ppm_85m_moduypedef, ppm_module_alloc, ppm_module_check_id, ppm_module_mesh_block_le_data_mesh, ppm_module/a>,_Nesh="Module ppm_module_alloc">ppm__Nesh=odule_alloc,_Neshtle="Module ppm_module_write">ppm_moduleNesheule_mesh_block_intersect" title=Nesheule_me>h="80%"> description ppm_86m_moduypedef, h align=emphasisf>.em>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cp>h_ty the
sk" hmesh. Mesharsarne/efr> optional descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> h="80esheonrite"tle=ppm_module_map_field_global_ppm_map_field_t" valign="top" optional descriy> mpart of theorderpagef>.par>.par>.h30" summary="Note_modul valign="topesheonrite"_ifaca_h="80esheonrite" >moduI="lefacaeh="80esheonrite"tl ylee remoe remoe remopp> descriy> h="80esheonrite"_"tle=ppm_module_map_field_global_ppm_map_field_e h="80esheonrite"_did="ppm_module_map_field_global_ppm_map_field_e . <,n/a>,>"lef>
Note .intent optional description pnmtable>nmid="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) pmin_physNin_physid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) pmax_physNax_physid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) pminriteNin_iteid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) Min. extenttuoutine pmax_iteNax_iteid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) Max. extenttuoutine pnite" border="nite" >nite"tle=ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Toteftotpcells) gn=emphasisf>.em>no tm_msidem>>t" valign="top" .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> ppm__Nesh=odule_alloc,_Neshtle="Module ppm_module_write">ppm_moduleNes7eule_mesh_block_intersect" title=Nesheule_me>h="80%"> .par>.par>.h30v .intent optional descristion pnmtable>nmi6="ppm_module_map_field_global_ppm_map_field_globalst.png"r, , (IN) pmin_physNin_physid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) pmax_physNax_physid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) pminriteNin_iteid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) Topology ID of sourceMin. extenttuoutine pmax_iteNax_iteid="ppm_module_map_field_global_ppm_map_field_reeft.png"r, , (IN) Max. extenttuoutine pnite" border="nite" >nite"tle=ppm_module_map_field_global_ppm_map_field_globalstored_arg_topoid">topoid Toteftotpcells) gn=emphasisf>.em>no tm_msidem>>t" valign="top" .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> ppm__Nesh=odule_alloc,_Neshtle="Module ppm_module_write">ppm_moduleNes8eule_mesh_block_intersect" title=Nesheule_me>h="80%"> .par>.par>.h30v ppm_86m_moduypedef, moduIem>has no _tysidem>>t" val remoe remo> nouf fields cp>h_tmary="Ndhmesh. Mesharsarne/efr> descriy> .part of theorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> n-lenouffer contaNouffetopoid" title="target_topoid">targeh="80esheonrite" border="I="lefacaeh="80esheonrite" >h="80esheonrite"tle=ppm_module_map_field_global_ppm_map_field_t" valign="top" moduItheorderpagef>.par>.par>.h30" summary="Note_moduledefr> optional descriy> mpart of theorderpagef>.par>.par>.h30" summary="Note_modul valign="topesheonrite"_ifaca_h4"80esheonrite" >moduIS"lefacaeh="80esheonrite"tl ylee remoe remoe remopp> descriy> h="80esheonrite"_did="ppm_module_map_field_global_ppm_map_field_e pmin_physNin_physid="ppm_module_map_field_global_ppm_map_field_reeft.pnd> descriy> descriy> descriy> pmax_physNax_physid="ppm_module_map_field_global_ppm_map_fid> Godule /p> optional description ppm_86m_moduypedef, moduIem>has no _tysidem>>t" val remoe remo> nouf ,ilivr>g unotinsmeshar). Sev25"> fields cpk , ("Ndhmesh. Mesharsarne/efrk , (l optional descriy> n-lenouffer contaNouffetopoid" title="target_topoid">targeh="80esheonrite" border="I="lefacaeh="80esheonrite" >h="80esheonrite"tle=ppm_module_map_field_global_ppm_map_field_t" valign="top" moduItheorderpagef>.par>.par>.h30" summary="Note_moduledefr>