Zoltan 2 Version 0.5
Zoltan2_AlgNatural.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //   Zoltan2: A package of combinatorial algorithms for scientific computing
00006 //                  Copyright 2012 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Karen Devine      (kddevin@sandia.gov)
00039 //                    Erik Boman        (egboman@sandia.gov)
00040 //                    Siva Rajamanickam (srajama@sandia.gov)
00041 //
00042 // ***********************************************************************
00043 //
00044 // @HEADER
00045 #ifndef _ZOLTAN2_ALGNATURAL_HPP_
00046 #define _ZOLTAN2_ALGNATURAL_HPP_
00047 
00048 #include <Zoltan2_IdentifierModel.hpp>
00049 #include <Zoltan2_OrderingSolution.hpp>
00050 
00051 
00055 
00056 
00057 namespace Zoltan2{
00058 
00059 template <typename Adapter>
00060 int AlgNatural(
00061   const RCP<IdentifierModel<Adapter> > &model, 
00062   const RCP<OrderingSolution<typename Adapter::gid_t,
00063                              typename Adapter::lno_t> > &solution,
00064   const RCP<Teuchos::ParameterList> &pl,
00065   const RCP<Teuchos::Comm<int> > &comm
00066 ) 
00067 {
00068   typedef typename Adapter::lno_t lno_t;
00069   typedef typename Adapter::gno_t gno_t;
00070   typedef typename Adapter::gid_t gid_t;
00071   typedef typename Adapter::scalar_t scalar_t;
00072 
00073   int ierr= 0;
00074 
00075 #ifndef INCLUDE_ZOLTAN2_EXPERIMENTAL
00076 
00077   Z2_THROW_EXPERIMENTAL("Zoltan2 natural ordering is strictly "
00078                         "experimental software "
00079                         "while it is being developed and tested.")
00080   return ierr;
00081 
00082 #else //INCLUDE_ZOLTAN2_EXPERIMENTAL
00083 
00084 
00085   HELLO;
00086 
00087   // Local permutation only for now.
00088 
00089   // Set identity permutation.
00090   const size_t n = model->getLocalNumIdentifiers();
00091   lno_t *perm;
00092   perm = (lno_t *) (solution->getPermutationRCP().getRawPtr());
00093   if (perm){
00094     for (size_t i=0; i<n; i++){
00095       perm[i] = i;
00096     }
00097   }
00098   else
00099     // TODO: throw exception?
00100     ierr = -1;
00101 
00102   return ierr;
00103 
00104 #endif //INCLUDE_ZOLTAN2_EXPERIMENTAL
00105 }
00106 
00107 }
00108 #endif