TAMLINK man page

---

       tamlink - TAMLINK Tangent linear and Adjoint Model Linker

SYNOPSIS

       tamlink [OPTIONS] <files>

DESCRIPTION

       TAMLINK  links  the  TAMC  generated  files and libraries.
       Depending on the given options the program  will  use  the
       derivative code for different purposes.

OPTIONS

       -help  Show usage and give short discription of options.

       -cost  Generate program to compute the cost function.

       -check Generate  program  to  check  gradients computed by
              adjoint code against finite  difference  approxima-
              tions.

       -checktl
              Generate  program  to  check  gradients computed by
              tangent  linear  code  against  finite   difference
              approximations.

       -compare
              Check  generated sensitivities using the definition
              of an adjoint operator <Ax,y> := <x,A^*y>.

       -tangent
              Generate program to run the tangent  linear  model.
              The  initial  perturbation must be initialized by a
              subroutine initper( n, per ).

       -adjoint
              Generate program to run the adjoint model, in  this
              case the result is the gradient vector.

       -time  Generate  program to give run times about function,
              adjoint, and tangent linear code.

       -opti  Generate program to minimize  the  given  function.
              The  adjoint  code computes the required gradients.
              Per default an simple conjugate gradient  algorithm
              is used.

       -function
              Generate program to compute the vector valued func-
              tion.

       -forward
              Generate program to compute the vector valued func-
              tion and its Jacobian in forward mode.
              Generate program to compute the vector valued func-
              tion and its Jacobian in reverse mode.

       -jacobian
              Generate  program  to  compute  full  Jacobian   in
              reverse and forward mode.

       -optlib
              Specify   the   optimization   library   interface:
              c_e04dge for NAGLIB  e04dge,  c_e04uce  for  NAGLIB
              e04uce,  c_umcgg   for  IMSL  umcgg,  c_m1qn3   for
              Gilbert's m1qn3, or c_lsopt  for Giering's,  lsopt.
              The default is c_cgopt, the provided conjugate gra-
              dient routine.


       -l<lib>
              This option will be passed to linker.  If you  have
              used -optlib you probably need to include the opti-
              mization library.

       -L<path>
              This option will be passed to linker.  If you  have
              used  -optlib you probably need to give the path of
              the optimization library.

       All other options will be passed to the Fortran  compiler.

FILES

       <file>.f       original function computing code
       <file>_ad.f    adjoint and modified code
       <file>_ftl.f   function and tangent linear code

LIBRARIES

       libtamc.a      TAMC library
       libcgopt.a     conjugate gradient optimization library
       libc_cgopt.a   cgopt  interface library
       libc_e04dge.a  e04dge interface library
       libc_e04uce.a  e04uce interface library
       libc_umcgg.a   umcgg  interface library
       libc_m1qn3.a   m1qn3  interface library
       libc_lsopt.a   lsopt  interface library

SEE ALSO

       tamc(1)

BUGS

AUTHOR

       Written by Ralf Giering <Ralf.Giering Fastopt.de>

---