You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
118 lines
5.3 KiB
118 lines
5.3 KiB
<!-------- @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
|
|
------->
|
|
|
|
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|
<meta name="GENERATOR" content="Mozilla/4.7 [en] (X11; U; SunOS 5.7 sun4u) [Netscape]">
|
|
<meta name="sandia.approved" content="SAND99-1376">
|
|
<meta name="author" content="karen devine, kddevin@sandia.gov">
|
|
<title> Zoltan Developer's Guide: Adding Parameters</title>
|
|
</head>
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
<div ALIGN=right><b><i><a href="dev.html">Zoltan Developer's Guide</a> | <a href="dev_add_remap.html">Next</a> | <a href="dev_add_memory.html">Previous</a></i></b></div>
|
|
|
|
|
|
<h2>
|
|
<a NAME="new_parameters"></a>Adding new parameters</h2>
|
|
All parameters in Zoltan should be set and accessed through the <a href="dev_services_params.html">parameter
|
|
setting routines</a>. To add a new parameter to an existing method, you
|
|
need to do the following:
|
|
<ul>
|
|
<li>
|
|
In the source code for the desired method, search for the place where
|
|
the static array of parameters is defined. It will look something like:
|
|
<i>static
|
|
PARAM_VARS Method_params[] = { ... }</i>. Add a line with the name
|
|
of the new parameter, a pointer to the variable you want to associate (usually
|
|
NULL), and its type.</li>
|
|
|
|
<li>
|
|
In the method source code, bind the parameter to a local variable through
|
|
<b><a href="dev_services_params.html#Zoltan_Bind_Param">Zoltan_Bind_Param</a></b>.
|
|
Make sure you do this before <b><a href="dev_services_params.html#Zoltan_Assign_Param_Vals">Zoltan_Assign_Param_Vals
|
|
</a></b>is
|
|
invoked.</li>
|
|
|
|
<li>
|
|
Update the parameter function for the method in question. This routine
|
|
is typically called <b>Zoltan_</b><i>Method</i><b>_Set_Param</b><i>. </i>This
|
|
routine checks if a given string is a valid parameter for that method.
|
|
It may also verify the values.</li>
|
|
</ul>
|
|
When you add a new method to Zoltan, you also need to:
|
|
<ul>
|
|
<li>
|
|
Write a parameter function for your method that checks whether a given
|
|
string and value is a valid parameter pair for your method. See <b>Zoltan_RCB_Set_Param</b>
|
|
in <i>rcb/rcb.c</i> for an example.</li>
|
|
|
|
<li>
|
|
Let your method access the parameters via <b><a href="dev_services_params.html#Zoltan_Bind_Param">Zoltan_Bind_Param
|
|
</a></b>and
|
|
<b><a href="dev_services_params.html#Zoltan_Assign_Param_Vals">Zoltan_Assign_Param_Vals</a></b>.</li>
|
|
|
|
<li>
|
|
Change the parameter function array in <i>params/set_params.c</i> to include
|
|
your parameter function. Simply add a new entry to the static array that
|
|
looks like: <i>static ZOLTAN_SET_PARAM_FN * Param_func[] = {...}</i>.</li>
|
|
|
|
<li>
|
|
Make sure your method uses the <a href="../ug_html/ug_param.html#General_Parameters">key
|
|
parameters</a> in Zoltan correctly.</li>
|
|
</ul>
|
|
One useful convention is to put your method routine and your corresponding
|
|
parameter function in the same source file. This way you can define the
|
|
parameters in a static array. This convention eliminates the risk
|
|
of bugs caused by duplicate declarations (that are, incorrectly, not identical).
|
|
<br>
|
|
<hr WIDTH="100%">
|
|
<br>[<a href="dev.html">Table of Contents</a> | <a href="dev_add_remap.html">Next:
|
|
Part Remapping</a> | <a href="dev_add_memory.html">Previous:
|
|
Memory Management</a> | <a href="https://www.sandia.gov/general/privacy-security/index.html">Privacy and Security</a>]
|
|
</body>
|
|
</html>
|
|
|