Material (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.material.Material

All Implemented Interfaces:

IMaterial
```
public class Material
extends Object
implements IMaterial
```
Implementation of detector material, mostly based on Geant4's G4Material.

Version:

$Id: Material.java,v 1.23 2011/03/11 19:22:20 jeremy Exp $

Author:

jeremym

Field Summary

Fields
Modifier and Type	Field and Description
`private double`	`_Aeff`
`private List<Integer>`	`_atoms`
`(package private) double`	`_density`
`private List<MaterialElement>`	`_elements`
`(package private) String`	`_formula`
`(package private) boolean`	`_isElement`
`private List<Double>`	`_massFractions`
`(package private) String`	`_name`
`(package private) int`	`_nComponents`
`(package private) int`	`_nComponentsMax`
`(package private) int`	`_nElements`
`(package private) double`	`_nuclearInteractionLength`
`(package private) double`	`_nuclearInteractionLengthWithDensity`
`(package private) double`	`_radiationLength`
`(package private) double`	`_radiationLengthWithDensity`
`(package private) MaterialState`	`_state`
`private double`	`_Zeff`
`static double`	`DEFAULT_PRESSURE`
`static double`	`DEFAULT_TEMPERATURE`
`private static double`	`MAX_LAMBDA`
`private static double`	`MAX_X0`

Constructor Summary

Constructors
Constructor and Description
`Material(String name, int nComponents, double density, MaterialState state)` Construct a material with a number of sub-components, which will be either a set of mass fractions or set of number of atoms.
`Material(String matName, String formula, double z, double a, double density, double X0, double lambda, MaterialState state)` This is a constructor for materials that are chemical elements.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addElement(MaterialElement element, double fraction)` Add chemical element to the material by fraction of mass.
`protected void`	`addElement(MaterialElement element, int nAtoms)` Add an element to the material by atom count.
`void`	`addMaterial(Material material, double fraction)` Add a component material by fraction of mass.
`private void`	`checkMassSum()` Check that the massFractions list adds up to 1.0.
`private double`	`computeAeff()` Compute the effective A for this material using its element list.
`private void`	`computeDerivedQuantities()` Computes and caches derived computed quantities after all components have been added to the material.
`private void`	`computeNuclearInteractionLength()` Compute the nuclear interaction length (lambda).
`private void`	`computeRadiationLength()` Compute the radiation length (x0) based on mass fractions of elements.
`private double`	`computeZeff()` Compute the effective Z for this material using its element list.
`double`	`getA()` Get the A of this Material, which is a computed, effective A.
`double`	`getAeff()`
`double`	`getDensity()` Get the density (g/cm^3).
`List<MaterialElement>`	`getElements()` Get the list of component MaterialElements referenced by this material.
`List<Double>`	`getMassFractions()`
`String`	`getName()` Get the name of the Material.
`protected int`	`getNComponents()`
`protected int`	`getNComponentsMax()`
`protected int`	`getNElements()`
`double`	`getNuclearInteractionLength()` Get the nuclear interaction length in g/cm2.
`double`	`getNuclearInteractionLengthWithDensity()` Get the nuclear interaction length in g/cm2.
`protected int`	`getNumberOfElements()`
`double`	`getPressure()` Get the pressure of the material in atmospheres.
`double`	`getRadiationLength()` Get the radiation length in g/cm2.
`double`	`getRadiationLengthWithDensity()` Get the radiation length in cm.
`MaterialState`	`getState()` Get the state of this material, either liquid, gas, solid, or unknown.
`double`	`getTemperature()` Get the temperature of the material in Kelvin.
`double`	`getZ()` Get the Z of this Material, which is a computed, effective Z.
`double`	`getZeff()`
`boolean`	`isElement()`
`protected boolean`	`isFilled()` True if all components have been added; false if not.
`String`	`toString()` Translate this material to a human-readable string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_TEMPERATURE
```
public static final double DEFAULT_TEMPERATURE
```
    See Also:
    Constant Field Values
  - DEFAULT_PRESSURE
```
public static final double DEFAULT_PRESSURE
```
    See Also:
    Constant Field Values
  - MAX_X0
```
private static final double MAX_X0
```
    See Also:
    Constant Field Values
  - MAX_LAMBDA
```
private static final double MAX_LAMBDA
```
    See Also:
    Constant Field Values
  - _density
```
double _density
```
  - _isElement
```
boolean _isElement
```
  - _Zeff
```
private double _Zeff
```
  - _Aeff
```
private double _Aeff
```
  - _state
```
MaterialState _state
```
  - _name
```
String _name
```
  - _formula
```
String _formula
```
  - _nComponents
```
int _nComponents
```
  - _nComponentsMax
```
int _nComponentsMax
```
  - _nElements
```
int _nElements
```
  - _elements
```
private List<MaterialElement> _elements
```
  - _massFractions
```
private List<Double> _massFractions
```
  - _atoms
```
private List<Integer> _atoms
```
  - _radiationLength
```
double _radiationLength
```
  - _radiationLengthWithDensity
```
double _radiationLengthWithDensity
```
  - _nuclearInteractionLength
```
double _nuclearInteractionLength
```
  - _nuclearInteractionLengthWithDensity
```
double _nuclearInteractionLengthWithDensity
```
- Constructor Detail
  - Material
```
Material(String matName,
        String formula,
        double z,
        double a,
        double density,
        double X0,
        double lambda,
        MaterialState state)
```
    This is a constructor for materials that are chemical elements. It is not accessible outside the package, as users should not be able to create their own elements.
    
    Parameters:
    matName - The full name of the material (e.g. "Tungsten").
    formula - The formula of the element (e.g. "W" for Tungsten).
    z - The atomic number.
    a - The atomic weight.
    density - The density in g/cm3.
    X0 - The radiation length in g/cm-2.
    lambda - The nuclear interaction length in g/cm-2.
    state - The state of the element (liquid, gas, solid, or unknown).
  - Material
```
public Material(String name,
        int nComponents,
        double density,
        MaterialState state)
```
    Construct a material with a number of sub-components, which will be either a set of mass fractions or set of number of atoms.
- Method Detail
  - getName
```
public String getName()
```
    Get the name of the Material.
    
    Specified by:
    
    getName in interface IMaterial
    
    Returns:
    The name of this Material.
  - getDensity
```
public double getDensity()
```
    Get the density (g/cm^3).
    
    Specified by:
    
    getDensity in interface IMaterial
    
    Returns:
    The density in g/cm3.
  - isElement
```
public boolean isElement()
```
    Returns:
    whether this material has a 1 to 1 correspondance to a single chemical element
  - getZeff
```
public double getZeff()
```
    Returns:
    The effective Z of this material.
  - getAeff
```
public double getAeff()
```
    Returns:
    The effective A of this material.
  - getNComponentsMax
```
protected int getNComponentsMax()
```
    Returns:
    The maximum number of components that can be added.
  - getNComponents
```
protected int getNComponents()
```
    Returns:
    The number of components defined so far in this material.
  - getNElements
```
protected int getNElements()
```
    Returns:
    number of elements defined in this material
  - getState
```
public MaterialState getState()
```
    Description copied from interface: IMaterial
    
    Get the state of this material, either liquid, gas, solid, or unknown.
    
    Specified by:
    
    getState in interface IMaterial
    
    Returns:
    the state of this material
  - getRadiationLength
```
public double getRadiationLength()
```
    Description copied from interface: IMaterial
    
    Get the radiation length in g/cm2.
    
    Specified by:
    
    getRadiationLength in interface IMaterial
    
    Returns:
    X0
  - getNuclearInteractionLength
```
public double getNuclearInteractionLength()
```
    Description copied from interface: IMaterial
    
    Get the nuclear interaction length in g/cm2.
    
    Specified by:
    
    getNuclearInteractionLength in interface IMaterial
    
    Returns:
    The nuclear interaction length; also called lambda.
  - getNuclearInteractionLengthWithDensity
```
public double getNuclearInteractionLengthWithDensity()
```
    Description copied from interface: IMaterial
    
    Get the nuclear interaction length in g/cm2.
    
    Specified by:
    
    getNuclearInteractionLengthWithDensity in interface IMaterial
    
    Returns:
    lambda / density
  - getRadiationLengthWithDensity
```
public double getRadiationLengthWithDensity()
```
    Description copied from interface: IMaterial
    
    Get the radiation length in cm.
    
    Specified by:
    
    getRadiationLengthWithDensity in interface IMaterial
    
    Returns:
    X0 in cm = (X0/density)
  - getNumberOfElements
```
protected int getNumberOfElements()
```
    Returns:
    total number of (unique) elements in the element list for this material
  - getElements
```
public List<MaterialElement> getElements()
```
    Get the list of component MaterialElements referenced by this material.
    
    Returns:
    A list of elements in this material.
  - getMassFractions
```
public List<Double> getMassFractions()
```
    Returns:
    The mass fractions for each element in the material.
  - addElement
```
protected void addElement(MaterialElement element,
              int nAtoms)
```
    Add an element to the material by atom count. Based on Geant4's G4Material::AddElement() method.
  - addElement
```
protected void addElement(MaterialElement element,
              double fraction)
```
    Add chemical element to the material by fraction of mass. When all components are added, the fractions must add up to 1.0 .
  - addMaterial
```
public void addMaterial(Material material,
               double fraction)
```
    Add a component material by fraction of mass. When done, must add up to 1.0.
    
    Parameters:
    The - material to add.
    The - fraction of total which must be > 0 and <= 1.
  - getPressure
```
public double getPressure()
```
    Description copied from interface: IMaterial
    
    Get the pressure of the material in atmospheres.
    
    Specified by:
    
    getPressure in interface IMaterial
    
    Returns:
    The pressure of the material in atmospheres.
  - getTemperature
```
public double getTemperature()
```
    Description copied from interface: IMaterial
    
    Get the temperature of the material in Kelvin.
    
    Specified by:
    
    getTemperature in interface IMaterial
    
    Returns:
    The temperature in Kelvin.
  - toString
```
public String toString()
```
    Translate this material to a human-readable string.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String rep of this object.
  - isFilled
```
protected boolean isFilled()
```
    True if all components have been added; false if not.
    
    Returns:
    True if all component elements and materials have been added.
  - checkMassSum
```
private void checkMassSum()
```
    Check that the massFractions list adds up to 1.0.
  - computeZeff
```
private double computeZeff()
```
    Compute the effective Z for this material using its element list.
    
    Returns:
    The effective Z.
  - computeAeff
```
private double computeAeff()
```
    Compute the effective A for this material using its element list.
    
    Returns:
    The effective A.
  - computeNuclearInteractionLength
```
private void computeNuclearInteractionLength()
```
    Compute the nuclear interaction length (lambda).
  - computeRadiationLength
```
private void computeRadiationLength()
```
    Compute the radiation length (x0) based on mass fractions of elements.
  - computeDerivedQuantities
```
private void computeDerivedQuantities()
```
    Computes and caches derived computed quantities after all components have been added to the material. This method is called in Material ctors. For Materials with sub-components, it is called after all components are added.
  - getA
```
public double getA()
```
    Get the A of this Material, which is a computed, effective A.
    
    Specified by:
    
    getA in interface IMaterial
    
    Returns:
    The atomic number.
  - getZ
```
public double getZ()
```
    Get the Z of this Material, which is a computed, effective Z.
    
    Specified by:
    
    getZ in interface IMaterial
    
    Returns:
    The atomic mass.

Class Material

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_TEMPERATURE

DEFAULT_PRESSURE

MAX_X0

MAX_LAMBDA

_density

_isElement

_Zeff

_Aeff

_state

_name

_formula

_nComponents

_nComponentsMax

_nElements

_elements

_massFractions

_atoms

_radiationLength

_radiationLengthWithDensity

_nuclearInteractionLength

_nuclearInteractionLengthWithDensity

Constructor Detail

Material

Material

Method Detail

getName

getDensity

isElement

getZeff

getAeff

getNComponentsMax

getNComponents

getNElements

getState

getRadiationLength

getNuclearInteractionLength

getNuclearInteractionLengthWithDensity

getRadiationLengthWithDensity

getNumberOfElements

getElements

getMassFractions

addElement

addElement

addMaterial

getPressure

getTemperature

toString

isFilled

checkMassSum

computeZeff

computeAeff

computeNuclearInteractionLength

computeRadiationLength

computeDerivedQuantities

getA

getZ