/usr/include/trilinos/Zoltan2_Parameters.hpp is in libtrilinos-zoltan2-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | //
// 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)
//
/*! \file Zoltan2_Parameters.hpp
\brief Defines Parameter related enumerators, declares functions.
*/
#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.
//
/*! \brief Level of error checking or assertions desired.
*
* Each assertion in the code must have a level. Tests for
* logic errors should always be level DEBUG_MODE_ASSERTION.
* Quick tests are BASIC, longer tests for input errors are
* COMPLEX.
*
* The user sets the assertion level with the parameter \c error_check_level.
*
* If compiled with \b Z2_OMIT_ALL_ERROR_CHECKING, error checks don't happen.
*/
enum AssertionLevel {
NO_ASSERTIONS, /*!< \brief no assertion checks will be done */
BASIC_ASSERTION, /*!< \brief fast typical checks for valid arguments */
COMPLEX_ASSERTION, /*!< \brief more involved, like validate a graph */
DEBUG_MODE_ASSERTION, /*!< \brief checks for logic errors */
NUM_ASSERTION_LEVELS
};
/*! \brief The amount of debugging or status output to print.
*
* Each debug/status message must have an output level. The
* user specfies the level desired with the \c debug_level parameter.
*
* If Zoltan2 is compiled with \b Z2_OMIT_ALL_STATUS_MESSAGES, no
* messages will be processed.
*/
enum MessageOutputLevel {
NO_STATUS, /*!< \brief don't display status/debug messages */
BASIC_STATUS, /*!< \brief the status at each high level step */
DETAILED_STATUS, /*!< \brief sub-steps, each method's entry and exit */
VERBOSE_DETAILED_STATUS, /*!< \brief include more detail about sub-steps */
NUM_STATUS_OUTPUT_LEVELS
};
/*! \brief The type of timers which should be active.
*
* If timing is requested, \c timer_type can specify MACRO timing
* or MICRO timing. For example, a MACRO timer would time an
* algorithm. A MICRO timer would time steps in the algorithm.
* You can also ask for BOTH, but be aware that your MACRO timer
* is also timing the MICRO timers as well as the algorithm.
*
* If Zoltan2 is compiled with \b Z2_OMIT_ALL_PROFILING
* timing messages are ignored.
*/
enum TimerType {
NO_TIMERS, /*!< \brief No timing data will be collected (the default). */
MACRO_TIMERS, /*!< \brief Time an algorithm (or other entity) as a whole. */
MICRO_TIMERS, /*!< \brief Time the substeps of an entity. */
BOTH_TIMERS, /*!< \brief Run both MACRO and MICRO timers. */
TEST_TIMERS, /*!< \brief Timers added while testing, removed later. */
NUM_TIMING_OPTIONS
};
/*! \brief Output stream types.
*/
enum OSType {
COUT_STREAM, /*!< \brief std::cout */
CERR_STREAM, /*!< \brief std::cerr */
NULL_STREAM, /*!< \brief /dev/null: do actions but don't output results */
NUM_OUTPUT_STREAMS
};
/*!\brief Enumerator used in code for multicriteria norm choice.
*/
enum multiCriteriaNorm{
normMinimizeTotalWeight, /*!< 1-norm = Manhattan norm */
normBalanceTotalMaximum, /*!< 2-norm = sqrt of sum of squares */
normMinimizeMaximumWeight, /*!< inf-norm = maximum norm */
normNumNorms
};
} // end of namespace Zoltan2
#endif
|