org.catacomb.numeric.difnet.model

Class BasicStructureNode

java.lang.Object

org.catacomb.numeric.difnet.model.BasicStructureNode

All Implemented Interfaces:

StructureNode

public class BasicStructureNode
extends java.lang.Object
implements StructureNode

Field Summary

Fields

Modifier and Type	Field and Description
(package private) double	area
(package private) double	capacitance
(package private) boolean	fixed
(package private) double	initialValue
(package private) int	iwork
(package private) double	radius
(package private) double	x
(package private) double	y
(package private) double	z

Constructor Summary

Constructors

Constructor and Description
BasicStructureNode()

Method Summary

Methods

Modifier and Type	Method and Description
double	getArea()
double	getCapacitance()
double	getInitialValue()
(package private) double	getRadius()
int	getWork() retrieves the previously set work integer.
(package private) double	getX()
(package private) double	getY()
(package private) double	getZ()
boolean	hasFixedValue(DiffusibleQuantity dq) returns true only for those nodes whose value is externally fixed, such as the potential or an earthed bath or a perfect voltage clamp.
void	incrementArea(double d)
BasicStateNode	newState()
void	setArea(double d)
void	setFixed(boolean b)
void	setFixedValue(double d)
void	setInitialValue(double d)
void	setPosition(double vx, double vy, double vz)
void	setRadius(double r)
void	setWork(int i) Stores an integer for later retrieval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iwork

int iwork

fixed

boolean fixed

capacitance

double capacitance

area

double area

x

double x

y

double y

z

double z

radius

double radius

initialValue

double initialValue

Constructor Detail

BasicStructureNode

public BasicStructureNode()

Method Detail

newState

public BasicStateNode newState()

setInitialValue

public void setInitialValue(double d)

setFixedValue

public void setFixedValue(double d)

getInitialValue

public double getInitialValue()

setPosition

public void setPosition(double vx,
               double vy,
               double vz)

Specified by:

setPosition in interface StructureNode

setRadius

public void setRadius(double r)

Specified by:

setRadius in interface StructureNode

getX

double getX()

getY

double getY()

getZ

double getZ()

getRadius

double getRadius()

setWork

public void setWork(int i)

Description copied from interface: StructureNode

Stores an integer for later retrieval. This is required so that NetDiffuser implementations can make certain optimisations setting up permutations of the network for computing the diffusion.

Specified by:

setWork in interface StructureNode

getWork

public int getWork()

Description copied from interface: StructureNode

retrieves the previously set work integer.

Specified by:

getWork in interface StructureNode

Returns:

the stored integer

setFixed

public void setFixed(boolean b)

hasFixedValue

public boolean hasFixedValue(DiffusibleQuantity dq)

Description copied from interface: StructureNode

returns true only for those nodes whose value is externally fixed, such as the potential or an earthed bath or a perfect voltage clamp.

Specified by:

hasFixedValue in interface StructureNode

Returns:

true if the node's value for the specified quantity is fixed

getCapacitance

public double getCapacitance()

setArea

public void setArea(double d)

getArea

public double getArea()

incrementArea

public void incrementArea(double d)