DistributedVectorTest Class Reference

Inheritance diagram for DistributedVectorTest:

Public Member Functions
	DistributedVectorTest ()
	CPPUNIT_TEST_SUITE (DistributedVectorTest)
NUMERICVECTORTEST	CPPUNIT_TEST_SUITE_END ()
void	setUp ()
void	tearDown ()
void	Operations ()
void	WriteAndRead ()
void	Norms ()
void	Localize (bool to_one=false)
void	LocalizeIndices ()
void	testLocalize ()
void	testLocalizeBase ()
void	testLocalizeToOne ()
void	testLocalizeToOneBase ()
void	testLocalizeIndices ()
void	testLocalizeIndicesBase ()
void	testNorms ()
void	testNormsBase ()
void	testOperations ()
void	testOperationsBase ()
void	testWriteAndRead ()
void	testWriteAndReadBase ()

Protected Attributes
libMesh::Parallel::Communicator *	my_comm
std::string	libmesh_suite_name
unsigned int	block_size
unsigned int	local_size
unsigned int	global_size

Detailed Description

Definition at line 8 of file distributed_vector_test.C.

Constructor & Destructor Documentation

DistributedVectorTest()

DistributedVectorTest::DistributedVectorTest ( )

inline

Definition at line 10 of file distributed_vector_test.C.

References libMesh::PerfLog::summarized_logs_enabled(), and unitlog.

                          :
    NumericVectorTest<DistributedVector<Number>>() {
    if (unitlog->summarized_logs_enabled())
      this->libmesh_suite_name = "NumericVectorTest";
    else
      this->libmesh_suite_name = "DistributedVectorTest";
  }

Member Function Documentation

CPPUNIT_TEST_SUITE()

DistributedVectorTest::CPPUNIT_TEST_SUITE

(

DistributedVectorTest

)

CPPUNIT_TEST_SUITE_END()

NUMERICVECTORTEST DistributedVectorTest::CPPUNIT_TEST_SUITE_END

(

)

Localize()

void NumericVectorTest< DistributedVector< Number > >::Localize ( bool  to_one = false )

inlineinherited

Definition at line 245 of file numeric_vector_test.h.

References NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, TIMPI::Communicator::rank(), libMesh::Real, libMesh::TOLERANCE, and value.

  {
    const libMesh::processor_id_type root_pid = 0;

    {
      auto v_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
      Base & v = *v_ptr;
      std::vector<libMesh::Number> l(global_size);

      const libMesh::dof_id_type
        first = v.first_local_index(),
        last  = v.last_local_index();

      for (libMesh::dof_id_type n=first; n != last; n++)
        v.set (n, static_cast<libMesh::Number>(n));
      v.close();
      for (libMesh::dof_id_type n=first; n != last; n++)
        v.add (n, static_cast<libMesh::Number>(n));
      v.close();

      if (!to_one)
        v.localize(l);
      else
        v.localize_to_one(l,root_pid);

      if (!to_one || my_comm->rank() == root_pid)
        // Yes I really mean v.size()
        for (libMesh::dof_id_type i=0; i<v.size(); i++)
          LIBMESH_ASSERT_NUMBERS_EQUAL
            (2.*i, l[i], libMesh::TOLERANCE*libMesh::TOLERANCE);

      for (libMesh::dof_id_type n=first; n != last; n++)
      {
        const auto value = static_cast<libMesh::Number>(n);
        v.insert (&value, std::vector<libMesh::numeric_index_type>({n}));
      }
      v.close();

      if (!to_one)
        v.localize(l);
      else
        v.localize_to_one(l,root_pid);

      if (!to_one || my_comm->rank() == root_pid)
        // Yes I really mean v.size()
        for (libMesh::dof_id_type i=0; i<v.size(); i++)
          LIBMESH_ASSERT_NUMBERS_EQUAL
            (libMesh::Real(i), l[i], libMesh::TOLERANCE*libMesh::TOLERANCE);
    }
  }

LocalizeIndices()

void NumericVectorTest< DistributedVector< Number > >::LocalizeIndices ( )

inlineinherited

Definition at line 298 of file numeric_vector_test.h.

References NumericVectorTest< DerivedClass >::block_size, NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, libMesh::Real, TIMPI::Communicator::size(), and libMesh::TOLERANCE.

  {
    {
      auto v_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
      Base & v = *v_ptr;

      // Let's try pulling the same number of entries from each processor
      std::vector<libMesh::Number> values(block_size * my_comm->size());
      std::vector<libMesh::dof_id_type> indices;
      indices.reserve(block_size * my_comm->size());

      const libMesh::dof_id_type
        first = v.first_local_index(),
        last  = v.last_local_index();

      for (libMesh::dof_id_type n=first; n != last; n++)
        v.set (n, static_cast<libMesh::Number>(n));
      v.close();

      libMesh::dof_id_type end_index = 0;
      for (libMesh::processor_id_type p=0; p<my_comm->size(); p++)
        {
          end_index += block_size + p;
          for (unsigned int j = 0; j != block_size; ++j)
            indices.push_back(end_index-j-1);
        }

      v.localize(values, indices);

      end_index = 0;
      for (libMesh::processor_id_type p=0; p<my_comm->size(); p++)
        {
          end_index += block_size + p;
          for (unsigned int j = 0; j != block_size; ++j)
            LIBMESH_ASSERT_NUMBERS_EQUAL
              (values[p*block_size+j], libMesh::Real(end_index-j-1),
               libMesh::TOLERANCE*libMesh::TOLERANCE);
        }
    }
  }

Norms()

void NumericVectorTest< DistributedVector< Number > >::Norms ( )

inlineinherited

Definition at line 191 of file numeric_vector_test.h.

References NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, libMesh::Real, and libMesh::TOLERANCE.

  {
    auto v_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
    Base & v = *v_ptr;

    const libMesh::dof_id_type
      first = v.first_local_index(),
      last  = v.last_local_index();

    for (libMesh::dof_id_type n=first; n != last; n++)
      v.set (n, -static_cast<libMesh::Number>(n));
    v.close();
    for (libMesh::dof_id_type n=first; n != last; n++)
      v.add (n, -static_cast<libMesh::Number>(n));
    v.close();

    const libMesh::Real exact_l1 =
      global_size * (global_size-libMesh::Real(1));
    const libMesh::Real exact_l2 =
      std::sqrt(libMesh::Real(global_size-1) *
                (2*global_size) *
                (2*global_size-1) / 3);
    LIBMESH_ASSERT_NUMBERS_EQUAL(v.sum(), -exact_l1,
                            libMesh::TOLERANCE*libMesh::TOLERANCE);
    LIBMESH_ASSERT_FP_EQUAL(v.l1_norm(), exact_l1,
                            libMesh::TOLERANCE*libMesh::TOLERANCE);
    LIBMESH_ASSERT_FP_EQUAL(v.l2_norm(), exact_l2,
                            libMesh::TOLERANCE*libMesh::TOLERANCE);
    LIBMESH_ASSERT_FP_EQUAL(v.linfty_norm(), 2*(global_size-libMesh::Real(1)),
                            libMesh::TOLERANCE*libMesh::TOLERANCE);

    auto u_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
    Base & u = *u_ptr;
    for (libMesh::dof_id_type n=first; n != last; n++)
      u.set (n, -static_cast<libMesh::Number>(n * n));
    u.close();

    Derived diff_derived(*my_comm, global_size, local_size);
    Base & diff = diff_derived;
    diff = u;
    diff -= v;
    diff.close();

    // Use a relative tolerance here; the norms are O(1e5) when our
    // processor count gets big enough, at which point O(1e-12) is
    // testing for exact equality...
    const auto diff_norm = diff.l2_norm();
    const auto norm_diff = u.l2_norm_diff(v);
    LIBMESH_ASSERT_FP_EQUAL(diff_norm, norm_diff,
                            (std::abs(diff_norm)+std::abs(norm_diff)) *
                            libMesh::TOLERANCE*libMesh::TOLERANCE);
  }

Operations()

void NumericVectorTest< DistributedVector< Number > >::Operations ( )

inlineinherited

Definition at line 64 of file numeric_vector_test.h.

References NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, libMesh::Real, libMesh::relative_fuzzy_equals(), and libMesh::TOLERANCE.

  {
    auto v_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
    Base & v = *v_ptr;

    const libMesh::dof_id_type
      first = v.first_local_index(),
      last  = v.last_local_index();

    for (libMesh::dof_id_type n=first; n != last; n++)
      v.set (n, static_cast<libMesh::Number>(n+1));
    v.close();

    auto v_clone = v.clone();
    auto & vorig = *v_clone;

    CPPUNIT_ASSERT(relative_fuzzy_equals(v, vorig));

    v += v;

    CPPUNIT_ASSERT(!relative_fuzzy_equals(v, vorig));

    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(2*n+2),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v *= v;

    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(4*n*n+8*n+4),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v -= vorig;

    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(4*n*n+7*n+3),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v /= vorig;

    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(4*n+3),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v.add(1);
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(4*n+4),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v.add(2, vorig);
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(6*n+6),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v.scale(1/libMesh::Real(3));
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(2*n+2),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v = 4;
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(4),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v = vorig;
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), libMesh::Real(n+1),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    v.reciprocal();
    for (libMesh::dof_id_type n=first; n != last; n++)
      LIBMESH_ASSERT_NUMBERS_EQUAL
        (v(n), 1/libMesh::Real(n+1),
         libMesh::TOLERANCE*libMesh::TOLERANCE);

    LIBMESH_ASSERT_NUMBERS_EQUAL
      (v.dot(vorig), libMesh::Real(global_size),
       libMesh::TOLERANCE*libMesh::TOLERANCE);
  }

setUp()

void NumericVectorTest< DistributedVector< Number > >::setUp ( )

inlineinherited

Definition at line 41 of file numeric_vector_test.h.

References NumericVectorTest< DerivedClass >::block_size, NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, TIMPI::Communicator::rank(), TIMPI::Communicator::size(), and TestCommWorld.

  {
    // By default we'll use the whole communicator in parallel;
    // Serial-only NumericVector subclasses will need to override
    // this and set something else first.
    if (!my_comm)
      my_comm = TestCommWorld;

    block_size  = 10;

    // a different size on each processor.
    local_size  = block_size +
      static_cast<unsigned int>(my_comm->rank());

    global_size = 0;
    for (libMesh::processor_id_type p=0; p<my_comm->size(); p++)
      global_size += (block_size + static_cast<unsigned int>(p));
  }

tearDown()

void NumericVectorTest< DistributedVector< Number > >::tearDown ( )

inlineinherited

Definition at line 60 of file numeric_vector_test.h.

  {}

testLocalize()

void NumericVectorTest< DistributedVector< Number > >::testLocalize ( )

inlineinherited

Definition at line 339 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Localize<DerivedClass,DerivedClass>();
  }

testLocalizeBase()

void NumericVectorTest< DistributedVector< Number > >::testLocalizeBase ( )

inlineinherited

Definition at line 346 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Localize<libMesh::NumericVector<libMesh::Number>,DerivedClass>();
  }

testLocalizeIndices()

void NumericVectorTest< DistributedVector< Number > >::testLocalizeIndices ( )

inlineinherited

Definition at line 367 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    LocalizeIndices<DerivedClass,DerivedClass >();
  }

testLocalizeIndicesBase()

void NumericVectorTest< DistributedVector< Number > >::testLocalizeIndicesBase ( )

inlineinherited

Definition at line 374 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    LocalizeIndices<libMesh::NumericVector<libMesh::Number>,DerivedClass>();
  }

testLocalizeToOne()

void NumericVectorTest< DistributedVector< Number > >::testLocalizeToOne ( )

inlineinherited

Definition at line 353 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Localize<DerivedClass,DerivedClass >(true);
  }

testLocalizeToOneBase()

void NumericVectorTest< DistributedVector< Number > >::testLocalizeToOneBase ( )

inlineinherited

Definition at line 360 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Localize<libMesh::NumericVector<libMesh::Number>,DerivedClass>(true);
  }

testNorms()

void NumericVectorTest< DistributedVector< Number > >::testNorms ( )

inlineinherited

Definition at line 381 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Norms<DerivedClass,DerivedClass >();
  }

testNormsBase()

void NumericVectorTest< DistributedVector< Number > >::testNormsBase ( )

inlineinherited

Definition at line 388 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Norms<libMesh::NumericVector<libMesh::Number>,DerivedClass>();
  }

testOperations()

void NumericVectorTest< DistributedVector< Number > >::testOperations ( )

inlineinherited

Definition at line 395 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Operations<DerivedClass,DerivedClass >();
  }

testOperationsBase()

void NumericVectorTest< DistributedVector< Number > >::testOperationsBase ( )

inlineinherited

Definition at line 402 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    Operations<libMesh::NumericVector<libMesh::Number>,DerivedClass>();
  }

testWriteAndRead()

void NumericVectorTest< DistributedVector< Number > >::testWriteAndRead ( )

inlineinherited

Definition at line 409 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    WriteAndRead<DerivedClass,DerivedClass >();
  }

testWriteAndReadBase()

void NumericVectorTest< DistributedVector< Number > >::testWriteAndReadBase ( )

inlineinherited

Definition at line 416 of file numeric_vector_test.h.

  {
    LOG_UNIT_TEST;

    WriteAndRead<libMesh::NumericVector<libMesh::Number>,DerivedClass>();
  }

WriteAndRead()

void NumericVectorTest< DistributedVector< Number > >::WriteAndRead ( )

inlineinherited

Definition at line 154 of file numeric_vector_test.h.

References TIMPI::Communicator::barrier(), NumericVectorTest< DerivedClass >::global_size, NumericVectorTest< DerivedClass >::libmesh_suite_name, NumericVectorTest< DerivedClass >::local_size, NumericVectorTest< DerivedClass >::my_comm, libMesh::Real, and TestCommWorld.

  {
    auto v_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
    Base & v = *v_ptr;

    const libMesh::dof_id_type
      first = v.first_local_index(),
      last  = v.last_local_index();

    for (libMesh::dof_id_type n=first; n != last; n++)
      v.set (n, static_cast<libMesh::Number>(n+1));
    v.close();

    v.print_matlab(libmesh_suite_name+"_vector.m");

    // Let's make sure we don't have any race conditions; we have
    // multiple SparseMatrix subclasses that might be trying to read
    // and write the same file.

    TestCommWorld->barrier();

#ifdef LIBMESH_USE_COMPLEX_NUMBERS
    // We're not supporting complex reads quite yet
    return;
#endif

    auto v_new_ptr = std::make_unique<Derived>(*my_comm, global_size, local_size);
    Base & v_new = *v_new_ptr;

    v_new.read_matlab(libmesh_suite_name+"_vector.m");

    TestCommWorld->barrier();

    CPPUNIT_ASSERT_EQUAL(v.l1_norm_diff(v_new), libMesh::Real(0));
  }

Member Data Documentation

block_size

unsigned int NumericVectorTest< DistributedVector< Number > >::block_size

protectedinherited

Definition at line 38 of file numeric_vector_test.h.

global_size

unsigned int NumericVectorTest< DistributedVector< Number > >::global_size

protectedinherited

Definition at line 38 of file numeric_vector_test.h.

libmesh_suite_name

std::string NumericVectorTest< DistributedVector< Number > >::libmesh_suite_name

protectedinherited

Definition at line 36 of file numeric_vector_test.h.

local_size

unsigned int NumericVectorTest< DistributedVector< Number > >::local_size

protectedinherited

Definition at line 38 of file numeric_vector_test.h.

my_comm

libMesh::Parallel::Communicator* NumericVectorTest< DistributedVector< Number > >::my_comm

protectedinherited

Definition at line 34 of file numeric_vector_test.h.

---

The documentation for this class was generated from the following file:

• tests/numerics/distributed_vector_test.C