CarpetMask

Erik Schnetter <schnetter@cct.lsu.edu>

April 20 2007

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


exclude_exterior	Scope: private	BOOLEAN

Description: exclude the exterior of this radius, otherwise the interior

		Default: no


excluded_centre_x	Scope: private	REAL

Description: x coordinate of excluded region

Range		Default: 0.0
:


excluded_centre_y	Scope: private	REAL

Description: y coordinate of excluded region

Range		Default: 0.0
:


excluded_centre_z	Scope: private	REAL

Description: z coordinate of excluded region

Range		Default: 0.0
:


excluded_radius	Scope: private	REAL

Description: radius of excluded region

Range		Default: -1.0
-1.0	do not exlude this region
0.0:*


excluded_surface	Scope: private	INT

Description: index of excluded surface

Range		Default: -1
-1	do not exclude
0:*


excluded_surface_factor	Scope: private	REAL

Description: shrink factor of excluded surface

Range		Default: 1.0
0:*


verbose	Scope: private	BOOLEAN

Description: Produce screen output

		Default: no


maxnphi	Scope: shared from SPHERICALSURFACE	INT


maxntheta	Scope: shared from SPHERICALSURFACE	INT


nsurfaces	Scope: shared from SPHERICALSURFACE	INT


symmetric_x	Scope: shared from SPHERICALSURFACE	BOOLEAN


symmetric_y	Scope: shared from SPHERICALSURFACE	BOOLEAN


symmetric_z	Scope: shared from SPHERICALSURFACE	BOOLEAN

7 Interfaces

General

Implements:

carpetmask

Inherits:

grid

sphericalsurface

Uses header:

CarpetReduce_bits.h

8 Schedule

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

carpetsurfaceparamcheck

check parameters

	Language:	c
	Options:	global
	Type:	function

CCTK_POSTSTEP

maskbase_setupmask

set up the weight function

	After:	sphericalsurface_hasbeenset
	Type:	group

SetupIMask

carpetexcludedsetup

set up the weight function for the excluded regions

	Language:	c
	Options:	global
		loop-local
	Reads:	grid::x
		grid::y
		grid::z
	Type:	function

SetupIMask

carpetsurfacesetup

set up the weight function for the excluded spherical surfaces

	Language:	c
	Options:	global
		loop-local
	Reads:	grid::x
		grid::y
		grid::z
		sphericalsurface::sf_coordinate_descriptors
		sphericalsurface::sf_shape_descriptors
		sphericalsurface::sf_info
		sphericalsurface::sf_active
		sphericalsurface::sf_origin
		sphericalsurface::sf_radius
	Type:	function