netlist: add frontier documentation

This commit is contained in:
couriersud 2020-07-25 14:44:40 +02:00
parent bf92a80177
commit 016c636bb3

View File

@ -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: