doc/src/fix_print.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 fix print command :h3
  10
  11 [Syntax:]
  12
  13 fix ID group-ID print N string keyword value ... :pre
  14
  15 ID, group-ID are documented in "fix"_fix.html command :ulb,l
  16 print = style name of this fix command :l
  17 N = print every N steps :l
  18 string = text string to print with optional variable names :l
  19 zero or more keyword/value pairs may be appended :l
  20 keyword = {file} or {append} or {screen} or {title} :l
  21   {file} value = filename
  22   {append} value = filename
  23   {screen} value = {yes} or {no}
  24   {title} value = string
  25     string =  text to print as 1st line of output file :pre
  26 :ule
  27
  28 [Examples:]
  29
  30 fix extra all print 100 "Coords of marker atom = $x $y $z"
  31 fix extra all print 100 "Coords of marker atom = $x $y $z" file coord.txt :pre
  32
  33 [Description:]
  34
  35 Print a text string every N steps during a simulation run.  This can
  36 be used for diagnostic purposes or as a debugging tool to monitor some
  37 quantity during a run.  The text string must be a single argument, so
  38 it should be enclosed in double quotes if it is more than one word.
  39 If it contains variables it must be enclosed in double quotes to
  40 insure they are not evaluated when the input script line is read, but
  41 will instead be evaluated each time the string is printed.
  42
  43 The specified group-ID is ignored by this fix.
  44
  45 See the "variable"_variable.html command for a description of {equal}
  46 style variables which are the most useful ones to use with the fix
  47 print command, since they are evaluated afresh each timestep that the
  48 fix print line is output.  Equal-style variables calculate formulas
  49 involving mathematical operations, atom properties, group properties,
  50 thermodynamic properties, global values calculated by a
  51 "compute"_compute.html or "fix"_fix.html, or references to other
  52 "variables"_variable.html.
  53
  54 If the {file} or {append} keyword is used, a filename is specified to
  55 which the output generated by this fix will be written.  If {file} is
  56 used, then the filename is overwritten if it already exists.  If
  57 {append} is used, then the filename is appended to if it already
  58 exists, or created if it does not exist.
  59
  60 If the {screen} keyword is used, output by this fix to the screen and
  61 logfile can be turned on or off as desired.
  62
  63 The {title} keyword allow specification of the string that will be
  64 printed as the first line of the output file, assuming the {file}
  65 keyword was used.  By default, the title line is as follows:
  66
  67 # Fix print output for fix ID :pre
  68
  69 where ID is replaced with the fix-ID.
  70
  71 [Restart, fix_modify, output, run start/stop, minimize info:]
  72
  73 No information about this fix is written to "binary restart
  74 files"_restart.html.  None of the "fix_modify"_fix_modify.html options
  75 are relevant to this fix.  No global or per-atom quantities are stored
  76 by this fix for access by various "output
  77 commands"_Section_howto.html#howto_15.  No parameter of this fix can
  78 be used with the {start/stop} keywords of the "run"_run.html command.
  79 This fix is not invoked during "energy minimization"_minimize.html.
  80
  81 [Restrictions:] none
  82
  83 [Related commands:]
  84
  85 "variable"_variable.html, "print"_print.html
  86
  87 [Default:]
  88
  89 The option defaults are no file output, screen = yes, and title string
  90 as described above.