doc/src/jump.txt

   1 "LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c
   2
   3 :link(lws,http://lammps.sandia.gov)
   4 :link(ld,Manual.html)
   5 :link(lc,Section_commands.html#comm)
   6
   7 :line
   8
   9 jump command :h3
  10
  11 [Syntax:]
  12
  13 jump file label :pre
  14
  15 file = filename of new input script to switch to
  16 label = optional label within file to jump to :ul
  17
  18 [Examples:]
  19
  20 jump newfile
  21 jump in.run2 runloop
  22 jump SELF runloop :pre
  23
  24 [Description:]
  25
  26 This command closes the current input script file, opens the file with
  27 the specified name, and begins reading LAMMPS commands from that file.
  28 Unlike the "include"_include.html command, the original file is not
  29 returned to, although by using multiple jump commands it is possible
  30 to chain from file to file or back to the original file.
  31
  32 If the word "SELF" is used for the filename, then the current input
  33 script is re-opened and read again.
  34
  35 NOTE: The SELF option is not guaranteed to work when the current input
  36 script is being read through stdin (standard input), e.g.
  37
  38 lmp_g++ < in.script :pre
  39
  40 since the SELF option invokes the C-library rewind() call, which may
  41 not be supported for stdin on some systems or by some MPI
  42 implementations.  This can be worked around by using the "-in
  43 command-line argument"_Section_start.html#start_7, e.g.
  44
  45 lmp_g++ -in in.script :pre
  46
  47 or by using the "-var command-line
  48 argument"_Section_start.html#start_7 to pass the script name as a
  49 variable to the input script.  In the latter case, a
  50 "variable"_variable.html called "fname" could be used in place of
  51 SELF, e.g.
  52
  53 lmp_g++ -var fname in.script < in.script :pre
  54
  55 The 2nd argument to the jump command is optional.  If specified, it is
  56 treated as a label and the new file is scanned (without executing
  57 commands) until the label is found, and commands are executed from
  58 that point forward.  This can be used to loop over a portion of the
  59 input script, as in this example.  These commands perform 10 runs,
  60 each of 10000 steps, and create 10 dump files named file.1, file.2,
  61 etc.  The "next"_next.html command is used to exit the loop after 10
  62 iterations.  When the "a" variable has been incremented for the tenth
  63 time, it will cause the next jump command to be skipped.
  64
  65 variable a loop 10
  66 label loop
  67 dump 1 all atom 100 file.$a
  68 run 10000
  69 undump 1
  70 next a
  71 jump in.lj loop :pre
  72
  73 If the jump {file} argument is a variable, the jump command can be
  74 used to cause different processor partitions to run different input
  75 scripts.  In this example, LAMMPS is run on 40 processors, with 4
  76 partitions of 10 procs each.  An in.file containing the example
  77 variable and jump command will cause each partition to run a different
  78 simulation.
  79
  80 mpirun -np 40 lmp_ibm -partition 4x10 -in in.file :pre
  81
  82 variable f world script.1 script.2 script.3 script.4
  83 jump $f :pre
  84
  85 Here is an example of a loop which checks every 1000 steps if the
  86 system temperature has reached a certain value, and if so, breaks out
  87 of the loop to finish the run.  Note that any variable could be
  88 checked, so long as it is current on the timestep when the run
  89 completes.  As explained on the "variable"_variable.html doc page,
  90 this can be insured by includig the variable in thermodynamic output.
  91
  92 variable myTemp equal temp
  93 label loop
  94 variable a loop 1000
  95 run 1000
  96 if "$\{myTemp\} < 300.0" then "jump SELF break"
  97 next a
  98 jump SELF loop
  99 label break
 100 print "ALL DONE" :pre
 101
 102 Here is an example of a double loop which uses the if and
 103 "jump"_jump.html commands to break out of the inner loop when a
 104 condition is met, then continues iterating thru the outer loop.
 105
 106 label       loopa
 107 variable    a loop 5
 108   label     loopb
 109   variable  b loop 5
 110   print     "A,B = $a,$b"
 111   run       10000
 112   if        "$b > 2" then "jump SELF break"
 113   next      b
 114   jump      in.script loopb
 115 label       break
 116 variable    b delete
 117 next        a
 118 jump        SELF loopa :pre
 119
 120 [Restrictions:]
 121
 122 If you jump to a file and it does not contain the specified label,
 123 LAMMPS will come to the end of the file and exit.
 124
 125 [Related commands:]
 126
 127 "variable"_variable.html, "include"_include.html, "label"_label.html,
 128 "next"_next.html
 129
 130 [Default:] none