MaterialBuilder¶

This is a Python binding to the C++ class Mantid::Kernel::MaterialBuilder. It provides an interface for generating mantid.kernel.Material objects.

class mantid.kernel.MaterialBuilder¶

build((MaterialBuilder)self) → Material :¶

Build the new mantid.kernel.Material object from the current set of options

setAbsorptionXSection((MaterialBuilder)self, (float)xsec) → MaterialBuilder :¶

Set the absorption cross section of the material in barns

setAtomicNumber((MaterialBuilder)self, (int)atomicNumber) → MaterialBuilder :¶

Set the atomic number of the material

setCoherentXSection((MaterialBuilder)self, (float)xsec) → MaterialBuilder :¶

Set the coherent cross section of the material in barns

setFormula((MaterialBuilder)self, (str)formula) → MaterialBuilder :¶

Set the chemical formula of the material

setIncoherentXSection((MaterialBuilder)self, (float)xsec) → MaterialBuilder :¶

Set the incoherent cross section of the material in barns

setMassDensity((MaterialBuilder)self, (float)massDensity) → MaterialBuilder :¶

Set the mass density of the material in g / cc

setMassNumber((MaterialBuilder)self, (int)massNumber) → MaterialBuilder :¶

Set the mass number of the material

setName((MaterialBuilder)self, (str)name) → MaterialBuilder :¶

Set the string name given to the material. Defaults to the chemical formula.

setNumberDensity((MaterialBuilder)self, (float)rho) → MaterialBuilder :¶

Set the number density of the material in atoms (default) or formula units per Angstrom^3

setNumberDensityUnit((MaterialBuilder)self, (NumberDensityUnit)unit) → MaterialBuilder :¶

Change the number density units from atoms per Angstrom^3 to the desired unit

setPackingFraction((MaterialBuilder)self, (float)fraction) → MaterialBuilder :¶

Set the packing fraction of the material (default is 1). This is used to infer the effective number density.

setTotalScatterXSection((MaterialBuilder)self, (float)xsec) → MaterialBuilder :¶

Set the total scattering cross section of the material in barns

setUnitCellVolume((MaterialBuilder)self, (float)cellVolume) → MaterialBuilder :¶

Set the unit cell volume of the material

setZParameter((MaterialBuilder)self, (float)zparam) → MaterialBuilder :¶

Set the number of formula units in a unit cell