MaterialElement (LCSim 3.1.7 API)

java.lang.Object
- org.lcsim.detector.material.MaterialElement

All Implemented Interfaces:

IMaterial

Direct Known Subclasses:

MaterialMixture
```
public class MaterialElement
extends Object
implements IMaterial
```
This class is a Material that represents a chemical element. It uses the CLHEP values for Avogadro, fine structure constant, and electron radius. Radiation lengths are computed using the Tsai formula, ported from Lelaps. Nuclear interaction length is computed with a simple fit, ported from Lelaps.

Version:

$Id: MaterialElement.java,v 1.5 2010/04/14 18:24:53 jeremy Exp $

Author:

Jeremy McCormick

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lcsim.detector.material.IMaterial
  IMaterial.State

Field Summary

Fields
Modifier and Type	Field and Description
`protected double`	`A`
`protected double`	`criticalEnergy`
`protected double`	`density`
`protected double`	`moliereRadius`
`protected double`	`N`
`protected String`	`name`
`protected double`	`nuclearInteractionLength`
`protected double`	`nuclearInteractionLengthWithDensity`
`protected double`	`pressure`
`protected double`	`radiationLength`
`protected double`	`radiationLengthWithDensity`
`protected IMaterial.State`	`state`
`protected double`	`temperature`
`protected double`	`Z`

Fields inherited from interface org.lcsim.detector.material.IMaterial
defaultIonizationPotential, defaultPressure, defaultState, defaultTemperature, Gas, Liquid, Solid, Unknown

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MaterialElement()` Constructor for sub-classes.
	`MaterialElement(String name, double Z, double A, double density)` Construct a MaterialElement.
	`MaterialElement(String name, double Z, double A, double density, IMaterial.State state, double temperature, double pressure)` Construct a MaterialElement.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`computeCriticalEnergy()`
`private void`	`computeDerivedQuantities()`
`protected void`	`computeMoliereRadius()`
`protected void`	`computeNuclearInteractionLength()`
`static double`	`computeNuclearInteractionLength(double A, double Z)`
`protected void`	`computeRadiationLength()`
`static double`	`computeRadiationLengthTsai(double A, double Z)`
`double`	`getA()` Get the atomic number of this material.
`double`	`getDensity()` Get the density of this material in g/cm3.
`double`	`getEffectiveNumberOfNucleons()`
`double`	`getMoliereRadius()` Get the Moliere radius in cm.
`String`	`getName()` Get the name of this material.
`double`	`getNuclearInteractionLength()` Get the nuclear interaction length in g/cm2.
`double`	`getNuclearInteractionLengthWithDensity()` Get the nuclear interaction length in g/cm2.
`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.
`IMaterial.State`	`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 atomic mass of this material.
`String`	`toString()`

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

- Field Detail
  - name
```
protected String name
```
  - Z
```
protected double Z
```
  - A
```
protected double A
```
  - density
```
protected double density
```
  - temperature
```
protected double temperature
```
  - pressure
```
protected double pressure
```
  - state
```
protected IMaterial.State state
```
  - N
```
protected double N
```
  - nuclearInteractionLength
```
protected double nuclearInteractionLength
```
  - nuclearInteractionLengthWithDensity
```
protected double nuclearInteractionLengthWithDensity
```
  - radiationLength
```
protected double radiationLength
```
  - radiationLengthWithDensity
```
protected double radiationLengthWithDensity
```
  - criticalEnergy
```
protected double criticalEnergy
```
  - moliereRadius
```
protected double moliereRadius
```
- Constructor Detail
  - MaterialElement
```
protected MaterialElement()
```
    Constructor for sub-classes.
  - MaterialElement
```
public MaterialElement(String name,
               double Z,
               double A,
               double density,
               IMaterial.State state,
               double temperature,
               double pressure)
```
    Construct a MaterialElement.
    
    Parameters:
    name - The name of the material, which must be globally unique.
    Z - The atomic mass.
    A - The atomic number.
    density - The density in g/cm3.
    state - The material's state.
    temperature - The temperature in Kelvin.
    pressure - The pressure in atmospheres.
  - MaterialElement
```
public MaterialElement(String name,
               double Z,
               double A,
               double density)
```
    Construct a MaterialElement.
    
    Parameters:
    name - The name of the material, which must be globally unique.
    Z - The atomic mass.
    A - The atomic number.
    density - The density in g/cm3.
- Method Detail
  - computeDerivedQuantities
```
private void computeDerivedQuantities()
```
  - computeCriticalEnergy
```
protected void computeCriticalEnergy()
```
  - computeMoliereRadius
```
protected void computeMoliereRadius()
```
  - computeRadiationLength
```
protected void computeRadiationLength()
```
  - computeNuclearInteractionLength
```
protected void computeNuclearInteractionLength()
```
  - getA
```
public double getA()
```
    Description copied from interface: IMaterial
    
    Get the atomic number of this material.
    
    Specified by:
    
    getA in interface IMaterial
    
    Returns:
    The atomic number.
  - getDensity
```
public double getDensity()
```
    Description copied from interface: IMaterial
    
    Get the density of this material in g/cm3.
    
    Specified by:
    
    getDensity in interface IMaterial
    
    Returns:
    The density in g/cm3.
  - getName
```
public String getName()
```
    Description copied from interface: IMaterial
    
    Get the name of this material.
    
    Specified by:
    
    getName in interface IMaterial
    
    Returns:
    The name of the material.
  - 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 in g/cm2.
  - getRadiationLength
```
public double getRadiationLength()
```
    Description copied from interface: IMaterial
    
    Get the radiation length in g/cm2.
    
    Specified by:
    
    getRadiationLength in interface IMaterial
    
    Returns:
    The radiation length in g/cm2.
  - getState
```
public IMaterial.State 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.
  - getZ
```
public double getZ()
```
    Description copied from interface: IMaterial
    
    Get the atomic mass of this material.
    
    Specified by:
    
    getZ in interface IMaterial
    
    Returns:
    The atomic mass.
  - getEffectiveNumberOfNucleons
```
public double getEffectiveNumberOfNucleons()
```
  - getMoliereRadius
```
public double getMoliereRadius()
```
    Description copied from interface: IMaterial
    
    Get the Moliere radius in cm.
    
    Specified by:
    
    getMoliereRadius in interface IMaterial
    
    Returns:
    The moliere radius in cm.
  - getNuclearInteractionLengthWithDensity
```
public double getNuclearInteractionLengthWithDensity()
```
    Description copied from interface: IMaterial
    
    Get the nuclear interaction length in g/cm2.
    
    Specified by:
    
    getNuclearInteractionLengthWithDensity in interface IMaterial
    
    Returns:
    The nuclear interaction length in cm.
  - getRadiationLengthWithDensity
```
public double getRadiationLengthWithDensity()
```
    Description copied from interface: IMaterial
    
    Get the radiation length in cm.
    
    Specified by:
    
    getRadiationLengthWithDensity in interface IMaterial
    
    Returns:
    The radiation length in cm.
  - computeRadiationLengthTsai
```
public static double computeRadiationLengthTsai(double A,
                                double Z)
```
  - computeNuclearInteractionLength
```
public static double computeNuclearInteractionLength(double A,
                                     double Z)
```
  - 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.
  - 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MaterialElement

Nested Class Summary

Nested classes/interfaces inherited from interface org.lcsim.detector.material.IMaterial

Field Summary

Fields inherited from interface org.lcsim.detector.material.IMaterial

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

Z

A

density

temperature

pressure

state

N

nuclearInteractionLength

nuclearInteractionLengthWithDensity

radiationLength

radiationLengthWithDensity

criticalEnergy

moliereRadius

Constructor Detail

MaterialElement

MaterialElement

MaterialElement

Method Detail

computeDerivedQuantities

computeCriticalEnergy

computeMoliereRadius

computeRadiationLength

computeNuclearInteractionLength

getA

getDensity

getName

getNuclearInteractionLength

getRadiationLength

getState

getZ

getEffectiveNumberOfNucleons

getMoliereRadius

getNuclearInteractionLengthWithDensity

getRadiationLengthWithDensity

computeRadiationLengthTsai

computeNuclearInteractionLength

getTemperature

getPressure

toString