Zoltan2 Parameters

This page lists each Zoltan2 parameter and how to use it. The validators are classes of interest to Zoltan2 developers. They are used to evaluate the validity of parameter values at run time.

• algorithm
  • Description: partitioning algorithm
  • Valid values:
    • rcb
    • multijagged
    • rib
    • hsfc
    • patoh
    • phg
    • metis
    • parmetis
    • scotch
    • ptscotch
    • block
    • cyclic
    • random
  • Validator type: Teuchos::StringValidator
• average_cuts
  • Description: When true, coordinates of RCB cutting planes are computed to be the average of the coordinates of the closest object on each side of the cut. Otherwise, coordinates of cutting planes may equal those of one of the closest objects. Default is false.
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• bisection_num_test_cuts
  • Description: Experimental: number of test cuts to do simultaneously (default is 1)
  • Valid values:
    • minimum is 1
    • maximum is 250
    • step is 1
  • Validator type: Teuchos::EnhancedNumberValidator
• compute_metrics
  • Description: Compute metrics after computing solution
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• debug_level
  • Description: the amount of status/debugging/warning information to print
  • Valid values:
    • no_status library outputs no status information
    • basic_status library outputs basic status information (default)
    • detailed_status library outputs detailed information
    • verbose_detailed_status library outputs very detailed information
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• debug_output_file
  • Description: name of file to which debug/status messages should be written (process rank will be included in file name) File need not already exist.
  • Validator type: Teuchos::FileNameValidator
• debug_output_stream
  • Description: output stream for debug/status/warning messages (default cout)
  • Valid values:
    • std::cout
    • cout
    • stdout
    • std::cerr
    • cerr
    • stderr
    • /dev/null
    • null
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• debug_procs
  • Description: list of ranks that output debugging/status messages (default "0")
  • Valid values: a comma-separated list of
    • numbers
    • number ranges separated by a dash ("1-5")
    • the word "all" to indicate all possible values
  • Examples: "1,2,7", "all", "5,1-15,80-82,99"
  • Validator type: Zoltan2::IntegerRangeListValidator (list will be sorted, and duplicates removed, during processing)
• error_check_level
  • Description: the amount of error checking performed (If the compile flag Z2_OMIT_ALL_ERROR_CHECKING was set, then error checking code is not executed at runtime.)
  • Valid values:
    • no_assertions no assertions will be performed
    • basic_assertions typical checks of argument validity (fast, default)
    • complex_assertions additional checks, i.e. is input graph a valid graph)
    • debug_mode_assertions check for everything including logic errors (slowest)
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• force_binary_search
  • Description: If true, then regardless of the part number, cut line will be searched using binary search.
    
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• force_linear_search
  • Description: If true, then regardless of the part number, cut line will be searched using linear search.
    
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• imbalance_tolerance
  • Description: imbalance tolerance, ratio of maximum load over average load (default 1.1)
  • Valid values are any values of type:
    • double
    • int
    • string
  • Validator type: Teuchos::AnyNumberParameterEntryValidator
• memory_output_file
  • Description: name of file to which memory profiling information should be written (process rank will be included in file name) File need not already exist.
  • Validator type: Teuchos::FileNameValidator
• memory_output_stream
  • Description: output stream for memory usage messages (default cout)
  • Valid values:
    • std::cout
    • cout
    • stdout
    • std::cerr
    • cerr
    • stderr
    • /dev/null
    • null
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• memory_procs
  • Description: list of ranks that do memory profiling information (default "0")
  • Valid values: a comma-separated list of
    • numbers
    • number ranges separated by a dash ("1-5")
    • the word "all" to indicate all possible values
  • Examples: "1,2,7", "all", "5,1-15,80-82,99"
  • Validator type: Zoltan2::IntegerRangeListValidator (list will be sorted, and duplicates removed, during processing)
• memory_versus_speed
  • Description: When algorithm choices exist, opt for the use of less memory at the expense of runtime (Default is a balance of memory conservation and speed)
  • Valid values:
    • memory
    • balance
    • speed
  • Validator type: Teuchos::StringValidator
• model
  • Description: This is a low level parameter. Normally the library will choose a computational model based on the algorithm or objective specified by the user.
  • Valid values:
    • hypergraph
    • graph
    • geometry
    • ids
  • Validator type: Teuchos::StringValidator
• num_global_parts
  • Description: global number of parts to compute (default is number of processes)
  • Valid values are any values of type:
    • double
    • int
    • string
  • Validator type: Teuchos::AnyNumberParameterEntryValidator
• num_local_parts
  • Description: number of parts to compute for this process(default is one)
  • Valid values are any values of type:
    • double
    • int
    • string
  • Validator type: Teuchos::AnyNumberParameterEntryValidator
• objects_to_partition
  • Description: Objects to be partitioned (defaults are "matrix_rows" for matrix input, "mesh_nodes" for mesh input, and "graph_vertices" for graph input)
  • Valid values:
    • matrix_rows
    • matrix_columns
    • matrix_nonzeros
    • mesh_elements
    • mesh_nodes
    • graph_edges
    • graph_vertices
    • coordinates
    • identifiers
  • Validator type: Teuchos::StringValidator
• order_method
  • Description: order algorithm
  • Valid values:
    • rcm
    • minimum_degree
    • natural
    • random
  • Validator type: Teuchos::StringValidator
• order_package
  • Description: package to use in ordering
  • Valid values:
    • amd
    • package2
    • package3
  • Validator type: Teuchos::StringValidator
• parallel_part_calculation_count
  • Description: The number of parts whose cut coordinates will be calculated concurently.
  • Valid values are any values of type:
    • int
    • string
  • Validator type: Teuchos::AnyNumberParameterEntryValidator
• partitioning_approach
  • Description: Partition from scratch, partition incrementally from current partition, of partition from scratch but maximize overlap with the current partition (default is "partition" from scratch)
  • Valid values:
    • partition
    • repartition
    • maximize_overlap
  • Validator type: Teuchos::StringValidator
• partitioning_objective
  • Description: objective of partitioning (default depends on algorithm)
  • Valid values:
    • balance_object_count
    • balance_object_weight
    • multicriteria_minimize_total_weight
    • multicriteria_minimize_maximum_weight
    • multicriteria_balance_total_maximum
    • minimize_cut_edge_count
    • minimize_cut_edge_weight
    • minimize_neighboring_parts
    • minimize_boundary_vertices
  • Validator type: Teuchos::StringValidator
• pqParts
  • Description: list of parts for multijagged partitioning algorithm. As many as the dimension count.
  • Valid values: a comma-separated list of
    • numbers
    • number ranges separated by a dash ("1-5")
    • the word "all" to indicate all possible values
  • Examples: "1,2,7", "all", "5,1-15,80-82,99"
  • Validator type: Zoltan2::IntegerRangeListValidator (list is not changed during processing)
• random_seed
  • Description: random seed
  • Valid values are any values of type:
    • double
    • int
    • string
  • Validator type: Teuchos::AnyNumberParameterEntryValidator
• randomize_input
  • Description: randomize input prior to partitioning
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• rectilinear_blocks
  • Description: If true, then when a cut is made, all of the dots located on the cut are moved to the same side of the cut. The resulting regions are then rectilinear. The resulting load balance may not be as good as when the group of dots is split by the cut. Default is false.
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• speed_versus_quality
  • Description: When algorithm choices exist, opt for speed or solution quality? (Default is a balance of speed and quality)
  • Valid values:
    • speed
    • balance
    • quality
  • Validator type: Teuchos::StringValidator
• subset_graph
  • Description: If "yes", the graph input is to be subsetted. If a vertex neighbor is not a valid vertex, it will be omitted from the pList. Otherwise, an invalid neighbor identifier is considered an error.
  • Valid values:
    • true
    • yes
    • 1
    • on
    • false
    • no
    • 0
    • off
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• symmetrize_input
  • Description: Symmetrize input prior to pList. If "transpose", symmetrize A by computing A plus ATranspose. If "bipartite", A becomes [[0 A][ATranspose 0]].
  • Valid values:
    • no
    • transpose
    • bipartite
  • Validator type: Teuchos::StringValidator
• timer_output_file
  • Description: name of file to which timing information should be written (process rank will be included in file name) File need not already exist.
  • Validator type: Teuchos::FileNameValidator
• timer_output_stream
  • Description: output stream for timing report (default cout)
  • Valid values:
    • std::cout
    • cout
    • stdout
    • std::cerr
    • cerr
    • stderr
    • /dev/null
    • null
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• timer_type
  • Description: the type of timing information to collect (If the compile flag Z2_OMIT_ALL_PROFILING was set, then the timing code is not executed at runtime.)
  • Valid values:
    • no_timers No timing data will be collected (the default).
    • macro_timers Time an algorithm (or other entity) as a whole.
    • micro_timers Time the substeps of an entity.
    • both_timers Run both MACRO and MICRO timers.
    • test_timers Run timers added to code for testing, removed later
  • Validator type: Teuchos::StringToIntegralParameterEntryValidator
• topology
  • Description: Topology of node to be used in hierarchical partitioning "2,4" for dual-socket quad-core "2,2,6" for dual-socket, dual-die, six-core "2,2,3" for dual-socket, dual-die, six-core but with only three partitions per die
  • Valid values: a comma-separated list of
    • numbers
    • number ranges separated by a dash ("1-5")
    • the word "all" to indicate all possible values
  • Examples: "1,2,7", "all", "5,1-15,80-82,99"
  • Validator type: Zoltan2::IntegerRangeListValidator (list is not changed during processing)