From d23ae965ac60dea9cb469e6f86afc7e02d5b537b Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Tue, 15 Sep 2020 08:52:29 -0600 Subject: [PATCH] more fortran doc work --- src/flib/piolib_mod.F90 | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/flib/piolib_mod.F90 b/src/flib/piolib_mod.F90 index c95b26aaaad..0f3d9a27069 100644 --- a/src/flib/piolib_mod.F90 +++ b/src/flib/piolib_mod.F90 @@ -65,6 +65,17 @@ !! Define a new decomposition of variables to distributed arrays in !! Fortran. !! +!! Use the generic function PIO_initdecomp() to call the underlying Fortran functions. +!! +!! - PIO_initdecomp_dof_i4() +!! - PIO_initdecomp_dof_i8() +!! - initdecomp_1dof_nf_i4() +!! - initdecomp_1dof_nf_i8() +!! - initdecomp_1dof_bin_i4() +!! - initdecomp_1dof_bin_i8() +!! - initdecomp_2dof_nf_i4() +!! - initdecomp_2dof_nf_i8() +!! !! @defgroup PIO_getnumiotasks Get Number IO Tasks !! Get the number of IO tasks in Fortran. !! @@ -74,6 +85,12 @@ !! @defgroup PIO_seterrorhandling Error Handling for Fortran !! Set the behavior if an error is encountered in Fortran. !! +!! Use the generic functions to call the underlying Fortran functions. +!! +!! Generic Function | Function(s) +!! ---------------- | ----------- +!! PIO_seterrorhandling() | seterrorhandlingfile(), seterrorhandlingiosystem(), seterrorhandlingiosysid() +!! !! @defgroup PIO_get_local_array_size Get Local Array Size !! Get the local size of the distributed array in a decomposition in !! Fortran.