SATRouter

Object
- com.xilinx.rapidwright.router.SATRouter

```
public class SATRouter
extends Object
```
This class provides a RapidWright front-end usage wrapper for the Vivado-distributed executable evRouter. evRouter is a SAT Solver wrapped with special capabilities of casting place and route problems as SAT problems.

Field Summary

Fields
Modifier and Type Field and Description

static String EV_ROUTER

long SEED

Fields
Modifier and Type	Field and Description
`static String`	`EV_ROUTER`
`long`	`SEED`

Constructor Summary

Constructors
Constructor and Description
`SATRouter(Design design, PBlock pblock)` Initialize the SAT router with a design and area constraint (pblock) to describe the routing problem.
`SATRouter(Design design, PBlock pblock, boolean unroute)` Initialize the SAT router with a design and area constraint (pblock) to describe the routing problem.
`SATRouter(Design design, PBlock pblock, Collection<Net> netsToRoute)` Initializes the SAT router with a design, area constraint (pblock) and list of nets to route.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyRoutingResult()` Reads the output of evRouter and applies the routing solution to the existing design.
`void`	`createNetsFiles()`
`void`	`createPipFile()` Creates the necessary routing resource graph file to supply evRouter for routing.
`Integer`	`getChipID()`
`String`	`getCstFile()`
`int`	`getDelaysPerSink()`
`Design`	`getDesign()`
`String`	`getDottyFile()`
`String`	`getEdgeGroupsFile()`
`HashSet<Node>`	`getExcludedNodes()`
`Integer`	`getLocalID()`
`Integer`	`getMaxConflicts()`
`Integer`	`getMaxPasses()`
`String`	`getNetGroupsFile()`
`Collection<Net>`	`getNetsToRoute()`
`String`	`getOutputFile()`
`String`	`getPbFile()`
`PBlock`	`getPblock()`
`String`	`getPipFile()`
`String`	`getRegFile()`
`Integer`	`getRegionID()`
`String`	`getVcNetAssignmentFile()`
`int`	`getVerbosity()`
`boolean`	`isOptRouteUtilization()`
`boolean`	`isPartitionGraph()`
`static void`	`randomizeLines(String inputFileName, String outputFileName, long seed)`
`void`	`route()` Runs the SAT solver to route the current design and problem configuration.
`int`	`runEvRouter()` Executes evRouter outside of the RapidWright runtime.
`void`	`setChipID(Integer chipID)`
`void`	`setCstFile(String cstFile)`
`void`	`setDelaysPerSink(int delaysPerSink)`
`void`	`setDesign(Design design)`
`void`	`setDottyFile(String dottyFile)`
`void`	`setEdgeGroupsFile(String edgeGroupsFile)`
`void`	`setExcludedNodes(HashSet<Node> excludedNodes)`
`void`	`setLocalID(Integer localID)`
`void`	`setMaxConflicts(Integer maxConflicts)`
`void`	`setMaxPasses(Integer maxPasses)`
`void`	`setNetGroupsFile(String netGroupsFile)`
`void`	`setNetsToRoute(Collection<Net> netsToRoute)`
`void`	`setOptRouteUtilization(boolean optRouteUtilization)`
`void`	`setOutputFile(String outputFile)`
`void`	`setPartitionGraph(boolean partitionGraph)`
`void`	`setPbFile(String pbFile)`
`void`	`setPblock(PBlock pblock)`
`void`	`setPipFile(String pipFile)`
`void`	`setRegFile(String regFile)`
`void`	`setRegionID(Integer regionID)`
`void`	`setUseWeightsOnNodes(boolean useWeightsOnNodes)`
`void`	`setVcNetAssignmentFile(String vcNetAssignmentFile)`
`void`	`setVerbosity(int verbosity)`
`void`	`updateSitePinInsts()`
`boolean`	`usingWeightsOnNodes()`

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EV_ROUTER
```
public static final String EV_ROUTER
```
    See Also:
    
    Constant Field Values
  - SEED
```
public long SEED
```
- Constructor Detail
  - SATRouter
```
public SATRouter(Design design,
                 PBlock pblock)
```
    Initialize the SAT router with a design and area constraint (pblock) to describe the routing problem.
    
    Parameters:
    
    design - A placed design to route
    
    pblock - The area to use to identify nets to route and to supply routing nodes for completing the routes. All nets that have all endpoints physically located inside the pblock will be included in the route attempt.
  - SATRouter
```
public SATRouter(Design design,
                 PBlock pblock,
                 boolean unroute)
```
    Initialize the SAT router with a design and area constraint (pblock) to describe the routing problem.
    
    Parameters:
    
    design - A placed design to route
    
    pblock - The area to use to identify nets to route and to supply routing nodes for completing the routes. All nets that have all endpoints physically located inside the pblock will be included in the route attempt.
    
    unroute - Unroutes the design before using the SAT solver (by default, always unroutes)
  - SATRouter
```
public SATRouter(Design design,
                 PBlock pblock,
                 Collection<Net> netsToRoute)
```
    Initializes the SAT router with a design, area constraint (pblock) and list of nets to route.
    
    Parameters:
    
    design - A placed design to route
    
    pblock - The area to be used for routing the nets
    
    netsToRoute - List of nets to be routed, their physical endpoints must be located within the pblock.
- Method Detail
  - updateSitePinInsts
```
public void updateSitePinInsts()
```
  - createPipFile
```
public void createPipFile()
```
    Creates the necessary routing resource graph file to supply evRouter for routing.
  - randomizeLines
```
public static void randomizeLines(String inputFileName,
                                  String outputFileName,
                                  long seed)
```
  - createNetsFiles
```
public void createNetsFiles()
```
  - runEvRouter
```
public int runEvRouter()
```
    Executes evRouter outside of the RapidWright runtime. Applies all configured settings.
    
    Returns:
    
    The exit code of the evRouter execution.
  - applyRoutingResult
```
public void applyRoutingResult()
```
    Reads the output of evRouter and applies the routing solution to the existing design. Manages LUT pin input swapping as a result of the routing solution taking advantage of the LUT input flexibility.
  - route
```
public void route()
```
    Runs the SAT solver to route the current design and problem configuration. By default, it will route the nets that are fully enclosed by the provided pblock.
  - getVerbosity
```
public int getVerbosity()
```
    Returns:
    
    the verbosity
  - setVerbosity
```
public void setVerbosity(int verbosity)
```
    Parameters:
    
    verbosity - the verbosity to set
  - getMaxConflicts
```
public Integer getMaxConflicts()
```
    Returns:
    
    the maxConflicts
  - setMaxConflicts
```
public void setMaxConflicts(Integer maxConflicts)
```
    Parameters:
    
    maxConflicts - the maxConflicts to set
  - getMaxPasses
```
public Integer getMaxPasses()
```
    Returns:
    
    the maxPasses
  - setMaxPasses
```
public void setMaxPasses(Integer maxPasses)
```
    Parameters:
    
    maxPasses - the maxPasses to set
  - getOutputFile
```
public String getOutputFile()
```
    Returns:
    
    the outputFile
  - setOutputFile
```
public void setOutputFile(String outputFile)
```
    Parameters:
    
    outputFile - the outputFile to set
  - getDelaysPerSink
```
public int getDelaysPerSink()
```
    Returns:
    
    the delaysPerSink
  - setDelaysPerSink
```
public void setDelaysPerSink(int delaysPerSink)
```
    Parameters:
    
    delaysPerSink - the delaysPerSink to set
  - getDottyFile
```
public String getDottyFile()
```
    Returns:
    
    the dottyFile
  - setDottyFile
```
public void setDottyFile(String dottyFile)
```
    Parameters:
    
    dottyFile - the dottyFile to set
  - getCstFile
```
public String getCstFile()
```
    Returns:
    
    the cstFile
  - setCstFile
```
public void setCstFile(String cstFile)
```
    Parameters:
    
    cstFile - the cstFile to set
  - getRegFile
```
public String getRegFile()
```
    Returns:
    
    the regFile
  - setRegFile
```
public void setRegFile(String regFile)
```
    Parameters:
    
    regFile - the regFile to set
  - getChipID
```
public Integer getChipID()
```
    Returns:
    
    the chipID
  - setChipID
```
public void setChipID(Integer chipID)
```
    Parameters:
    
    chipID - the chipID to set
  - getRegionID
```
public Integer getRegionID()
```
    Returns:
    
    the regionID
  - setRegionID
```
public void setRegionID(Integer regionID)
```
    Parameters:
    
    regionID - the regionID to set
  - getLocalID
```
public Integer getLocalID()
```
    Returns:
    
    the localID
  - setLocalID
```
public void setLocalID(Integer localID)
```
    Parameters:
    
    localID - the localID to set
  - getEdgeGroupsFile
```
public String getEdgeGroupsFile()
```
    Returns:
    
    the edgeGroupsFile
  - setEdgeGroupsFile
```
public void setEdgeGroupsFile(String edgeGroupsFile)
```
    Parameters:
    
    edgeGroupsFile - the edgeGroupsFile to set
  - getNetGroupsFile
```
public String getNetGroupsFile()
```
    Returns:
    
    the netGroupsFile
  - setNetGroupsFile
```
public void setNetGroupsFile(String netGroupsFile)
```
    Parameters:
    
    netGroupsFile - the netGroupsFile to set
  - getVcNetAssignmentFile
```
public String getVcNetAssignmentFile()
```
    Returns:
    
    the vcNetAssignmentFile
  - setVcNetAssignmentFile
```
public void setVcNetAssignmentFile(String vcNetAssignmentFile)
```
    Parameters:
    
    vcNetAssignmentFile - the vcNetAssignmentFile to set
  - isOptRouteUtilization
```
public boolean isOptRouteUtilization()
```
    Returns:
    
    the optRouteUtilization
  - setOptRouteUtilization
```
public void setOptRouteUtilization(boolean optRouteUtilization)
```
    Parameters:
    
    optRouteUtilization - the optRouteUtilization to set
  - isPartitionGraph
```
public boolean isPartitionGraph()
```
    Returns:
    
    the partitionGraph
  - setPartitionGraph
```
public void setPartitionGraph(boolean partitionGraph)
```
    Parameters:
    
    partitionGraph - the partitionGraph to set
  - getPipFile
```
public String getPipFile()
```
    Returns:
    
    the pipFile
  - setPipFile
```
public void setPipFile(String pipFile)
```
    Parameters:
    
    pipFile - the pipFile to set
  - getPbFile
```
public String getPbFile()
```
    Returns:
    
    the pbFile
  - setPbFile
```
public void setPbFile(String pbFile)
```
    Parameters:
    
    pbFile - the pbFile to set
  - getDesign
```
public Design getDesign()
```
    Returns:
    
    the design
  - setDesign
```
public void setDesign(Design design)
```
    Parameters:
    
    design - the design to set
  - getPblock
```
public PBlock getPblock()
```
    Returns:
    
    the pblock
  - setPblock
```
public void setPblock(PBlock pblock)
```
    Parameters:
    
    pblock - the pblock to set
  - getNetsToRoute
```
public Collection<Net> getNetsToRoute()
```
    Returns:
    
    the netsToRoute
  - setNetsToRoute
```
public void setNetsToRoute(Collection<Net> netsToRoute)
```
    Parameters:
    
    netsToRoute - the netsToRoute to set
  - getExcludedNodes
```
public HashSet<Node> getExcludedNodes()
```
    Returns:
    
    the excludedNodes
  - setExcludedNodes
```
public void setExcludedNodes(HashSet<Node> excludedNodes)
```
    Parameters:
    
    excludedNodes - the excludedNodes to set
  - usingWeightsOnNodes
```
public boolean usingWeightsOnNodes()
```
    Returns:
    
    the useWeightsOnNodes
  - setUseWeightsOnNodes
```
public void setUseWeightsOnNodes(boolean useWeightsOnNodes)
```
    Parameters:
    
    useWeightsOnNodes - the useWeightsOnNodes to set

Class SATRouter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

EV_ROUTER

SEED

Constructor Detail

SATRouter

SATRouter

SATRouter

Method Detail

updateSitePinInsts

createPipFile

randomizeLines

createNetsFiles

runEvRouter

applyRoutingResult

route

getVerbosity

setVerbosity

getMaxConflicts

setMaxConflicts

getMaxPasses

setMaxPasses

getOutputFile

setOutputFile

getDelaysPerSink

setDelaysPerSink

getDottyFile

setDottyFile

getCstFile

setCstFile

getRegFile

setRegFile

getChipID

setChipID

getRegionID

setRegionID

getLocalID

setLocalID

getEdgeGroupsFile

setEdgeGroupsFile

getNetGroupsFile

setNetGroupsFile

getVcNetAssignmentFile

setVcNetAssignmentFile

isOptRouteUtilization

setOptRouteUtilization

isPartitionGraph

setPartitionGraph

getPipFile

setPipFile

getPbFile

setPbFile

getDesign

setDesign

getPblock

setPblock

getNetsToRoute

setNetsToRoute

getExcludedNodes

setExcludedNodes

usingWeightsOnNodes

setUseWeightsOnNodes