Zoltan2_Parameters.hpp

Go to the documentation of this file.

//
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Karen Devine      (kddevin@sandia.gov)
//                    Erik Boman        (egboman@sandia.gov)
//                    Siva Rajamanickam (srajama@sandia.gov)
//

 
#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