SetMask_SphericalSurface

Frank Löffler <none>

January 26 2010

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

setmask_maskname
Scope: private  STRING
Description: Full variable name of the mask to be set
Range   Default: HydroBase::hydro_excision_mask
.+
Any full Cactus variable name, GF of type CCTK_BYTE

setmask_radiusfactor
Scope: private  REAL
Description: Factor to modify radius of surface for mask
Range   Default: 1
0:*
Some positive factor, default: 1

setmask_surfaceindex
Scope: private  INT
Description: Index of spherical surface to use to set mask
Range   Default: -1
-1:41
-1 to disable (default), >=0 for index

setmask_surfacename
Scope: private  STRING
Description: Name of spherical surface to use to set mask
Range   Default: (none)
.*
”emtpy to use SetMask_SurfaceIndex , any other string to use the name spherical surface”

setmask_trueshape
Scope: private  BOOLEAN
Description: Use more sophisticated algorithm to closely resemble the 3d shape of the given spherical surface
  Default: false

maxnphi
Scope: shared from SPHERICALSURFACE INT

maxntheta
Scope: shared from SPHERICALSURFACE INT

nsurfaces
Scope: shared from SPHERICALSURFACE INT

7 Interfaces

General

Implements:

setmask_sphericalsurface

Inherits:

hydrobase

sphericalsurface

Uses header:

HydroBase.h

8 Schedule

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

NONE

Scheduled Functions

CCTK_POSTSTEP

  setmask_sphericalsurface

  set hydro_excision_mask according to spherical surface information

 

 After: sphericalsurface_hasbeenset
 Before: hydrobase_excisionhasbeenset
 Language:c
 Options: global
   loop-local
 Type: function

HydroBase_ExcisionMaskSetup

  setmask_sphericalsurface

  set hydro_excision_mask according to spherical surface information

 

 After: hydrobase_initexcisionmask
 Language:c
 Type: function

CCTK_PARAMCHECK

  setmask_paramcheck

  check parameters for consistency

 

 Language:c
 Options: global
 Type: function