public class SFRPin extends SFRComponent
Class representing the SFR pin structure. The pin is the basic unit of the FuelAssembly and ControlAssembly lattice, and contains either fissile, fertile or absorber pellets, in addition to structural features above and below the pellet columns.
iComponentVisitor
iComponentListener
Constructor and Description |
---|
SFRPin()
Nullary constructor.
|
SFRPin(java.lang.String name)
Parameterized constructor with the name specified.
|
SFRPin(java.lang.String name,
Ring cladding,
Material fillGas,
java.util.TreeSet<MaterialBlock> materialBlocks)
Parameterized constructor specified pin name, location, fill gas and
material blocks (if any) specified.
|
Modifier and Type | Method and Description |
---|---|
void |
accept(ISFRComponentVisitor visitor)
Overrides the default behavior (ignore) from SFRComponent and implements
the accept operation for this SFRComponent's type.
|
java.lang.Object |
clone()
Deep copies and returns a newly instantiated object.
|
void |
copy(SFRPin otherObject)
Deep copies the contents of the object.
|
boolean |
equals(java.lang.Object otherObject)
Compares the contents of objects and returns true if that are identical.
|
Ring |
getCladding()
Returns the SFRPin's cladding as a Ring.
|
Material |
getFillGas()
Returns the type of fill gas present inside the pellet-stack gap (space
between pellet stack and cladding) and gas plenum(s).
|
java.util.TreeSet<MaterialBlock> |
getMaterialBlocks()
Returns a collection of material blocks within the SFRPin.
|
int |
hashCode()
Returns the hashcode of the object.
|
void |
setCladding(Ring cladding)
Sets the SFRPin cladding as a Ring.
|
void |
setFillGas(Material gas)
Sets the type of gas present inside the pellet-clad (space between pellet
stack and cladding) gap and gas plenum(s).
|
void |
setMaterialBlocks(java.util.TreeSet<MaterialBlock> materialBlocks)
Sets a collection of material blocks within the SFRPin.
|
accept, addData, copy, getCurrentTime, getDataAtCurrentTime, getDescription, getFeatureList, getFeaturesAtCurrentTime, getId, getName, getNumberOfTimeSteps, getSourceInfo, getTimes, getTimeStep, getTimeUnits, notifyListeners, register, removeDataFromFeature, setDescription, setId, setName, setSourceInfo, setTime, setTimeUnits, toString, unregister, update
public SFRPin()
Nullary constructor.
public SFRPin(java.lang.String name)
Parameterized constructor with the name specified.
name
- Name of the pin.public SFRPin(java.lang.String name, Ring cladding, Material fillGas, java.util.TreeSet<MaterialBlock> materialBlocks)
Parameterized constructor specified pin name, location, fill gas and material blocks (if any) specified.
name
- Name of the pin.cladding
- The pin's cladding.fillGas
- The pin's filler gas.materialBlocks
- A TreeSet of the pin's material blocks.public void setFillGas(Material gas)
Sets the type of gas present inside the pellet-clad (space between pellet stack and cladding) gap and gas plenum(s).
gas
- The pin's filler gas. Cannot be null.public Material getFillGas()
Returns the type of fill gas present inside the pellet-stack gap (space between pellet stack and cladding) and gas plenum(s).
public void setMaterialBlocks(java.util.TreeSet<MaterialBlock> materialBlocks)
Sets a collection of material blocks within the SFRPin.
materialBlocks
- A TreeSet of material blocks contained in the pin. Cannot be
null or empty.public java.util.TreeSet<MaterialBlock> getMaterialBlocks()
Returns a collection of material blocks within the SFRPin.
public void setCladding(Ring cladding)
Sets the SFRPin cladding as a Ring.
cladding
- The pin's cladding. Cannot be null.public Ring getCladding()
Returns the SFRPin's cladding as a Ring.
public int hashCode()
Returns the hashcode of the object.
hashCode
in interface Identifiable
hashCode
in class SFRComponent
Identifiable.hashCode()
public boolean equals(java.lang.Object otherObject)
Compares the contents of objects and returns true if that are identical.
equals
in interface Identifiable
equals
in class SFRComponent
otherObject
- The other object being compared against.Identifiable.equals(Object otherObject)
public void copy(SFRPin otherObject)
Deep copies the contents of the object.
otherObject
- The other object to copy the contents of.public java.lang.Object clone()
Deep copies and returns a newly instantiated object.
clone
in interface Identifiable
clone
in class SFRComponent
public void accept(ISFRComponentVisitor visitor)
accept
in class SFRComponent
visitor
- An ISFRComponentVisitor that is visiting this SFRComponent.