Chapter M6
CarpetIOScalar

Author(s): Erik Schnetter <schnetter@aei.mpg.de>

Date: June 11, 2004



M6.1 Abstract

M6.2 Introduction

M6.3 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.

M6.4 Parameters




one_file_per_group
Scope: private   BOOLEAN



Description: Write one file per group instead of per variable



   Default: no






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 IO  KEYWORD






out_dir
Scope: shared from IO  STRING






out_dt
Scope: shared from IO  REAL






out_every
Scope: shared from IO  INT






out_fileinfo
Scope: shared from IO  KEYWORD






strict_io_parameter_check
Scope: shared from IO  BOOLEAN






verbose
Scope: shared from IO  KEYWORD



M6.5 Interfaces

General

Implements:

ioscalar

Grid Variables

PRIVATE GROUPS




  Group Names    Variable Names     Details   




last_output_iteration    compact0
last_output_iteration    dimensions0
   distributionCONSTANT
   group typeSCALAR
   stagger typeNONE
   timelevels1
  variable typeINT




last_output_time    compact0
last_output_time    dimensions0
   distributionCONSTANT
   group typeSCALAR
   stagger typeNONE
   timelevels1
  variable typeREAL




this_iteration    compact0
this_iteration    dimensions0
   distributionCONSTANT
   group typeSCALAR
   stagger typeNONE
   timelevels1
  variable typeINT




Uses header:

carpet.hh

typecase.hh

typeprops.hh

CarpetTimers.hh

M6.6 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_BASEGRID

  carpetioscalarinit

  initialisation routine

 

 Language:c
 Options: global
 Type: function