Remove unneeded doxygen return tags in some constructors (#202)

* Remove unneeded doxygen return tags in some constructors

* Minor sphinx changes.

* update TPL paths

Co-authored-by: Benjamin Curtice Corbett <[email protected]>
Co-authored-by: Randolph R. Settgast <[email protected]>

Author: 3 people

docs/sphinx/tensorOps.rst

@@ -196,7 +196,7 @@ Operation
 :math:`\mathbf{S} \leftarrow \mathbf{Q}^-1`                                      ``tensorOps::symInvert< m >( S, Q )``
 :math:`\mathbf{S} \leftarrow \mathbf{S}^-1`                                      ``tensorOps::symInvert< m >( S )``
 :math:`x \leftarrow \mathbf{S} \mathbf{A}^T = diag(x) \mathbf{A}^T`              ``tensorOps::symEigenvalues< M >( x, S )``
-:math:`x, \mathbf{A} \leftarrow \mathbf{S} \mathbf{A}^T = diag(x) \mathbf{A}^T`  ``tensorOps::symEigenvalues< M >( x, S )``
+:math:`x, \mathbf{A} \leftarrow \mathbf{S} \mathbf{A}^T = diag(x) \mathbf{A}^T`  ``tensorOps::symEigenvectors< M >( x, S )``
 ================================================================================ ==============================================
 
 There are also two function ``tensorOps::denseToSymmetric`` and ``tensorOps::symmetricToDense`` which convert between dense and symmetric matrix representation.

docs/sphinx/testing.rst

@@ -4,8 +4,8 @@ Testing
 
 Testing is a crucial component of writing quality software and the nature LvArray lends itself nicely to unit tests.
 
-Building and running the test
------------------------------
+Building and Running the Tests
+------------------------------
 Tests are built by default, to disable the tests set the CMake variable ``ENABLE_TESTS`` to ``OFF``. The tests are output in the ``tests`` folder of the build directory.
 
 To run all the tests run ``make test`` in the build directory. To run a specific set of tests that match the regular expression ``REGEX`` run ``ctest -V -R REGEX``, to run just ``testCRSMatrix`` run ``./tests/testCRSMatrix``. LvArray uses `Google Test`_ for the testing framework and each test accepts a number of command line arguments.
@@ -73,13 +73,13 @@ The most useful of these is ``gtest_filter`` which lets you run a subset of test
 
 Test structure
 --------------
-The source for all the tests are all located in the ``unitTests`` directory, each tests consists of a ``cpp`` whose name begins with ``test`` followed by the name of the class or namespace that is tested. For example the tests for ``CRSMatrix`` and ``CRSMatrixView`` are in ``unitTests/testCRSMatrix.cpp`` and the tests for ``sortedArrayManipulation`` are in ``unitTests/testSortedArrayManipulation.cpp``. 
+The source for all the tests are all located in the ``unitTests`` directory, each tests consists of a ``cpp`` file whose name begins with ``test`` followed by the name of the class or namespace that is tested. For example the tests for ``CRSMatrix`` and ``CRSMatrixView`` are in ``unitTests/testCRSMatrix.cpp`` and the tests for ``sortedArrayManipulation`` are in ``unitTests/testSortedArrayManipulation.cpp``. 
 
 .. note::
   The tests for ``LvArray::Array``, ``LvArray::ArrayView`` and ``LvArray::tensorOps`` are spread across multiple ``cpp`` files in order to speed up compilation on multithreaded systems.
 
-Adding a new test
----------------------
+Adding a New Test
+-----------------
 Any time new functionality is added it should be tested. Before writing any test code it is highly recommended you familiarize yourself with the Google Test framework, see the `Google Test primer`_ and `Google Test advanced`_ documentation.
 
 As an example say you add a new class ``Foo``
@@ -168,12 +168,11 @@ Best practices
   - Whenever possible use typed tests.
   - Whenever possible do not write CUDA (or OpenMP) specific tests. Instead write tests a typed test that is templated on the RAJA policy and use a typed test to instantiate it with the appropriate policies.
   - When linking to gtest it is not necessary to include the ``main`` function in the executable because if it is not there ``gtest`` will link in its own ``main``. However you should include ``main`` in each test file to ease debugging. Furthermore if the executable needs some setup or cleanup such as initializing MPI it should be done in main. Note that while it is certainly possible to write tests which take command line arguments it is discouraged because then ``./tests/testThatTakesCommandLineArguments`` no longer works.
-  - For commonly called functions define a macro which first calls ``SCOPED_TRACE`` and then the the function. This helps illuminate exactly where errors are occuring.
+  - For commonly called functions define a macro which first calls ``SCOPED_TRACE`` and then the the function. This helps illuminate exactly where errors are occurring.
   - Prefer the ``EXPECT_`` family of macros to the ``ASSERT_`` family. 
   - Use the most specific ``EXPECT_`` macro applicable. So don't do ``EXPECT_TRUE( bar() == 5 )`` instead use ``EXPECT_EQ( bar(), 5 )``
 
 .. _`Google Test`: https://github.com/google/googletest/tree/306f3754a71d6d1ac644681d3544d06744914228
 .. _`Google Test primer`: https://github.com/google/googletest/blob/306f3754a71d6d1ac644681d3544d06744914228/googletest/docs/primer.md
 .. _`Google Test advanced`: https://github.com/google/googletest/blob/306f3754a71d6d1ac644681d3544d06744914228/googletest/docs/advanced.md
 .. _`typed tests`: https://github.com/google/googletest/blob/306f3754a71d6d1ac644681d3544d06744914228/googletest/docs/advanced.md#typed-tests
-

host-configs/LLNL/lassen-base.cmake

@@ -1,6 +1,6 @@
 # Set up the tpls
 set(GEOSX_TPL_ROOT_DIR /usr/gapps/GEOSX/thirdPartyLibs CACHE PATH "")
-set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-10-08/install-${CONFIG_NAME}-release CACHE PATH "")
+set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-10-15/install-${CONFIG_NAME}-release CACHE PATH "")
 
 set(RAJA_DIR ${GEOSX_TPL_DIR}/raja CACHE PATH "")
 

host-configs/LLNL/[email protected]

@@ -1,9 +1,11 @@
 set(CONFIG_NAME "lassen-clang@upstream" CACHE PATH "") 
 
+
 set(COMPILER_DIR /usr/tce/packages/clang/clang-upstream-2019.03.26 )
 set(CMAKE_C_COMPILER ${COMPILER_DIR}/bin/clang CACHE PATH "")
 set(CMAKE_CXX_COMPILER ${COMPILER_DIR}/bin/clang++ CACHE PATH "")
 
+
 # C++ options
 set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG -mcpu=powerpc64le -mtune=powerpc64le" CACHE STRING "")
 set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-g ${CMAKE_CXX_FLAGS_RELEASE}" CACHE STRING "")

host-configs/LLNL/quartz-base.cmake

@@ -1,7 +1,7 @@
 set(ENABLE_FORTRAN OFF CACHE BOOL "")
 
 set(GEOSX_TPL_ROOT_DIR /usr/gapps/GEOSX/thirdPartyLibs CACHE PATH "")
-set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-10-08/install-${CONFIG_NAME}-release CACHE PATH "")
+set(GEOSX_TPL_DIR ${GEOSX_TPL_ROOT_DIR}/2020-10-15/install-${CONFIG_NAME}-release CACHE PATH "")
 
 set(RAJA_DIR ${GEOSX_TPL_DIR}/raja CACHE PATH "")
 

src/Array.hpp

@@ -114,7 +114,6 @@ class Array : public ArrayView< T,
    * @brief Copy constructor.
    * @param source object to copy.
    * @note Performs a deep copy of source
-   * @return *this.
    */
   LVARRAY_HOST_DEVICE
   Array( Array const & source ):

src/ArrayOfSets.hpp

@@ -72,7 +72,6 @@ class ArrayOfSets : protected ArrayOfSetsView< T, INDEX_TYPE, BUFFER_TYPE >
 
   /**
    * @brief Default move constructor, performs a shallow copy.
-   * @return *this.
    */
   inline
   ArrayOfSets( ArrayOfSets && ) = default;

src/ArrayView.hpp

@@ -120,7 +120,6 @@ class ArrayView
    * @param source The object to copy.
    * @note Triggers the copy constructor for @tparam BUFFER_TYPE. When using the
    *   ChaiBuffer this can move the underlying buffer to a new memory space if the execution context is set.
-   * @return *this
    */
   DISABLE_HD_WARNING
   inline LVARRAY_HOST_DEVICE constexpr
@@ -134,7 +133,6 @@ class ArrayView
   /**
    * @brief Move constructor, creates a shallow copy and invalidates the source.
    * @param source object to move.
-   * @return *this.
    * @note Since this invalidates the source this should not be used when @p source is
    *   the parent of an Array. Do not do this:
    * @code