next up previous contents index
Next: 5.4.4 Comment lines Up: 5.4 Comments Previous: 5.4.2 Header of modules   Contents   Index

5.4.3 Header of subroutines and functions

!-----********************-----------------------------------
subroutine rhd_bound_3DTransmit(model, action, dtime)
!--------------------------------------------------
! NAME:
!   rhd_bound_3DTransmit ('rhd_boundary_conditions_3_Dimensions_Transmit')
!
! PURPOSE:
!   Adjust density values in top cells to contribute to the open upper boundary condition.
!   
! CATEGORY:
!   Hydrodynamics
!
! CALLING SEQUENCE:
!   call rhd_bound_3DTransmit(model, action, dtime)
!
! INPUT:
!   action:       ('action') derived type with collection of control parameters
!   dtime:        ('delta_time') real, time step to be used
!
! INPUT/OUTPUT:
!   model:        ('model') derived type, model data: rho, ei, v, x, time, ...
!
! OUTPUT:
!
! LOCAL VARIABLES:
!
! ROUTINES:
!   eosinter:              Solve EOS by bicubic interpolation: rho, e -> P, dPdrho, dPde, T, dTde, s
!   MPI_AllReduce:         Perform a reduction and send result to all processes
!   MPI_Comm_Split:        Split a communicator
!
! MODULES:
!   rhd_gl_module:         Global type definitions and parameters for RHD
!   rhd_action_module:     Routines to handle the control structure 'action'
!   rhd_box_module:        Box-handling routines
!   rhd_prop_module:       Properties of quantities in 'box' structure
!   gasinter_module:       Routines for interpolating GAS or EOS quantities
!   MPI:                   Standard MPI routines and definitions
!
! SIDE EFFECTS:
!
! RESTRICTIONS:
!   Works only for upper (bound_r3) boundary, not for all 6 sides.
!
! PROCEDURE:
!
! EXAMPLE:
!   call rhd_bound_3DTransmit(model, action, 0.5)
!
! MODIFICATION HISTORY:
!   2010-04-05 (B.F.) First Version
!   2010-04-28 (B.F.) bound_transmitting3
!   2012-11-08 (B.F.) Minor modifications
!   2012-11-09 (B.F.) New parameters in call, MPI version
!   2012-11-12 (B.F.) MPI parameters put into prop structure
!--------------------------------------------------

The description of modules and routines should start at column 27, unless the name is too long. With the script listroutines these entries can be generated (almost) automatically.

The description of a variable should start at column 18, unless the name is too long. It should start with a long variable name (delta_time for dtime) that explains the short name, followed by a short comment about the purpose of the variable.


next up previous contents index
Next: 5.4.4 Comment lines Up: 5.4 Comments Previous: 5.4.2 Header of modules   Contents   Index