pyg4ometry.fluka.fluka_registry¶

Attributes¶

logger

Classes¶

`FlukaRegistry`	Object to store geometry for FLUKA input and output. All of the FLUKA classes can be used without storing them in the Registry. The registry is used to write the FLUKA output file.
`RotoTranslationStore`	only get by names.
`FlukaBodyStore`	A MutableMapping is a generic container for associating
`BaseCacher`
`Cacheable`
`HalfSpaceCacher`
`InfiniteCylinderCacher`
`FlukaBodyStoreExact`

Module Contents¶

pyg4ometry.fluka.fluka_registry.logger¶

class pyg4ometry.fluka.fluka_registry.FlukaRegistry¶

Object to store geometry for FLUKA input and output. All of the FLUKA classes can be used without storing them in the Registry. The registry is used to write the FLUKA output file.

bodyDict¶

rotoTranslations¶

regionDict¶

materials¶

iMaterials = 0¶

materialShortName¶

latticeDict¶

mgnFieldDict¶

cardDict¶

assignmas¶

_predefinedMaterialNames¶

iMerge = 0¶

iMergeBodies = 0¶

iMergeRegions = 0¶

iMergeMaterials = 0¶

_bodiesAndRegions¶

PhysVolToRegionMap¶

addBody(body)¶

makeBody(clas, *args, **kwargs)¶

getDegenerateBody(body)¶

addRotoTranslation(rototrans)¶

addRegion(region, addBodies=False)¶

makeRegionsDNF()¶

addLattice(lattice)¶

getBody(name)¶

getBodyToRegionsMap()¶

printDefinitions()¶

regionAABBs(write=None)¶

latticeAABBs()¶

addMaterial(material, recursive=False)¶

getMaterial(name)¶

addMaterialAssignments(mat, *regions, elc=None, mgn=None)¶

assignma(material, *regions)¶

addCard(card)¶

addTitle(title='FLUKA simulation')¶

addDefaults(default='EM-CASCA')¶

addGlobal()¶

addBeam(energy, energySpread=0.1, beamDivergence=0, beamWidthX=0.1, beamWidthY=0.0, annular=-1, particleType='ELECTRON')¶

addBeamPos(xpos=0, ypos=0, zpos=0, xdc=0, ydc=0)¶

addLowMat(flukaMat, lowENeutron1, lowENeutron2, lowENeutron3)¶

addLowMatAllMaterials()¶: Add LOWMAT card to all materials

addLowPwxs(what1=None, lowerMaterial=None, upperMaterial=None)¶

addMgnCreat()¶

addMgnField()¶

addElcField()¶

addUsrBin(mesh=0, particle='ENERGY', lunOutput=-21, e1max=1, e2max=1, e3max=1, name='name', e1min=-1, e2min=-1, e3min=-1, e1nbin=10, e2nbin=10, e3nbin=10)¶

addRotprBin(precision=0, rotDefi=0, printEventBin=0, lowerBin=None, upperBin=None)¶

addUsrBdx(binning, scoringDir, scoringType, type, reg1, reg2, name, area=1.0, lunOutput=-22, maxKE=None, minKE=None, nKEbin=None, maxSA=None, minSA=None, nSAbin=None)¶

addUsricall()¶

addUsrocall()¶

addUsrDump(mgdraw=100, lun=70, mgdrawOpt=-1, what4=0, sdum=None)¶

addRandomiz(seedLun=1, seed=54217137)¶

addStart(maxPrimHistories=1, timeTermSec=None, coreDump=None, eachHistoryOutput=None)¶

addPhotonuc(what1, mat_low, mat_high, mat_step, sdum='')¶

addMuphoton(what1, mat_low, mat_high, mat_step)¶

addPairbrem(what1, what2, what3, mat_low, mat_high, mat_step)¶

addDeltaRay(what1, what2, what3, mat_low, mat_high, mat_step, dsum='NOPRINT')¶

addIonFluct(what1, what2, what3, mat_low, mat_high, mat_step, dsum='PRIM-ION')¶

printDumps(detail=1)¶

findLastBodyIndex()¶: Find last body index (if the numbering was performed by a geant4 -> fluka conversion

findLastRegionIndex()¶: Find last region index (if the numbering was performed by a geant4 -> fluka conversion

findLastMaterialIndex()¶: Find last material index (if the numbering was performed by a geant4 -> fluka conversion

findLastTransformationIndex()¶

checkBodyName(bodyName)¶

checkRegionName(regionName)¶

checkMaterialName(materialName)¶

addRegistry(flukaRegistry, outerRegion=None, rotation=[0, 0, 0], translation=[0, 0, 0], removeRegions=[], removeRegionDependents=False)¶

class pyg4ometry.fluka.fluka_registry.RotoTranslationStore¶

Bases: collections.abc.MutableMapping

only get by names.

_nameMap¶

_counter¶

__getitem__(name)¶

__setitem__(name, rtrans)¶

addRotoTranslation(rtrans)¶

allTransformationIndices()¶

__delitem__(key)¶

__iter__()¶

__len__()¶

flukaFreeString()¶

class pyg4ometry.fluka.fluka_registry.FlukaBodyStore¶

Bases: collections.abc.MutableMapping

A MutableMapping is a generic container for associating key/value pairs.

This class provides concrete generic implementations of all methods except for __getitem__, __setitem__, __delitem__, __iter__, and __len__.

_df¶

hscacher¶

infCylCacher¶

_cachers¶

_basecacher¶

_bodyNames()¶

_bodies()¶

_getCacherFromBody(body)¶

make(clas, *args, **kwargs)¶

getDegenerateBody(body)¶

addBody(body)¶

__setitem__(key, value)¶

__getitem__(key)¶

__delitem__(key)¶

__len__()¶

__contains__(key)¶

__iter__()¶

__repr__()¶

class pyg4ometry.fluka.fluka_registry.BaseCacher(df)¶

COLUMNS = ['name', 'body']¶

df¶

appendData(variables)¶

append(body)¶

setBody(body)¶

addBody(body)¶

remove(key)¶

make(clas, *args, **kwargs)¶

getDegenerateBody(body)¶

__repr__()¶

class pyg4ometry.fluka.fluka_registry.Cacheable(df)¶

Bases: BaseCacher

getDegenerateBody(body)¶

getMask(columns, values, predicates)¶

class pyg4ometry.fluka.fluka_registry.HalfSpaceCacher(df)¶

Bases: Cacheable

COLUMNS = ['name', 'body', 'planeNormal', 'pointOnPlane']¶

append(body)¶

mask(body)¶

class pyg4ometry.fluka.fluka_registry.InfiniteCylinderCacher(df)¶

Bases: Cacheable

COLUMNS = ['name', 'body', 'direction', 'pointOnLine', 'radius']¶

append(body)¶

mask(body)¶

static _cylinderPoint(body)¶

class pyg4ometry.fluka.fluka_registry.FlukaBodyStoreExact¶

nameBody¶

hashBody¶

hashName¶

_bodyNames()¶

_bodies()¶

make(cls, *args, **kwargs)¶

getDegenerateBody(body)¶

addBody(body)¶

keys()¶

values()¶

__setitem__(key, value)¶

__getitem__(key)¶

__delitem__(key)¶

__len__()¶

__contains__(key)¶

__iter__()¶

__repr__()¶