diff options
author | couriersud <couriersud@gmx.org> | 2020-07-25 14:44:40 +0200 |
---|---|---|
committer | couriersud <couriersud@gmx.org> | 2020-07-25 14:47:21 +0200 |
commit | 016c636bb38824031082b100e667596508822cdd (patch) | |
tree | e9c4a1c03beecb5f5451ea66892d3afcc69abe31 | |
parent | bf92a80177908e9ee2d49e54cf855a17ed40fb48 (diff) |
netlist: add frontier documentation
-rw-r--r-- | src/lib/netlist/devices/nlid_system.h | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/src/lib/netlist/devices/nlid_system.h b/src/lib/netlist/devices/nlid_system.h index 2a03a6c4289..b3bc9c6434e 100644 --- a/src/lib/netlist/devices/nlid_system.h +++ b/src/lib/netlist/devices/nlid_system.h @@ -349,6 +349,59 @@ namespace devices // nld_frontier // ----------------------------------------------------------------------------- + + /// \brief Frontiers divides a netlist into sub netlist + /// + /// Example: + /// + /// Consider the following mixing stage + /// + /// R1 + /// S1 >-----1RRRR2---------+ + /// | + /// R2 | + /// S2 >-----1RRRR2---------+----------> Out + /// | + /// R + /// R3 R + /// R + /// | + /// GND + /// + /// With OPTIMIZE_FRONTIER(R2.2, R3, R2) this becomes: + /// + /// R1 + /// S1 >-----1RRRR2--------------------------------+ + /// | + /// ########################## | + /// R2 # R2 # | + /// S2 >-----1RRRR2-----+-->AnIn AnOut>--RRRR------+----------> Out + /// # | # | + /// # R # R + /// # R R3 # R3 R + /// # R # R + /// # | # | + /// # GND Frontier # GND + /// # # + /// ########################## + /// + /// As a result, provided there are no other connections between the parts + /// generating S1 and S2 the "S2 part" will now have a separate solver. + /// + /// The size (aka number of nets) of the solver for S1 will be smaller. + /// The size of the solver for S2 and the rest of the circuit will be smaller + /// as well. + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + NETLIB_OBJECT(frontier) { public: |