Changes between Version 1 and Version 2 of WorkingGroups/TAM/ReferenceManual/CodingNorm
- Timestamp:
- 2009-08-19T15:47:31+02:00 (15 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WorkingGroups/TAM/ReferenceManual/CodingNorm
v1 v2 6 6 However additional rules hes to be followed: 7 7 8 * For a given direct module <tt>mod.F90</tt> (that contains the subroutine sub), a corresponding module <tt>mod_tam.F90</tt> has to be created and it should contain the tangent linear subroutine called <tt>sub_tan</tt>, the adjoint subroutine <tt>sub_adj</tt> and the corresponding testing routine <tt>sub_adj_tst</tt>.8 * For a given direct module '''mod.F90''' (that contains the subroutine sub), a corresponding module '''mod_tam.F90''' has to be created and it should contain the tangent linear subroutine called '''sub_tan''', the adjoint subroutine '''sub_adj''' and the corresponding testing routine '''sub_adj_tst'''. 9 9 10 * For a given active direct variable <tt>var</tt>, the corresponding tangent linear and adjoint variable should be named <tt>var_tl</tt> and <tt>var_ad</tt> respectively. The underscore is omitted for local active variable. To summarize, active variables <tt>un<\tt>, <tt>pun<\tt> and <tt>zun<\tt> will give <tt>un_tl<\tt>, <tt>pun_tl<\tt> and <tt>zuntl<\tt>in the tangent module10 * For a given active direct variable '''var''', the corresponding tangent linear and adjoint variable should be named '''var_tl''' and '''var_ad''' respectively. The underscore is omitted for local active variable. To summarize, active variables '''un''', '''pun''' and '''zun''' will give '''un_tl''', '''pun_tl''' and '''zuntl''' in the tangent module 11 11 12 12 * For historical reasons, some modules do not follow these rules, feel free to update them.