Output 
=================

note: some of this page overlaps with :ref:`Analyze the results`.

Arguments:

  * `scalar_operators` (json object) - Scalar Operators specified in :ref:`Operators`. The following sub-fields must be specified:

    * `file` (string) - Name of file to save, typically `"operators.dat"`.

  * `fields` (json object). The following sub-fields must be specified:

    * `species_densites` (json object) - Species densities for specified model (e.g. :math:`\rho_A`, :math:`\rho_B`).  The following sub-fields must be specified:
    
      * `file` (string) - Name of file to save, typically `"density.dat"`
      * `save_history` (bool) - should the entire history be saved, or only the final value?

    * `exchange_fields` (json object) - Exchange fields for spefified model (e.g. :math:`\mu_+`, :math:`\mu_-`). Can be useful for re-initializing a simulation. The following sub-fields must be specified:
    
      * `file` (string) - Name of file to save, typically `"fields.dat"`
      * `save_history` (bool) - should the entire history be saved, or only the final value?

  * `field_errors` (json object) - Field errors for spefified model (e.g. :math:`|\frac{\delta H}{\delta \mu_+}|_{L1}`, :math:`|\frac{\delta H}{\delta \mu_-}|_{L1}`). These are used to evaluate the convergence of SCFT. The following must be specified: 

      * `file` (string) - Name of file to save, typically `"errors.dat"`

One additional file that is output (which cannot be currently customized) is **STATUS**, the status of the current driver->run() command. Possible values are:

    * 0 - the simulation is still running
    * 1 - the forces in the simulation look fishy, may have diverged
    * 2 - the SCFT converged correctly to the specified tolerance
    * 3 - the run command reached the maximum number of specified steps

Example (python) :: 

  # currently python only supports the default file naming conventions
  fts.output_default()

Example (json) :: 

    "output": {
      "scalar_operators": {"file": "operators.dat"},
      "fields": {
        "species_densities": {
          "file": "density.dat", 
          "save_history": false
        },  
        "exchange_fields"  : { 
          "file": "fields.dat", 
          "save_history": false
        }   
      },  
      "field_errors" : {"file": "error.dat"} 
    },