Technical Documentation
The Swiss Cheese File

This page describes the format of the Swiss Cheese file, which is required for the creation of the SwissCheeseX Energy object.

This is an unformatted (binary) file. It is endian-specific, but the utilities on any platform can read either a big or little endian file.

Identifiers

The file begins with a specific number, DENSITYOPEN, defined in Yup.Data.Constants and ends with a specific number, DENSITYEXIT, also defined in Yup.Data.Constants.

Format

The contents of this file are:

Data

C Type

Opening Identifier = DENSITYOPEN

int

S = number of Holes

int

Width of cubical voxel [Å]

double

L = number of voxels along the first dimension int
M = number of voxels along the second dimension int
N = number of voxels along the third dimension int
dL = index offset along the first dimension int
dM = index offset along the second dimension int
dN = index offset along the third dimension int
first hole O double
hash of location indices int
...n-th hole O double
hash of location indices int
last (S-th) hole O double
hash of location indices int

Closing Identifier DENSITYEXIT

int

Note that this file contains data for voxels with densities above a user-defined level. The data for each hole consists of a pair of numbers: the constant O and a hash of the location indices. The last is a single integer formed from the indices along the three dimensjons (i, j, k) yields a hash value of L [ Mk + j ] + i.

Utilities

The SwissCheese module in Yup.Tools provide functions to convert density maps to Swiss Cheese files.


Technical
Introduction
Directory
Vectors
Energy
Model
Assembly
Methods
FPF
FFF
AVF
TaroScript
YammpScript
Python
Utilities

Home
Information
News
User
Technical
Programmer
iYup
Download
Showcase
ETC