PROGRM OR MODULE name_of_thing

DART project logo

Jump to DART Documentation Main Index
version information for this file:
$Id: template.html 11403 2017-03-27 23:26:22Z hendric@ucar.edu $

NAMELIST / MODULES USED / INTERFACES / FILES / REFERENCES / ERRORS / PLANS / PRIVATE COMPONENTS / TERMS OF USE

Overview

Explain in general terms what this is.

[top]

NAMELIST

DART namelists are always read from file input.nml.

We adhere to the F90 standard of starting a namelist with an ampersand '&' and terminating with a slash '/' for all our namelist input. Character strings that contain a '/' must be enclosed in quotes to prevent them from prematurely terminating the namelist.

&NAMELIST_NML 
   name=value,
   name=value, 
   name=value
/

Any comments about the namelist as a whole.



Item Type Description
name type (often multi-line) description

[top]

MODULES USED

types_mod
utilities_mod
random_seq_mod
time_manager_mod
ensemble_manager_mod
[top]

PUBLIC INTERFACES

use this_module_name_mod, only : subr/function name
  name2
  name3

A note about documentation style. Optional arguments are enclosed in brackets [like this].


subroutine subroutine1(arg1, [, arg2])
real(r8),           intent(in) :: arg1
real(r8), optional, intent(in) :: arg2

describe what this subroutine does.

arg1 Describe arg1.
arg2 Describe optional arg2.


function function1(arg1)
logical,             :: function1
integer, intent(in)  :: arg1

Describe function.

function1 describe what this function returns
arg1 describe function argument


type bob_type
   private
   integer :: bob1
   integer :: bob2
end type bob_type

describe bob

Component Description
bob1 Describe bob1.
bob2 Describe bob2.

[top]

FILES

describe files used by code

[top]

REFERENCES

[top]

ERROR CODES and CONDITIONS

RoutineMessageComment
subroutine_name error message text what it means to the end user.

KNOWN BUGS

none at this time

[top]

FUTURE PLANS

none at this time

[top]

PRIVATE COMPONENTS

no discussion

[top]

Terms of Use

DART software - Copyright UCAR. This open source software is provided by UCAR, "as is", without charge, subject to all terms of use at http://www.image.ucar.edu/DAReS/DART/DART_download

Contact: DART core group
Revision: $Revision: 11403 $
Source: $URL: https://svn-dares-dart.cgd.ucar.edu/DART/releases/Manhattan/documentation/html/boilerplate/template.html $
Change Date: $Date: 2017-03-27 17:26:22 -0600 (Mon, 27 Mar 2017) $
Change history: try "svn log" or "svn diff"