// @HEADER // ***************************************************************************** // Xpetra: A linear algebra interface package // // Copyright 2012 NTESS and the Xpetra contributors. // SPDX-License-Identifier: BSD-3-Clause // ***************************************************************************** // @HEADER #ifndef XPETRA_UNIT_TEST_HELPERS_HPP #define XPETRA_UNIT_TEST_HELPERS_HPP #include "Teuchos_UnitTestHelpers.hpp" #include "Xpetra_ConfigDefs.hpp" #include "Xpetra_Map.hpp" #include "Xpetra_MapFactory.hpp" /** \brief Basic unit test creation macro for templated code on five template parameters. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_5_DECL(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5) \ template \ class TEST_GROUP##_##TEST_NAME##_UnitTest : public Teuchos::UnitTestBase { \ public: \ TEST_GROUP##_##TEST_NAME##_UnitTest( \ const std::string& type1Name, \ const std::string& type2Name, \ const std::string& type3Name, \ const std::string& type4Name, \ const std::string& type5Name) \ : Teuchos::UnitTestBase( \ std::string(#TEST_GROUP) + "_" + type1Name + "_" + type2Name + "_" + type3Name + "_" + type4Name + "_" + type5Name, #TEST_NAME) {} \ void runUnitTestImpl(Teuchos::FancyOStream& out, bool& success) const; \ virtual std::string unitTestFile() const { return __FILE__; } \ virtual long int unitTestFileLineNumber() const { return __LINE__; } \ }; \ \ template \ void TEST_GROUP##_##TEST_NAME##_UnitTest::runUnitTestImpl( \ Teuchos::FancyOStream& out, bool& success) const /** \brief Template instantiation for five templated types. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_5_INSTANT(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5) \ \ template class TEST_GROUP##_##TEST_NAME##_UnitTest; \ TEST_GROUP##_##TEST_NAME##_UnitTest \ instance_##TEST_GROUP##_##TYPE1##_##TYPE2##_##TYPE3##_##TYPE4##_##TYPE5##_##TEST_NAME##_UnitTest(#TYPE1, #TYPE2, #TYPE3, #TYPE4, #TYPE5); // new unit test macros with support for 6 template parameters /** \brief Basic unit test creation macro for templated code on six template parameters. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_6_DECL(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5, TYPE6) \ template \ class TEST_GROUP##_##TEST_NAME##_UnitTest : public Teuchos::UnitTestBase { \ public: \ TEST_GROUP##_##TEST_NAME##_UnitTest( \ const std::string& type1Name, \ const std::string& type2Name, \ const std::string& type3Name, \ const std::string& type4Name, \ const std::string& type5Name, \ const std::string& type6Name) \ : Teuchos::UnitTestBase( \ std::string(#TEST_GROUP) + "_" + type3Name + "_" + type4Name + "_" + type5Name + "_" + type6Name, #TEST_NAME) {} \ void runUnitTestImpl(Teuchos::FancyOStream& out, bool& success) const; \ virtual std::string unitTestFile() const { return __FILE__; } \ virtual long int unitTestFileLineNumber() const { return __LINE__; } \ }; \ \ template \ void TEST_GROUP##_##TEST_NAME##_UnitTest::runUnitTestImpl( \ Teuchos::FancyOStream& out, bool& success) const /** \brief Template instantiation for six templated types. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_6_INSTANT(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5, TYPE6) \ \ template class TEST_GROUP##_##TEST_NAME##_UnitTest; \ TEST_GROUP##_##TEST_NAME##_UnitTest \ instance_##TEST_GROUP##_##TYPE1##_##TYPE2##_##TYPE3##_##TYPE4##_##TYPE5##_##TYPE6##_##TEST_NAME##_UnitTest(#TYPE1, #TYPE2, #TYPE3, #TYPE4, #TYPE5, #TYPE6); /** \brief Basic unit test creation macro for templated code on seven template parameters. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_7_DECL(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5, TYPE6, TYPE7) \ template \ class TEST_GROUP##_##TEST_NAME##_UnitTest : public Teuchos::UnitTestBase { \ public: \ TEST_GROUP##_##TEST_NAME##_UnitTest( \ const std::string& type1Name, \ const std::string& type2Name, \ const std::string& type3Name, \ const std::string& type4Name, \ const std::string& type5Name, \ const std::string& type6Name, \ const std::string& type7Name) \ : Teuchos::UnitTestBase( \ std::string(#TEST_GROUP) + "_" + type4Name + "_" + type5Name + "_" + type6Name + "_" + type7Name, #TEST_NAME) {} \ void runUnitTestImpl(Teuchos::FancyOStream& out, bool& success) const; \ virtual std::string unitTestFile() const { return __FILE__; } \ virtual long int unitTestFileLineNumber() const { return __LINE__; } \ }; \ \ template \ void TEST_GROUP##_##TEST_NAME##_UnitTest::runUnitTestImpl( \ Teuchos::FancyOStream& out, bool& success) const /** \brief Template instantiation for seven templated types. */ #define TEUCHOS_UNIT_TEST_TEMPLATE_7_INSTANT(TEST_GROUP, TEST_NAME, TYPE1, TYPE2, TYPE3, TYPE4, TYPE5, TYPE6, TYPE7) \ \ template class TEST_GROUP##_##TEST_NAME##_UnitTest; \ TEST_GROUP##_##TEST_NAME##_UnitTest \ instance_##TEST_GROUP##_##TYPE1##_##TYPE2##_##TYPE3##_##TYPE4##_##TYPE5##_##TYPE6##_##TYPE7##_##TEST_NAME##_UnitTest(#TYPE1, #TYPE2, #TYPE3, #TYPE4, #TYPE5, #TYPE6, #TYPE7); /** \brief Helper macro which extracts the underlying lib (Epetra/Teptra) from a Map type (EpetraMapT or TpetraMap) and stores it in "mylib" */ #define EXTRACT_LIB(comm, M) \ M testMap(1, 0, comm); \ Xpetra::UnderlyingLib mylib = testMap.lib(); namespace Xpetra { namespace UnitTestHelpers { //! Non-member function to create a (potentially) non-uniform, contiguous Map with a user-specified node. template Teuchos::RCP > createContigMapWithNode(Xpetra::UnderlyingLib lib, Xpetra::global_size_t numElements, size_t localNumElements, const Teuchos::RCP >& comm, const Teuchos::RCP& /* node */ = Teuchos::null) { XPETRA_MONITOR("Xpetra::UnitTestHelpers::createContigMap"); return Xpetra::MapFactory::Build(lib, numElements, localNumElements, 0, comm); } } // namespace UnitTestHelpers } // namespace Xpetra #endif // XPETRA_UNIT_TEST_HELPERS_HPP