AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |
Back to Blog
Doxygen comment blocks1/31/2024 ![]() ![]() May be created automatically using either FORD or Doxygen.Ĭomments attached to program units, variables and derived types mayĭocumentation must precede the declaration of the unit, variable orĬomments to be documented must use the tag “!>” (This is default tag ![]() Integer, Intent ( In ) :: imcon, mxshak Real ( Kind = wp ), Intent ( InOut ) :: xxx ( 1 : mxatms ), yyy ( 1 : mxatms ), zzz ( 1 : mxatms ) Real ( Kind = wp ), Intent ( Out ) :: strcon ( 1 : 9 ) Real ( Kind = wp ), Intent ( Out ) :: vircon Logical :: safe Integer :: fail ( 1 : 2 ), i, j, k, icyc Real ( Kind = wp ) :: amti, amtj, dli, dlj, & gamma, gammi, gammj, tstep2 Comments ¶Ĭomments shall be indented to align with the codeĬomments shall be written in lower case except for proper nouns andĬomments shall explain what a code does and why, not how it does it.īy conforming to the following style useful developer documentation You prefer performance to aesthetical beauty. While overloading operators may be tempting, it is best avoided if When using a module with the Use statement, Only must also be Module names shall match their file names. Make public what is needed outside the module or type using theĭata which is used only in the defining module should be declaredĮach module should be in a separate file. specifications without the Parameter attribute)īy default everything in a module shall be made private, explicitly Paramter definitions (using the Parameter attribute) If ( integrator = VELOCITY_VERLET ) ThenĪny new feature shall be turnable on/off from CONTROL file.Īny new feature shall be documented in the manual and will citeĪll subroutines/functions shall be enclosed by a module. ![]() If ( integrator = 1 ) Then ! instead use Integer ( Kind = wi ), Parameter :: VELOCITY_VERLET = 1. Prefer positive testing in logical blocks. Use the mordern syntax for logical expressions, Where more than a word is used in a name use _ as separator (snake While Fortran is case insensitive, use for lower case letters for Routines or keywords from fortran standard. !> Tracking points for Verlet neighbour list Real ( Kind = wp ), Allocatable, Public :: xbg (:), ybg (:), zbg (:) !> Largest vdw cutoff, defines Verlet neighbour list radius Real ( Kind = wp ), Public :: cutoff !> Padding around cutoff Real ( Kind = wp ), Public :: padding !> Actual Verlet neighbour list cutoff (cutoff+padding) Real ( Kind = wp ), Public :: cutoff_extended !> Linked cell list Integer ( Kind = wi ), Allocatable, Public :: list (:,:) !> Maximum rank of linked cell list Integer ( Kind = wi ), Public :: max_list !> Maximum number of cells per domain Integer ( Kind = wi ), Public :: max_cellĪvoid naming program units, variables, constants using intrinsincs !> Unconditional update flag Logical, Public :: unconditional_update =. ! Verlet neighbour list data !> Update cells flag Logical, Public :: update =. ![]()
0 Comments
Read More
Leave a Reply. |