CapetIOScalar

Erik Schnetter <schnetter@aei.mpg.de>

June 11, 2004

Abstract

1 Introduction

2 Utilities

These scripts may be useful handling CarpetIOASCII data:

The first script resides in CarpetIOASCII/src/utils and was meant primarily to convert 1D data, since the CarpetIOScalar data format is easily readable also by ygraph. Anyway, this script converts also scalar data files to the original 2-column ygraph format. Usage: Carpet2ygraphCat.pl Inputfile.

The second script can be used to merge CarpetIOScalar output written before and after recovery. It reads one or more files in CarpetIOScalar format and writes their contents to STDOUT, eliminating duplicate datasets (all but the last occurance are discarded), which may be created when a run died abruptly without checkpointing at the last output itaration and is recovered from a previous checkpoint. Usage: mergeCarpetIOScalar.pl list of files.
Example 1: mergeCarpetIOScalar.pl alp.norm1.asc > alp.norm1.asc.merged.
Example 2: mergeCarpetIOScalar.pl alp.norm1.asc.firstCHKPT alp.norm1.asc.secondCHKPT > alp.norm1.asc.merged.
This script was written by Thomas Radke.

References

3 Parameters




all_reductions_in_one_file
Scope: private BOOLEAN



Description: Write all requested reductions in one file instead of per reduction



Default: no






one_file_per_group
Scope: private BOOLEAN



Description: Write one file per group instead of per variable



Default: no






out_precision
Scope: private INT



Description: How many digits to output floating-point numbers with



Range Default: 15
0:*
Number of precision digits






outscalar_criterion
Scope: private KEYWORD



Description: Criterion to select scalar output intervals, overrides out_every



Range Default: iteration
never
Never output
iteration
Output every so many iterations
divisor
Output if iteration mod divisor == 0.
time
Output every that much coordinate time






outscalar_dir
Scope: private STRING



Description: Name of scalar output directory, overrides out_dir



Range Default: (none)
ˆ
$
Empty: use IO::out_dir
.+
Not empty: directory name






outscalar_dt
Scope: private REAL



Description: How often to do scalar output, overrides out_dt



Range Default: -2
(0:*
In intervals of that much coordinate time
As often as possible
-1
Disable output
-2
Default to IO::out_dt






outscalar_every
Scope: private INT



Description: How often to do scalar output, overrides IO::out_every



Range Default: -2
1:*
Output every so many time steps
-1:0
No output
-2
Default to IO::out_every






outscalar_reductions
Scope: private STRING



Description: List of reductions to output in scalar form



Range Default: count minimum maximum sum average norm1 norm2 norm_inf icount iaverage inorm1 inorm2
A regex which matches everything






outscalar_vars
Scope: private STRING



Description: Variables to output in scalar form



Range Default: (none)
A regex which matches everything






out_criterion
Scope: shared from IOKEYWORD






out_dir
Scope: shared from IOSTRING






out_dt
Scope: shared from IOREAL






out_every
Scope: shared from IOINT






out_fileinfo
Scope: shared from IOKEYWORD






out_group_separator
Scope: shared from IOSTRING






strict_io_parameter_check
Scope: shared from IOBOOLEAN






verbose
Scope: shared from IOKEYWORD



4 Interfaces

General

Implements:

ioscalar

Grid Variables

4.0.1 PRIVATE GROUPS





  Group Names     Variable Names   Details    




last_output_iteration last_output_iteration compact 0
dimensions 0
distribution CONSTANT
group type SCALAR
timelevels 1
variable type INT




last_output_time last_output_time compact 0
dimensions 0
distribution CONSTANT
group type SCALAR
timelevels 1
variable type REAL




this_iteration this_iteration compact 0
dimensions 0
distribution CONSTANT
group type SCALAR
timelevels 1
variable type INT




Uses header:

Timer.hh

carpet.hh

typecase.hh

typeprops.hh

5 Schedule

This section lists all the variables which are assigned storage by thorn Carpet/CarpetIOScalar. Storage can either last for the duration of the run (Always means that if this thorn is activated storage will be assigned, Conditional means that if this thorn is activated storage will be assigned for the duration of the run if some condition is met), or can be turned on for the duration of a schedule function.

Storage

 

Always:  
last_output_iteration last_output_time this_iteration  
   

Scheduled Functions

CCTK_STARTUP

  carpetioscalarstartup

  startup routine

 

  After: ioutil_startup
  Language: c
  Options: global
  Type: function

CCTK_INITIAL

  carpetioscalarinit

  initialisation routine

 

  Language: c
  Options: global
  Type: function
  Writes: carpetioscalar::last_output_iteration
    carpetioscalar::last_output_time
    carpetioscalar::this_iteration