Kokkos Node API and Local Linear Algebra Kernels Version of the Day
TsqrCommFactory.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ************************************************************************
00003 // 
00004 //          Kokkos: Node API and Parallel Node Kernels
00005 //              Copyright (2008) Sandia Corporation
00006 // 
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00038 // 
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #ifndef __TSQR_Trilinos_TsqrCommFactory_hpp
00043 #define __TSQR_Trilinos_TsqrCommFactory_hpp
00044 
00049 
00050 #include <Teuchos_RCP.hpp>
00051 #include <Tsqr_MessengerBase.hpp>
00052 
00053 namespace TSQR {
00054   namespace Trilinos {
00055 
00056     // Forward declaration. TsqrFactory.hpp includes
00057     // TsqrCommFactory.hpp, and TsqrTypeAdaptor.hpp includes
00058     // TsqrFactory.hpp.  We resolve the dependency with a forward
00059     // declaration of TsqrTypeAdaptor here.
00060     template< class S, class LO, class GO, class MV >
00061     class TsqrTypeAdaptor;
00062 
00066     template< class S, class LO, class GO, class MV >
00067     class CommFactory {
00068     public:
00069       typedef S scalar_type;
00070       typedef LO local_ordinal_type;
00071       typedef GO global_ordinal_type;
00072       typedef MV multivector_type;
00073 
00074       typedef TsqrTypeAdaptor< S, LO, GO, MV >    type_adaptor;
00075       typedef typename type_adaptor::comm_type    comm_type;
00076       typedef typename type_adaptor::comm_ptr     comm_ptr;
00077       typedef Teuchos::RCP< MessengerBase< S > >  scalar_messenger_ptr;
00078       typedef Teuchos::RCP< MessengerBase< LO > > ordinal_messenger_ptr;
00079 
00084       virtual void
00085       makeMessengers (const comm_ptr& comm,
00086           scalar_messenger_ptr& scalarMessenger,
00087           ordinal_messenger_ptr& ordinalMessenger) = 0;
00088 
00090       virtual ~CommFactory () {}
00091     };
00092   } // namespace Trilinos
00093 } // namespace TSQR
00094 
00095 #endif // __TSQR_Trilinos_TsqrCommFactory_hpp
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends