phasicFlow/thirdParty/Zoltan/src/params

# @HEADER
#
########################################################################
#
#  Zoltan Toolkit for Load-balancing, Partitioning, Ordering and Coloring
#                  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
#
########################################################################
#
# @HEADER


PARAMS DIRECTORY -- Routines for setting parameter values
----------------------------------------------------------------

Files compiled into Zoltan:

params_const.h      -- Prototypes for parameter functions.

assign_param_vals.c -- Contains Zoltan_Assign_Param_Vals which loops over the 
                       set of new parameters/values associated with an Zoltan 
                       structure and sets those which are appropriate.

bind_param.c        -- Routine to bind a parameter name to a variable.
                       This function must be called before 
                       Zoltan_Assign_Param_Vals.

check_param.c       -- Routine Zoltan_Check_Param compares a string against a 
                       list of valid parameter names & checks the type for 
                       correctness.

free_params.c       -- Frees all the parameters allocated for an Zoltan struct.

key_params.c        -- Set parameter values for variables in Zoltan struct.

print_params.c      -- Debugging routine to print out the parameter settings.

set_param.c         -- Routine Zoltan_Set_Param calls domain-specific routines
		       to identify a parameter being set & usually adds it to
		       list of modified parameters & values.