Output

Definition of output options.

Fields

• field_data: Vector of FieldData, default = []

  Options for field data output as contour plots on the model geometry.

• kpi_data: Vector of KPIData, default = []

  Options for key performance indicators (KPIs) output as values at each time step.

• kpi_time_step: Float, default = 0.0

  Rate at which to save KPI data.

  Save KPI values when time advances at least this increment since the last save. If this value is not given, the next one is used.

• kpi_no_of_snapshots: Integer, default = 0

  Number of KPI outputs throughout the simulation to save, used if kpi_time_step is not given.

• kpi_rate: Integer, default = 0

  Time step rate for saving KPI data.

  If neither kpi_time_step nor kpi_no_of_snapshots nor kpi_rate are given, default is kpi_rate=1 (i.e. save values at every timestep).

• field_rate: Integer, default = 0

  Same as above but for the field output. In this case, the default is to save just the final state.

• field_time_step: Float, default = 0.0

• field_no_of_snapshots: Integer, default = 0

• field_output_type: FieldOutputType, default = VtuTensor

  Options for outputting field data.

• kpi_output_type: KPIOutputType, default = Json

  Options for outputting KPI data.

• field_compound_method: FieldCompoundMethod, default = FromNodes

  Option for computing compound fields out of base fields at nodes.

• checkpoint_data: Vector of FieldData, default = []

  Options to save snapshots of field data at checkpoints during the simulation.

  The checkpoint data is stored in an external .hdf5 format that can be read in to initialize fields in following simulations.

• checkpoint_append: Bool, default = false

  Flag to indicate whether data at each checkpoint is appended to the checkpoint file or overwrites the checkpoint file.

  • true: Data is appended to the checkpoint file to create a single file with a time series of data snapshots.

  • false: The file is overwritten with new data at each checkpoint.

• checkpoint_rate: Integer, default = 0

  The time step rate at which field data snapshots are written to the checkpoint file.

  For example, a rate of 5 indicates writing new data every 5 timesteps.

• checkpoint_mesh: Bool, default = false

  Flag to indicate whether the mesh connectivity and original coordinates should be written to the checkpoint file. This is done once per file.

  • true: The mesh is written to the checkpoint file.

  • false: The mesh is not written to the checkpoint file (i.e. only field data is written).

See also ReflexInput.