TestNekMatrixOperations.cpp

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: TestNekMatrixOperations.cpp
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Tests NekMatrix functionality.
//
///////////////////////////////////////////////////////////////////////////////
 
#include <LibUtilities/LinearAlgebra/NekMatrix.hpp>
#include <UnitTests/LibUtilities/LinearAlgebra/TestCombinationRunner.h>
#include <boost/test/tools/floating_point_comparison.hpp>
#include <boost/test/unit_test.hpp>
#include <functional>
#include <iostream>
#include <memory>
 
namespace Nektar
{
void GenerateFullMatrices(
    double values[], double scale,
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> &m1,
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> &m2,
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> &m3)
{
    m1 =
        std::make_shared<NekMatrix<NekDouble, StandardMatrixTag>>(4, 4, values);
 
    double inner_values[16];
    std::transform(
        values, values + 16, inner_values,
        std::bind(std::divides<NekDouble>(), std::placeholders::_1, scale));
 
    std::shared_ptr<NekMatrix<NekDouble>> inner(
        new NekMatrix<NekDouble>(4, 4, inner_values));
    m2 = std::make_shared<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>>(
        scale, inner);
 
    double block_1_values[] = {values[0], values[1], values[4], values[5]};
    double block_2_values[] = {values[2], values[3], values[6], values[7]};
    double block_3_values[] = {values[8], values[9], values[12], values[13]};
    double block_4_values[] = {values[10], values[11], values[14], values[15]};
    std::shared_ptr<NekMatrix<NekDouble>> block1(
        new NekMatrix<NekDouble>(2, 2, block_1_values));
    std::shared_ptr<NekMatrix<NekDouble>> block2(
        new NekMatrix<NekDouble>(2, 2, block_2_values));
    std::shared_ptr<NekMatrix<NekDouble>> block3(
        new NekMatrix<NekDouble>(2, 2, block_3_values));
    std::shared_ptr<NekMatrix<NekDouble>> block4(
        new NekMatrix<NekDouble>(2, 2, block_4_values));
 
    m3 = std::make_shared<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>>(
        2, 2, 2, 2);
    m3->SetBlock(0, 0, block1);
    m3->SetBlock(1, 0, block2);
    m3->SetBlock(0, 1, block3);
    m3->SetBlock(1, 1, block4);
}
 
void GenerateUpperTriangularMatrices(
    NekDouble values[], NekDouble scale,
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> &m1,
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> &m2,
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> &m3)
{
    m1 = std::make_shared<NekMatrix<NekDouble, StandardMatrixTag>>(
        4, 4, values, eUPPER_TRIANGULAR);
 
    double inner_values[10];
    std::transform(
        values, values + 10, inner_values,
        std::bind(std::divides<NekDouble>(), std::placeholders::_1, scale));
 
    std::shared_ptr<NekMatrix<NekDouble>> inner(
        new NekMatrix<NekDouble>(4, 4, inner_values, eUPPER_TRIANGULAR));
    m2 = std::make_shared<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>>(
        scale, inner);
 
    double block_1_values[] = {values[0], 0.0, values[1], values[2]};
    double block_2_values[] = {values[3], values[4], values[6], values[7]};
    double block_4_values[] = {values[5], 0.0, values[8], values[9]};
    std::shared_ptr<NekMatrix<NekDouble>> block1(
        new NekMatrix<NekDouble>(2, 2, block_1_values));
    std::shared_ptr<NekMatrix<NekDouble>> block2(
        new NekMatrix<NekDouble>(2, 2, block_2_values));
    std::shared_ptr<NekMatrix<NekDouble>> block4(
        new NekMatrix<NekDouble>(2, 2, block_4_values));
 
    m3 = std::make_shared<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>>(
        2, 2, 2, 2);
    m3->SetBlock(0, 0, block1);
    m3->SetBlock(0, 1, block2);
    m3->SetBlock(1, 1, block4);
}
 
namespace MatrixOperationTests
{
BOOST_AUTO_TEST_CASE(TestLhsFullRhsFull)
{
    // double lhs_values[] = {2, 4, 6, 8,
    //                       10, 12, 14, 16,
    //                       18, 20, 22, 24,
    //                       26, 28, 30, 32};
    double lhs_values[] = {2, 10, 18, 26, 4, 12, 20, 28,
                           6, 14, 22, 30, 8, 16, 24, 32};
 
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> lhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> lhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> lhs3;
 
    GenerateFullMatrices(lhs_values, 2.0, lhs1, lhs2, lhs3);
    // double rhs_values[] = {4, 8, 12, 16,
    //                       20, 24, 28, 32,
    //                       36, 40, 44, 48,
    //                       52, 56, 60, 64};
    double rhs_values[] = {4,  20, 36, 52, 8,  24, 40, 56,
                           12, 28, 44, 60, 16, 32, 48, 64};
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> rhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> rhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> rhs3;
    GenerateFullMatrices(rhs_values, 2.0, rhs1, rhs2, rhs3);
 
    double result_values[16];
    std::transform(lhs_values, lhs_values + 16, rhs_values, result_values,
                   std::plus<NekDouble>());
    NekMatrix<NekDouble> result(4, 4, result_values);
 
    RunAllAddCombinations(*lhs1, *lhs2, *lhs3, *rhs1, *rhs2, *rhs3, result);
}
 
BOOST_AUTO_TEST_CASE(TestComboExpression)
{
    {
        // double buf[] = {1.0, 2.0, 3.0, 4.0};
        double buf[] = {1.0, 3.0, 2.0, 4.0};
        SharedNekMatrixPtr inner1(new NekMatrix<NekDouble>(2, 2, buf));
        SharedNekMatrixPtr inner2(new NekMatrix<NekDouble>(2, 2, buf));
 
        DNekScalMat m1(2.0, inner1);
        DNekScalMat m2(3.0, inner2);
 
        (*inner1) * 2.0;
        2.0 * (*inner1);
        // DNekScalMat m3 = m1*2.0;
        NekMatrix<NekDouble> result = m1 + 1.0 / 6.0 * m2;
 
        BOOST_CHECK_EQUAL(result(0, 0), 2.5);
        BOOST_CHECK_EQUAL(result(0, 1), 5.0);
        BOOST_CHECK_EQUAL(result(1, 0), 7.5);
        BOOST_CHECK_EQUAL(result(1, 1), 10.0);
    }
 
    {
        double buf[] = {1.0, 2.0, 3.0, 4.0};
        SharedNekMatrixPtr inner1(new NekMatrix<NekDouble>(2, 2, buf));
        SharedNekMatrixPtr inner2(new NekMatrix<NekDouble>(2, 2, buf));
 
        std::shared_ptr<DNekScalMat> m1(new DNekScalMat(2.0, inner1));
        std::shared_ptr<DNekScalMat> m2(new DNekScalMat(3.0, inner2));
 
        (*m1) * 2.0;
 
        // BOOST_CHECK_EQUAL(result->GetValue(0,0), 2.0);
        // BOOST_CHECK_EQUAL(result->GetValue(0,1), 4.0);
        // BOOST_CHECK_EQUAL(result->GetValue(1,0), 6.0);
        // BOOST_CHECK_EQUAL(result->GetValue(1,1), 8.0);
    }
}
 
BOOST_AUTO_TEST_CASE(TestLhsUpperTriangularRhsUpperTriangular)
{
    // double lhs_values[] = {2, 4,  6,  8,
    //                          12, 14, 16,
    //                              22, 24,
    //                                  32};
    double lhs_values[] = {2, 4, 12, 6, 14, 22, 8, 16, 24, 32};
 
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> lhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> lhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> lhs3;
    GenerateUpperTriangularMatrices(lhs_values, 2.0, lhs1, lhs2, lhs3);
 
    // double rhs_values[] = {4,   8, 12, 16,
    //                           24, 28, 32,
    //                               44, 48,
    //                                   64};
    double rhs_values[] = {4, 8, 24, 12, 28, 44, 16, 32, 48, 64};
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> rhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> rhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> rhs3;
    GenerateUpperTriangularMatrices(rhs_values, 2.0, rhs1, rhs2, rhs3);
 
    double result_values[10];
    std::transform(lhs_values, lhs_values + 10, rhs_values, result_values,
                   std::plus<NekDouble>());
    NekMatrix<NekDouble, StandardMatrixTag> result(4, 4, result_values,
                                                   eUPPER_TRIANGULAR);
}
 
BOOST_AUTO_TEST_CASE(TestLhsLowerTriangularRhsLowerTriangular)
{
}
} // namespace MatrixOperationTests
 
namespace MatrixSubtractionTests
{
BOOST_AUTO_TEST_CASE(TestLhsFullRhsFullSubtraction)
{
    // double lhs_values[] = {2, 4, 6, 8,
    //                        10, 12, 14, 16,
    //                        18, 20, 22, 24,
    //                        26, 28, 30, 32};
 
    double lhs_values[] = {2, 10, 18, 26, 4, 12, 20, 28,
                           6, 14, 22, 30, 8, 16, 24, 32};
 
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> lhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> lhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> lhs3;
 
    GenerateFullMatrices(lhs_values, 2.0, lhs1, lhs2, lhs3);
    // double rhs_values[] = {4, 8, 12, 16,
    //                        20, 24, 28, 32,
    //                        36, 40, 44, 48,
    //                        52, 56, 60, 64};
    double rhs_values[] = {4,  20, 36, 52, 8,  24, 40, 56,
                           12, 28, 44, 60, 16, 32, 48, 64};
    std::shared_ptr<NekMatrix<NekDouble, StandardMatrixTag>> rhs1;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, ScaledMatrixTag>> rhs2;
    std::shared_ptr<NekMatrix<NekMatrix<NekDouble>, BlockMatrixTag>> rhs3;
    GenerateFullMatrices(rhs_values, 2.0, rhs1, rhs2, rhs3);
 
    double result_values[16];
    std::transform(lhs_values, lhs_values + 16, rhs_values, result_values,
                   std::minus<NekDouble>());
    NekMatrix<NekDouble> result(4, 4, result_values);
    RunAllSubCombinations(*lhs1, *lhs2, *lhs3, *rhs1, *rhs2, *rhs3, result);
}
} // namespace MatrixSubtractionTests
} // namespace Nektar