org.catacomb.numeric.difnet

Interface StructureNode

All Known Implementing Classes:

BasicStructureNode

public interface StructureNode

properties of a node in a diffusible network. The corresponding node may containing multiple diffusible quantities, in which case the dq argument specifiew which to consult. NB, as yet dq is unsupported MISSING hasFixedValue should return true for nodes whosse value can't be changed, like an isopotential bath. In this case setValue does nothing and the result of getCapacitance is undefined. Such odes are important in a DiffusibleNet to break loops and take advantage of sparse matrix methods in computing the diffusion.

Method Summary

Methods

Modifier and Type	Method and Description
int	getWork() retrieves the previously set work integer.
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	setPosition(double x, double y, double z)
void	setRadius(double r)
void	setWork(int i) Stores an integer for later retrieval.

Method Detail

hasFixedValue

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.

Returns:

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

setPosition

void setPosition(double x,
               double y,
               double z)

setRadius

void setRadius(double r)

setWork

void setWork(int i)

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.

getWork

int getWork()

retrieves the previously set work integer.

Returns:

the stored integer