AbstractKmc (Morphokinetics)

java.lang.Object
- kineticMonteCarlo.kmcCore.AbstractKmc

All Implemented Interfaces:

IKmc

Direct Known Subclasses:

AbstractGrowthKmc, BasicKmc, SiKmc
```
public abstract class AbstractKmc
extends java.lang.Object
implements IKmc
```
Author:

N. Ferrando, J. Alberdi-Rodriguez, E. Sanchez

Field Summary

Fields
Modifier and Type Field and Description

private int iterationsForLastSimulation

private AbstractLattice lattice

private AbstractList list

Fields
Modifier and Type	Field and Description
`private int`	`iterationsForLastSimulation`
`private AbstractLattice`	`lattice`
`private AbstractList`	`list`

Constructor Summary

Constructors
Constructor and Description

AbstractKmc(Parser parser)

Constructors
Constructor and Description
`AbstractKmc(Parser parser)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`getCoverage()` Coverage is not defined in the etching.
`int`	`getCurrentRadius()` It only makes sence in `AbstractGrowthKmc.getCurrentRadius()`.
`int`	`getIterations()`
`AbstractLattice`	`getLattice()`
`AbstractList`	`getList()`
`double`	`getTime()`
`abstract void`	`initialiseRates(double[] rates)` Initialises the rates of the simulation.
`protected abstract boolean`	`performSimulationStep()` Performs a simulation step.
`void`	`reset()` Resets the lattice and the list of atoms.
`void`	`setDepositionRate(double depositionRatePerSite, double islandDensity)`
`void`	`setIterations(int iterations)`
`void`	`setLattice(AbstractLattice lattice)`
`int`	`simulate()` Does the actual simulation.
`void`	`simulate(double endtime)` Does the actual simulation.
`int`	`simulate(int iterations)` Does the actual simulation.

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

Methods inherited from interface kineticMonteCarlo.kmcCore.IKmc
depositSeed, getHexagonalPeriodicSurface, getSampledSurface

- Field Detail
  - list
```
private final AbstractList list
```
  - lattice
```
private AbstractLattice lattice
```
  - iterationsForLastSimulation
```
private int iterationsForLastSimulation
```
- Constructor Detail
  - AbstractKmc
```
public AbstractKmc(Parser parser)
```
- Method Detail
  - getIterations
```
public int getIterations()
```
    Specified by:
    
    getIterations in interface IKmc
  - setIterations
```
public void setIterations(int iterations)
```
  - getTime
```
public double getTime()
```
    Specified by:
    
    getTime in interface IKmc
  - setDepositionRate
```
public void setDepositionRate(double depositionRatePerSite,
                              double islandDensity)
```
    Specified by:
    
    setDepositionRate in interface IKmc
  - getCoverage
```
public float getCoverage()
```
    Coverage is not defined in the etching. So, by default is not defined and returns -1.
    
    Returns:
    
    -1 always
  - getLattice
```
public AbstractLattice getLattice()
```
    Specified by:
    
    getLattice in interface IKmc
    
    Returns:
    
    the lattice
  - setLattice
```
public final void setLattice(AbstractLattice lattice)
```
    Parameters:
    
    lattice - the lattice to set
  - getList
```
public final AbstractList getList()
```
    Specified by:
    
    getList in interface IKmc
    
    Returns:
    
    the list
  - getCurrentRadius
```
public int getCurrentRadius()
```
    It only makes sence in AbstractGrowthKmc.getCurrentRadius(). Used to have a common interface
    
    Returns:
    
    nothing meaningful
  - simulate
```
public int simulate()
```
    Does the actual simulation. It has to be called after reset() and depositSeed().
    
    Specified by:
    
    simulate in interface IKmc
    
    Returns:
    
    number of iterations that simulation took
  - simulate
```
public void simulate(double endtime)
```
    Does the actual simulation. It has to be called after reset() and depositSeed().
    
    Specified by:
    
    simulate in interface IKmc
    
    Parameters:
    
    endtime -
  - simulate
```
public int simulate(int iterations)
```
    Does the actual simulation. It has to be called after reset() and depositSeed().
    
    Specified by:
    
    simulate in interface IKmc
    
    Parameters:
    
    iterations -
    
    Returns:
    
    number of iterations that simulation took
  - initialiseRates
```
public abstract void initialiseRates(double[] rates)
```
    Initialises the rates of the simulation. It has to be called once, and only once (not within a loop.
    
    Specified by:
    
    initialiseRates in interface IKmc
    
    Parameters:
    
    rates -
  - reset
```
public void reset()
```
    Resets the lattice and the list of atoms. This method has to be called just before depositSeed() and simulate().
    
    Specified by:
    
    reset in interface IKmc
  - performSimulationStep
```
protected abstract boolean performSimulationStep()
```
    Performs a simulation step.
    
    Returns:
    
    true if a stop condition happened (all atom etched, all surface covered)

Class AbstractKmc

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface kineticMonteCarlo.kmcCore.IKmc

Field Detail

list

lattice

iterationsForLastSimulation

Constructor Detail

AbstractKmc

Method Detail

getIterations

setIterations

getTime

setDepositionRate

getCoverage

getLattice

setLattice

getList

getCurrentRadius

simulate

simulate

simulate

initialiseRates

reset

performSimulationStep