begin_save{

Experimental handling of multiple save formats

The experimental begin_save{ environment makes it possible to differentiate between several saving environments with different parameter settings and possibly different saving formats in a straightforward way. A user can define up to 10 begin_save{ environments, each with its own set of SAVE parameters. With this, simulation results might be saved in different files in different ways. This environment uses the command SAVE_type, which allows the user to control the type of data that will be saved. Optionally, a begin_save{ environment may be named, and then can be selectively called from %EVENT_SaveResults%. A begin_save{ environment may contain the following features: Note:
  • If any of the aforementioned SAVE statements are declared outside of begin_save{, they are used as initializations for all begin_save{ environments. Statements inside the environments take precedence over outside statements and can overwrite them.
  • SAVE_MONITOR_ITEM and SAVE_BE_MONITOR_ITEM statements have to be declared outside of the environment.
  • When using begin_save{ environments, it is not possible to declare SAVE_format(i) with i>1 outside of them (which would be very confusing anyway).
  • The interaction with RestartPath with and without outer definitions of SAVE_path and SAVE_file has to be considered.
Example:
SAVE_first = 2 # initialization of begin_save{ SAVE_interval = 4 # initialization of begin_save{ begin_save{$save_ensight$} SAVE_choose_meth = 'TIME' SAVE_format = 'ENSIGHT6 BINARY N--T' SAVE_first = 0.005 # overwrites initialization values SAVE_interval = 0.001 # overwrites initialization values SAVE_type = 'Monitor' SAVE_type = 'Boundary' SAVE_file = 'testEnsight' SAVE_path = 'testEnsight' SAVE_CoordinateSystem = $MOVE_vconst$ SAVE_ITEM = ( %SAVE_scalar%, [Y%ind_ETA%], "eta" ) SAVE_ITEM = ( %SAVE_scalar%, [Y%ind_r%], "density" ) end_save begin_save{$save_hdf5$} SAVE_choose_meth = 'CONT' SAVE_format = 'ERFHDF5 N---' SAVE_first(2) = 15 SAVE_interval(2) = 10 SAVE_file = 'testERF' SAVE_path = 'testERF' end_save
Note: Not all SAVE formats are fully supported.
  • ENSIGHT6: Fully supported.
  • ERFHDF5: It is possible to combine a ERFHDF5 begin_save{ environment with save_environments that use different formats. Also not all options of SAVE_type are supported; one may only use 'PointCloud', 'TimeStep', 'None' or the default value. If 'Boundary' or 'Monitor' are chosen, SAVE_type is set to default.
  • ASCII: Several ASCII environments are possible, but the SAVE_type feature is not supported within this format, except for 'TimeStep'.
List of members:
SAVE_type Choose which type of data shall be saved