CarpetIOBasic

Erik Schnetter <schnetter@cct.lsu.edu>

December 20 2005

Abstract

1 Introduction

2 Physical System

3 Numerical Implementation

4 Using This Thorn

4.1 Obtaining This Thorn

4.2 Basic Usage

4.3 Special Behaviour

4.4 Interaction With Other Thorns

4.5 Examples

4.6 Support and Feedback

5 History

5.1 Thorn Source Code

5.2 Thorn Documentation

5.3 Acknowledgements

References

6 Parameters




int_width
Scope: private  INT



Description: Field width for integer values



Range   Default: 9
1:*






iter_width
Scope: private  INT



Description: Field width for the current iteration



Range   Default: 9
1:*






outheader_every
Scope: private  INT



Description: How often to print the header



Range   Default: 20
1:*
Output every so many time steps
-1
No header output






outinfo_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






outinfo_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






outinfo_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






outinfo_reductions
Scope: private  STRING



Description: List of reductions to output in scalar form



Range   Default: minimum maximum
A regex which matches everything






outinfo_vars
Scope: private  STRING



Description: Variables to output in scalar form



Range   Default: (none)
A regex which matches everything






real_max
Scope: private  REAL



Description: Upper bound for numbers that are displayed in fixed notation



Range   Default: 1.0e+3
(0.0:*






real_min
Scope: private  REAL



Description: Lower bound for numbers that are displayed in fixed notation



Range   Default: 1.0e-8
(0.0:*






real_prec
Scope: private  INT



Description: Precision for real values



Range   Default: 7
0:*






real_prec_sci
Scope: private  INT



Description: Precision for real values in scientific notation



Range   Default: 6
0:*






real_width
Scope: private  INT



Description: Field width for real values



Range   Default: 12
1:*






time_prec
Scope: private  INT



Description: Precision for the simulation time



Range   Default: 3
0:*






time_width
Scope: private  INT



Description: Field width for the simulation time



Range   Default: 9
1:*






out_criterion
Scope: shared from IO KEYWORD






out_dt
Scope: shared from IO REAL






out_every
Scope: shared from IO INT






strict_io_parameter_check
Scope: shared from IO BOOLEAN



7 Interfaces

General

Implements:

iobasic

Inherits:

io

Grid Variables

7.0.1 PRIVATE GROUPS




  Group Names    Variable Names    Details   




last_output_iteration   compact0
last_output_iteration   dimensions0
  distributionCONSTANT
  group typeSCALAR
  timelevels1
 variable typeINT




last_output_time   compact0
last_output_time   dimensions0
  distributionCONSTANT
  group typeSCALAR
  timelevels1
 variable typeREAL




this_iteration   compact0
this_iteration   dimensions0
  distributionCONSTANT
  group typeSCALAR
  timelevels1
 variable typeINT




Uses header:

Timer.hh

carpet.hh

typecase.hh

typeprops.hh

8 Schedule

This section lists all the variables which are assigned storage by thorn Carpet/CarpetIOBasic. 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

  carpetiobasicstartup

  startup routine

 

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

CCTK_INITIAL

  carpetiobasicinit

  initialisation routine

 

 Language:c
 Options: global
 Type: function