diag_style command

Syntax:

diag_style style keyword value keyword value ... 

• style = cluster or diffusion or energy or eprof or propensity
• zero or more keyword/value pairs may be appended

  keyword = stats or delay or delt or logfreq
    stats values = yes or no
      yes/no = provide output to stats line
    delay values = tdelay
      tdelay = delay evaluating diagnostic until at least this time
    delt values = delta
      delta = time increment between evaluations of the diagnostic (seconds)
    logfreq values = N factor
      N = number of repetitions per interval
      factor = scale factor between interval 
  

• see doc pages for individual diagnostic commands for additional keywords - diagnostic-specific keywords must come after any other standard keywords

Examples:

diag_style cluster stats no delt 1.0 
diag_style eprof stats no delt 0.01 logfreq 7 10.0
diag_style energy 

Description:

This command invokes a diagnostic calculation. Currently, diagnostics can only be defined for on-lattice applications. See the app_style command for an overview of such applications.

The diagnostics currently available are:

• cluster = grain size statistics for general lattices
• diffusion = statistics on diffusion events
• energy = energy of entire system for general lattices
• eprof = 1d energy profile
• propensity = propensity of entire system for general lattices

Diagnostics may provide one or more values that are appended to other statistical output and printed to the screen and log file via the stats command. This is stats output. In addition, the diagnostic may write more extensive output to its own files if requested by diagnostic-specific keywords.

The stats keyword controls whether or not the diagnostic appends values to the statistical output. If stats is set to yes, then none of the other keywords can be used, since the frequency of the stats output will determine when the diagnostic is called.

If stats is set to no, then the other keywords can be used, since presumably the diagnostic will create its own output files. The delt keyword specificies Delta = the interval of time between each diagnostic calculation. Similarly, the logfreq keyword will cause the diagnostic to run at varying intervals during the course of a simulation. There will be N outputs per interval where the size of each interval scales up by factor each time. Delta is the time between outputs in the first (smallest) interval.

For example, this command

diag_style energy stats no delt 0.1 logfreq 7 10.0 

will perform its computation at these times:

t = 0, 0.1, 0.2, ..., 0.7, 1, 2, ...., 7, 10, 20, .... 

This command

diag_style energy stats no delt 0.1 logfreq 1 2.0 

will perform its computation at these times:

t = 0, 0.1, 0.2, 0.4, 0.8, 1.6, ... 

The delay keyword specifies the shortest time at which the diagnostic can be evaluated. This is useful if it is inconvenient to evaluate the diagnostic at time t=0.

Restrictions: none

Related commands:

stats

Default:

The stats setting is yes.