GeoModelMassCalculator¶

GeoModelMassCalculator (gmmasscalc) is a command line tool that calculates the inclusive and exclusive mass of a geometry specified as input with the -g flag. The mass report is given in an output json file (default: gmmasscalc_report.json).

Run the executable with the --help option to see the available options:

-g :   [MANDATORY] the Geometry file name [.db/.gdml/.dylib/.so] 
-p :   [OPTIONAL] prefix of the Logical Volumes of interest (i.e. Pixel::) 
-m :   [OPTIONAL] material of interest (i.e. Aluminium) 
-o :   [OPTIONAL] mass report json file name (default: gmmasscalc_report.json)
-v :   [OPTIONAL] verbose mode: 1 - print all the Logical Volume names and materials, 2 - print materials composition (default: off)

By default (if the optional flag are not used) gmmasscalc, takes the main World Volume, and calculates the inclusive and exclusive masses of the respective daughters, saving the calculated quantities in the output json file. At the end of the report, the total masses are reported for the whole World Volume. The output JSON file format is the following:

{
"exclusiveMass[kg]": 1.3358800280858636,
"inclusiveMass[kg]": 133.81273262584054,
"logicalVolumeName": "SCT_ForwardC",
"material": "Air",
"physicalVolumeName": "SCT",
"volumeCopyNo": 16969,
"volumeEntityType": "G4Tubs"
}

where:

exclusiveMass is the mass of the considered volume only (from which the volumes occupied by the daughters volumes have been subtracted)
inclusiveMass is the mass of the considered volume, comprehensive of the masses of the respective daughters (propagated in an iterative way to their daughter volumes).

At the end of the report, additional information about the whole geometry is reported. The last item of the JSON file will look like the following:

{
"apparentWeightInAir[kg]": 2405.2018407511378,
"densityThreshold[g/cm3]": 0.02,
"excludedFilteredMass[kg]": 14.649883998898723,
"exclusiveMass[kg]": 1.3704943478464804,
"inclusiveFilteredMass[kg]": 2406.500411630485,
"inclusiveMass[kg]": 2421.156760687377,
"logicalVolumeName": "newWorldLog",
"material": "Air",
"volumeEntityType": "World Volume"
}

where:

apparent weight in Air by definition, the weight of a body as affected by the buoyancy of a fluid (such as air) in which it is immersed. It is calculated only on the total geometry, assuming that the World Volume is made of Air
exclusiveFilteredMass is the sum of the exclusive masses of all the volumes with density > densityThreshold (0.02 g/cm3)
excludedFilteredMass is the sum of the exclusive masses of all the volumes with density < densityThreshold (0.02 g/cm3)

In addition to the default behaviour, gmmasscalc offers the possibility to apply 2 filters to the geometry, described in what follows.

The -p (--prefix) option allows to indicate the prefix of the volumes of interest. In this case gmmasscalc will loop over the geometry tree and calculate the mass of every Logical Volume that has the specified prefix in its name. For every Logical volume found, a different entry will be filled in the output report file.

The -m (--material) option allows to specify to which material the user is interested. In this case gmmasscalc will loop over the geometry tree and calculate the mass of those volumes that are made of the material of interest.

If both the -p and -m flags are used, gmmasscalc will combine the 2 filters and retrieve in the output file only the masses of the volumes containing the specified prefix and made of the desired material.

At the end of the report, the total exclusive mass for the requested geometry is reported for all the volumes that satisfy the user request. The last item in the report will look like the following:

{
"exclusiveMass[kg]": 14.676774220119631,
"inclusiveMass[kg]": -999.0,
"logicalVolumeName": "",
"material": "CO2",
"physicalVolumeName": "",
"volumeCopyNo": 0,
"volumeEntityType": "Total for filtered Geometry"
}

where:

logicalVolumeName and material are respectively the prefix used as filter for the Logical Volume names in the geometry tree navigation, and the material used as a second filter in the search.

The -v flag is a verbosity flag. Two different levels of verbosity can be set: level 1 prints all the logical volume names and respective materials, level 2 adds also the material composition for each material in the geometry.

Examples¶

To run GeoModelMassCalculator one has to specify with the -g flag the geometry file (this is mandatory). By default gmmasscalc writes out the masses report in the gmmasscalc_report.json file:

./gmmasscalc -g geometry-ATLAS-R2-2016-01-00-01_wSPECIALSHAPE.db

To calculate the mass of a geometry described with the SQLite file LArBarrel.db and write out the masses report in the mass_LArBarrel.json file :

./gmmasscalc -g LArBarrel.db -o mass_LArBarrel.json

To calculate the mass of a geometry described with the SQLite file SCT.db, only for the logical volumes that have BRLSensor in their names, and only for those volumes that are made of Silicon and write out the masses report in the mass_SCT.json file:

./gmmasscalc -g SCT.db -p BRLSensor -m Silicon -o mass_SCT.json

To calculate the mass of a geometry described with one of the GeoModelPlugins repo, i.e. HGTDPlugin, looking for volumes made of Aluminium and write out the masses report in the mass_HGTD.json file :

./gmmasscalc -g libHGTDPlugin.1.0.0.dylib -m Aluminium -o mass_HGTD.json