View Javadoc

1   
2   package org.catacomb.numeric.difnet;
3   
4   
5   
6   /** properties of a network on which a diffusion eqution can be solved.
7    * including isolated branched neurons, cell-bath-pipette systems,
8    * or gap junction networks.
9    *
10   * The properties object contains the geometry of the network, and can
11   * make multiple networks withthis geometry with its newDiffusiveNet
12   * method. For each node in the netowork there is a corresponding
13   * NodeProperties object here. Structural information belongs in the
14   * NodeProperties objects. State information goes in the Nodes
15   * themselves.
16   *
17   * The diffusion calculation is performed by a NetDiffuser operating on a
18   * DiffusiveNet, and calling the get.. and set.. methods in its nodes
19   * and links.
20   */
21  
22  
23  public interface NetStructure {
24  
25  
26      /** gets the properties of the nodes in the network which take part
27       * in the diffusion process.
28       */
29      StructureNode[] getNodes();
30  
31      /** gets the properties of the links in the network which take part
32       *  in the diffusion calculation.
33       */
34      StructureLink[] getLinks();
35  
36  
37      NetState newState();
38  
39  }