Zoltan2_Parameters.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//
// Copyright 2012 NTESS and the Zoltan2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef _ZOLTAN2_PARAMETERS_HPP_
#define _ZOLTAN2_PARAMETERS_HPP_

#include <Zoltan2_Standards.hpp>

namespace Zoltan2{

// Parameter-related namespace methods 

void createAllParameters(Teuchos::ParameterList &pList);

void createValidatorList(
   const Teuchos::ParameterList &plIn, Teuchos::ParameterList &plOut);

void printListDocumentation( const Teuchos::ParameterList &pl, std::ostream &os,
  std::string listNames=std::string(""));

// Parameter-related enumerated types.
//
//  If you change these enumerators, change their documentation
//  in data/parameters.xml.
//

enum AssertionLevel {
  NO_ASSERTIONS,   
  BASIC_ASSERTION, 
  COMPLEX_ASSERTION,  
  DEBUG_MODE_ASSERTION, 
  NUM_ASSERTION_LEVELS
};

enum MessageOutputLevel {
  NO_STATUS,         
  BASIC_STATUS,      
  DETAILED_STATUS,   
  VERBOSE_DETAILED_STATUS, 
  NUM_STATUS_OUTPUT_LEVELS
};

enum TimerType {
  NO_TIMERS,    
  MACRO_TIMERS, 
  MICRO_TIMERS, 
  BOTH_TIMERS,  
  TEST_TIMERS,  
  NUM_TIMING_OPTIONS
};

enum OSType {
  COUT_STREAM,    
  CERR_STREAM,    
  NULL_STREAM,    
  NUM_OUTPUT_STREAMS
};

enum multiCriteriaNorm{
  normMinimizeTotalWeight,   
  normBalanceTotalMaximum,   
  normMinimizeMaximumWeight, 
  normNumNorms
};

}  // end of namespace Zoltan2

#endif