Skip to content

Commit

Permalink
improving fortran docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardhartnett committed Sep 15, 2020
1 parent 3a77973 commit e97f239
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions src/flib/piolib_mod.F90
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,37 @@
!! Create a new IO System, designating numbers of I/O and computation
!! tasks in Fortran.
!!
!! Use the Fortran generic function PIO_init() to initialize the IO
!! System. The PIO_init() function will call init_intracom().
!!
!! This code from examples/f03/examplePio.F90 demonstrates how to
!! initialize the IO system for intracom mode.
!!
!! @code
!! call PIO_init(this%myRank, & ! MPI rank
!! MPI_COMM_WORLD, & ! MPI communicator
!! this%niotasks, & ! Number of iotasks (ntasks/stride)
!! this%numAggregator, & ! number of aggregators to use
!! this%stride, & ! stride
!! PIO_rearr_subset, & ! do not use any form of rearrangement
!! this%pioIoSystem, & ! iosystem
!! base=this%optBase) ! base (optional argument)
!! @endcode
!!
!! @defgroup PIO_finalize Free an IOSystem
!! Free an IO System, releasing all resources in Fortran.
!!
!! Use the Fortran generic function PIO_finalize() to finalize the IO
!! System, freeing all associated resources. The PIO_finalize()
!! function will call finalize().
!!
!! This code from examples/f03/examplePio.F90 demonstrates how to
!! finalize the IO system.
!!
!! @code
!! call PIO_finalize(this%pioIoSystem, ierr)
!! @endcode
!!
!! @defgroup PIO_initdecomp Define a Decomposition
!! Define a new decomposition of variables to distributed arrays in
!! Fortran.
Expand Down

0 comments on commit e97f239

Please sign in to comment.