Ignore:
Timestamp:
Dec 16, 2025, 4:39:24 PM (4 weeks ago)
Author:
jbclement
Message:

PEM:
Apply documentation template everywhere: standardized headers format with short description, separators between functions/subroutines, normalized code sections, aligned dependencies/arguments/variables declaration.
JBC

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/LMDZ.COMMON/libf/evolution/stop_pem.F90

    r3989 r3991  
    11MODULE stop_pem
     2!-----------------------------------------------------------------------
     3! NAME
     4!     stop_pem
     5!
     6! DESCRIPTION
     7!     Clean stopping utilities for PEM: close outputs and report reason.
     8!
     9! AUTHORS & DATE
     10!     JB Clement, 2025
     11!
     12! NOTES
     13!
     14!-----------------------------------------------------------------------
    215
     16! DECLARATION
     17! -----------
    318implicit none
    419
    5 !=======================================================================
    620contains
    7 !=======================================================================
     21!+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    822
    923!=======================================================================
    1024SUBROUTINE stop_clean(modname,message,ierr)
    11 ! Stop the simulation cleanly, closing files and printing various comments
    12 ! Inputs: modname = name of calling program
    13 !         message = stuff to print
    14 !         ierr    = severity of situation (= 0 normal)
     25!-----------------------------------------------------------------------
     26! NAME
     27!     stop_clean
     28!
     29! DESCRIPTION
     30!     Stop simulation cleanly, closing files and printing diagnostics.
     31!
     32! AUTHORS & DATE
     33!     JB Clement, 2025
     34!
     35! NOTES
     36!     Taken from Mars PCM.
     37!-----------------------------------------------------------------------
    1538
     39! DEPENDENCIES
     40! ------------
    1641#ifdef CPP_IOIPSL
    1742    use IOIPSL
    … …  
    2045    use ioipsl_getincom
    2146#endif
    22 
    2347#ifdef CPP_XIOS
    2448    use wxios ! For XIOS outputs
    2549#endif
    2650
     51! DECLARATION
     52! -----------
    2753implicit none
    2854
    2955#include "iniprint.h"
    3056
    31 ! Arguments
    32 !----------
    33 character(*), intent(in) :: modname
    34 integer,      intent(in) :: ierr
    35 character(*), intent(in) :: message
     57! ARGUMENTS
     58! ---------
     59character(*), intent(in) :: modname ! name of calling program
     60integer,      intent(in) :: ierr    ! severity of situation (= 0 normal)
     61character(*), intent(in) :: message ! stuff to print
    3662
    37 ! Code
    38 !-----
     63! CODE
     64! ----
    3965#ifdef CPP_XIOS
    4066    CALL wxios_close() ! Closing XIOS properly
Note: See TracChangeset for help on using the changeset viewer.