CarpetEvolutionMask

Christian D. Ott, Erik Schnetter <cott@aei.mpg.de>

August 01 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

enforce_mask
Scope: private  BOOLEAN
Description: Set RHS to zero where mask value is 0?
  Default: no

enforce_vars
Scope: private  STRING
Description: Enforce mask in MoL automatically on the following variables
Range   Default: (none)
a list of variables or groups

enlarge_evolved_region_by
Scope: private  INT
Description: enlarge or shrink evolved region
Range   Default: (none)
0:*
positive values enlarge the evolved region
*:0)
negative values shrink the evolved region. Up to buffer_width + nghostzones points can be removed

provide_buffer_mask
Scope: private  BOOLEAN
Description: Compute mask indicating which points need only be computed for some MoL substeps
  Default: no

verbose
Scope: private  BOOLEAN
Description: Do verbose debugging output
  Default: no

writenans
Scope: private  BOOLEAN
Description: Write NaNs into masked regions
  Default: no

7 Interfaces

General

Implements:

carpetevolutionmask

Grid Variables

7.0.1 PUBLIC GROUPS
  Group Names    Variable Names    Details   
evolution_mask evolution_mask   compact0
  descriptionmask function
  dimensions3
  distributionDEFAULT
  group typeGF
  tagsprolongation=”none” InterpNumTimelevels=1
  timelevels1
 variable typeREAL
buffer_mask buffer_mask   compact0
  descriptionbuffer mask function
  dimensions3
  distributionDEFAULT
  group typeGF
  tagsprolongation=”none” InterpNumTimelevels=1
  timelevels1
 variable typeINT

Uses header:

dist.hh

vect.hh

carpet.hh

8 Schedule

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

Scheduled Functions

CCTK_BASEGRID

  evolutionmaskbase_setupevolutionmask

  set up the mask function

 

 Type:group

CCTK_POSTREGRIDINITIAL

  evolutionmaskbase_setupevolutionmask

  set up the mask function

 

 Type:group

CCTK_POSTREGRID

  evolutionmaskbase_setupevolutionmask

  set up the mask function

 

 Type:group

EvolutionMaskBase_SetupEvolutionMask

  evolutionmaskbase_initevolutionmask

  initialise the mask function

 

 Language:c
 Options: global
   loop-local
 Type: function
 Writes: carpetevolutionmask::evolution_mask(everywhere)
   buffer_mask(everywhere)

EvolutionMaskBase_SetupEvolutionMask

  setupevolutionmask

  set up the weight function (schedule other routines in here)

 

 After:evolutionmaskbase_initevolutionmask
 Type:group

SetupEvolutionMask

  carpetevolutionmasksetup

  set up the mask function for the restriction regions

 

 Language:c
 Options: global
   loop-singlemap
 Type: function
 Writes: carpetevolutionmask::evolution_mask(everywhere)

MoL_PostRHS (conditional)

  enforce_evolution_mask

  enforce evolution mask

 

 Language:c
 Reads: carpetevolutionmask::evolution_mask(everywhere)
 Type: function