Material

java.lang.Object
- starfish.core.materials.Material

Direct Known Subclasses:

FluidElectronsMaterial, FluidMaterial, KineticMaterial, SolidMaterial
```
public abstract class Material
extends java.lang.Object
```
Basic definition of a material

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Material.InitVals

static class Material.InteractionList

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Material.InitVals`
`static class`	`Material.InteractionList`

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`charge`
`double`	`density`
`protected FieldCollection1D`	`depflux_collection`
`protected FieldCollection1D`	`deprate_collection`
`double`	`diam`
`protected FieldManager1D`	`field_manager1d`
`protected FieldManager2D`	`field_manager2d`
`protected FieldCollection1D`	`flux_collection`
`protected FieldCollection1D`	`flux_normal_collection`
`boolean`	`frozen`
`double`	`mass`
`int`	`mat_index`
`java.lang.String`	`name`
`double`	`q_over_m`
`double`	`ref_temp`
`Material.InteractionList`	`source_interactions` list of interactions that affect the source particle: diffuse, absorb, etc..
`Material.InteractionList`	`target_interactions` list of interactions that affect the target material: sputtering, secondary electrons, etc...
`protected double`	`total_momentum`
`double`	`visc_temp_index`
`double`	`vss_alpha`

Constructor Summary

Constructors
Constructor and Description
`Material(java.lang.String name, double mass)`
`Material(java.lang.String name, double mass, double charge, boolean frozen)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`getCharge()`
`Field2D`	`getDen(Mesh mesh)`
`Field2D`	`getDenAve(Mesh mesh)`
`FieldCollection2D`	`getDenAveCollection()`
`FieldCollection2D`	`getDenCollection()`
`double`	`getDensity()`
`FieldManager1D`	`getFieldManager1d()`
`FieldManager2D`	`getFieldManager2d()`
`int`	`getIndex()`
`double`	`getMass()`
`java.lang.String`	`getName()`
`Field2D`	`getP(Mesh mesh)`
`FieldCollection2D`	`getPressureCollection()`
`Field2D`	`getT(Mesh mesh)`
`FieldCollection2D`	`getTempCollection()`
`double`	`getTotalMomentum()`
`Field2D`	`getU(Mesh mesh)`
`Field2D`	`getUAve(Mesh mesh)`
`FieldCollection2D`	`getUAveCollection()`
`FieldCollection2D`	`getUCollection()`
`Field2D`	`getV(Mesh mesh)`
`Field2D`	`getVAve(Mesh mesh)`
`FieldCollection2D`	`getVAveCollection()`
`FieldCollection2D`	`getVCollection()`
`Field2D`	`getW(Mesh mesh)`
`Field2D`	`getWAve(Mesh mesh)`
`FieldCollection2D`	`getWAveCollection()`
`FieldCollection2D`	`getWCollection()`
`void`	`init()` sets background density
`void`	`loadRestartData(java.io.DataInputStream in)`
`double[]`	`sampleMaxwellianVelocity(Mesh mesh, double[] lc, double T_min)`
`double[]`	`sampleVelocity(Mesh mesh, double[] lc)`
`void`	`saveRestartData(java.io.DataOutputStream out)`
`void`	`setInitValues(java.lang.String[] init_strings)`
`void`	`update()` updates density and/or other fields
`void`	`updateBoundaries()`
`abstract void`	`updateFields()` must be overriden by non-static materials

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

Field Detail

mat_index
```
public int mat_index
```

mass
```
public double mass
```

density
```
public double density
```

charge
```
public double charge
```

q_over_m
```
public double q_over_m
```

diam
```
public double diam
```

ref_temp
```
public double ref_temp
```

visc_temp_index
```
public double visc_temp_index
```

vss_alpha
```
public double vss_alpha
```

name
```
public java.lang.String name
```

frozen
```
public boolean frozen
```

field_manager2d

protected FieldManager2D field_manager2d

field_manager1d

protected FieldManager1D field_manager1d

flux_collection

protected FieldCollection1D flux_collection

flux_normal_collection

protected FieldCollection1D flux_normal_collection

deprate_collection

protected FieldCollection1D deprate_collection

depflux_collection

protected FieldCollection1D depflux_collection

total_momentum
```
protected double total_momentum
```

source_interactions
```
public Material.InteractionList source_interactions
```
list of interactions that affect the source particle: diffuse, absorb, etc..

target_interactions
```
public Material.InteractionList target_interactions
```
list of interactions that affect the target material: sputtering, secondary electrons, etc...

Constructor Detail

Material

public Material(java.lang.String name,
                double mass)

Parameters:: name -; mass -

Material

public Material(java.lang.String name,
                double mass,
                double charge,
                boolean frozen)

Parameters:: name -; mass -; charge -; frozen -

Method Detail

getName
```
public java.lang.String getName()
```
Returns:

getFieldManager2d

public FieldManager2D getFieldManager2d()

Returns:

getFieldManager1d

public FieldManager1D getFieldManager1d()

Returns:

getIndex
```
public int getIndex()
```
Returns:

getMass
```
public double getMass()
```
Returns:

getDensity
```
public double getDensity()
```
Returns:

getTotalMomentum
```
public double getTotalMomentum()
```
Returns:

getDenCollection

public FieldCollection2D getDenCollection()

Returns:

getDenAveCollection

public FieldCollection2D getDenAveCollection()

Returns:

getUCollection

public FieldCollection2D getUCollection()

Returns:

getVCollection

public FieldCollection2D getVCollection()

Returns:

getWCollection

public FieldCollection2D getWCollection()

Returns:

getUAveCollection

public FieldCollection2D getUAveCollection()

Returns:

getVAveCollection

public FieldCollection2D getVAveCollection()

Returns:

getWAveCollection

public FieldCollection2D getWAveCollection()

Returns:

getTempCollection

public FieldCollection2D getTempCollection()

Returns:

getPressureCollection

public FieldCollection2D getPressureCollection()

Returns:

getDen
```
public Field2D getDen(Mesh mesh)
```
Parameters:

mesh -

Returns:

getDenAve
```
public Field2D getDenAve(Mesh mesh)
```
Parameters:

mesh -

Returns:

getU
```
public Field2D getU(Mesh mesh)
```
Parameters:

mesh -

Returns:

getV
```
public Field2D getV(Mesh mesh)
```
Parameters:

mesh -

Returns:

getW
```
public Field2D getW(Mesh mesh)
```
Parameters:

mesh -

Returns:

getUAve
```
public Field2D getUAve(Mesh mesh)
```
Parameters:

mesh -

Returns:

getVAve
```
public Field2D getVAve(Mesh mesh)
```
Parameters:

mesh -

Returns:

getWAve
```
public Field2D getWAve(Mesh mesh)
```
Parameters:

mesh -

Returns:

getT
```
public Field2D getT(Mesh mesh)
```
Parameters:

mesh -

Returns:

getP
```
public Field2D getP(Mesh mesh)
```
Parameters:

mesh -

Returns:

getCharge
```
public double getCharge()
```
Returns:

setInitValues

public void setInitValues(java.lang.String[] init_strings)

Parameters:: init_strings -

update
```
public void update()
```
updates density and/or other fields

updateFields
```
public abstract void updateFields()
```
must be overriden by non-static materials

updateBoundaries
```
public void updateBoundaries()
```

saveRestartData

public void saveRestartData(java.io.DataOutputStream out)
                     throws java.io.IOException

Parameters:: out -
Throws:: java.io.IOException

loadRestartData

public void loadRestartData(java.io.DataInputStream in)
                     throws java.io.IOException

Parameters:: in -
Throws:: java.io.IOException

init
```
public void init()
```
sets background density

sampleVelocity

public double[] sampleVelocity(Mesh mesh,
                               double[] lc)

Parameters:: mesh -; lc -
Returns:

sampleMaxwellianVelocity

public double[] sampleMaxwellianVelocity(Mesh mesh,
                                         double[] lc,
                                         double T_min)

Parameters:: mesh -; lc -; T_min -
Returns:

Class Material

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

mat_index

mass

density

charge

q_over_m

diam

ref_temp

visc_temp_index

vss_alpha

name

frozen

field_manager2d

field_manager1d

flux_collection

flux_normal_collection

deprate_collection

depflux_collection

total_momentum

source_interactions

target_interactions

Constructor Detail

Material

Material

Method Detail

getName

getFieldManager2d

getFieldManager1d

getIndex

getMass

getDensity

getTotalMomentum

getDenCollection

getDenAveCollection

getUCollection

getVCollection

getWCollection

getUAveCollection

getVAveCollection

getWAveCollection

getTempCollection

getPressureCollection

getDen

getDenAve

getU

getV

getW

getUAve

getVAve

getWAve

getT

getP

getCharge

setInitValues

update

updateFields

updateBoundaries

saveRestartData

loadRestartData

init

sampleVelocity

sampleMaxwellianVelocity