test_02.cpp

// @HEADER
// ************************************************************************
//
//                           Intrepid Package
//                 Copyright (2007) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Pavel Bochev  (pbboche@sandia.gov)
//                    Denis Ridzal  (dridzal@sandia.gov), or
//                    Kara Peterson (kjpeter@sandia.gov)
//
// ************************************************************************
// @HEADER


#include "Intrepid_FieldContainer.hpp"
#include "Teuchos_oblackholestream.hpp"
#include "Teuchos_RCP.hpp"
#include "Teuchos_GlobalMPISession.hpp"


using namespace Intrepid;

int main(int argc, char *argv[]) {

  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
  
  // This little trick lets us print to cout  only if a (dummy) command-line argument is provided.
  int iprint     = argc - 1;
  
  Teuchos::RCP<std::ostream> outStream;
  Teuchos::oblackholestream bhs; // outputs nothing
  
  if (iprint > 0)
    outStream = Teuchos::rcp(&std::cout, false);
  else
    outStream = Teuchos::rcp(&bhs, false);
  
  // Save the format state of the original cout .
  Teuchos::oblackholestream oldFormatState;
  oldFormatState.copyfmt(std::cout);
  
  *outStream  \
    << "===============================================================================\n" \
    << "|                                                                             |\n" \
    << "|                           Unit Test FieldContainer                          |\n" \
    << "|                                                                             |\n" \
    << "|     1) Testing exception handling                                           |\n" \
    << "|       requires intrepid to be configured with --enable-intrepid-debug       |\n" \
    << "|                                                                             |\n" \
    << "|  Questions? Contact  Pavel Bochev (pbboche@sandia.gov) or                   |\n" \
    << "|                      Denis Ridzal (dridzal@sandia.gov).                     |\n" \
    << "|                                                                             |\n" \
    << "|  Intrepid's website: http://trilinos.sandia.gov/packages/intrepid           |\n" \
    << "|  Trilinos website:   http://trilinos.sandia.gov                             |\n" \
    << "|                                                                             |\n" \
    << "===============================================================================\n";
  
  // Test initializations
  int errorFlag  = 0;
  
  // Define variables to create and use FieldContainers
  Teuchos::Array<int> dimensions;
  Teuchos::Array<int> multiIndex;
  
  // Initialize dimensions for rank-4 multi-index value
  dimensions.resize(4);
  dimensions[0] = 5;
  dimensions[1] = 3;
  dimensions[2] = 2;
  dimensions[3] = 7;
  
  // Create a FieldContainer
  FieldContainer<double> myContainer(dimensions);
  
  // These tests should only run if intrepid was configured with --enable-intrepid-debug option
  // Each test is designed to cause an exception. The total number of all caught exceptions should
  // be the same as the number of tests in this section.
#ifdef HAVE_INTREPID_DEBUG
  
  *outStream << "\n" \
    << "===============================================================================\n"\
    << "| TEST 1: Catching exceptions                                                 |\n"\
    << "===============================================================================\n\n";
  
  int numTestException =16;
  int beginThrowNumber = Teuchos::TestForException_getThrowNumber();
  int endThrowNumber = beginThrowNumber + numTestException;
  
  try{ // Outer try block contains all tests for exception
    
    
    try{ // catch exception (1)
      
      //  Trying to  get enumeration using multi-index with the wrong rank:
      *outStream << "\n" \
      << "===============================================================================\n"\
      << "  Trying to  get enumeration using multi-index with the wrong rank: \n";
      multiIndex.resize(5);
      multiIndex[0] = 3; 
      multiIndex[1] = 1;
      multiIndex[2] = 2;
      multiIndex[3] = 2;
      multiIndex[4] = 6;
      myContainer.getEnumeration(multiIndex);
    }
    catch (std::logic_error err) {
      *outStream  << err.what() << "\n";
    };
    
    
    
    try{ // catch exception (2)
      
      // Trying to get enumeration using multi-index that is out of bounds: 3rd index is 4, must be <2
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Trying to get enumeration using multi-index that is out of bounds: \n";
      multiIndex.resize(4);
      multiIndex[0] = 3; 
      multiIndex[1] = 1;
      multiIndex[2] = 4;
      multiIndex[3] = 2;
      myContainer.getEnumeration(multiIndex);
    }
    catch (std::logic_error err) {
      *outStream  << err.what() << "\n";
    };
    
 
    
    try{  // catch exception (3)
      
      // Trying to set values from array whose size is less than FieldContainer's size:
      *outStream << "\n" \
      << "===============================================================================\n"\
      <<  " Trying to set values from array whose size is less than FieldContainer's size: \n";
      
      // Change one of the values of the dimensions to a lesser value: original value was 5 
      dimensions[0] = 4;
      
      // Define Teuchos::Array to store values with dimension equal to the number of multi-indexed values
      Teuchos::Array<double> dataTeuchosArray(4*3*2*7);
      
      // Fill with data
      int counter = 0;
      for(int i=0; i < dimensions[0]; i++){
        for(int j=0; j < dimensions[1]; j++){
          for(int k=0; k < dimensions[2]; k++){
            for(int l = 0; l < dimensions[3]; l++){
              dataTeuchosArray[counter] = (double)counter;
              counter++;
            }
          }
        }
      }
      
      // Now try to stuff this data into FieldContainer
      myContainer.setValues(dataTeuchosArray);
    }
    catch (std::logic_error err) {
      *outStream  << err.what() << "\n";
    };
    
    
    
    try{  // catch exception (4)
      
      // Trying to set values from array whose size is greater than FieldContainer's size:
      *outStream << "\n" \
      << "===============================================================================\n"\
      <<  " Trying to set values from array whose size is greater than FieldContainer's size: \n";
      
      // Change one of the values of the dimensions to a lesser value: restore dimensions[0] to the 
      // value used to construct the LexArray and change dimensions[2] to a greater value
      dimensions[0] = 5;
      dimensions[2] = 3;
      
      // Define Teuchos::Array to store values with dimension equal to the number of multi-indexed values
      Teuchos::ArrayRCP<double> dataTeuchosArray(5*3*3*7);
      
      // Fill with data
      int counter = 0;
      for(int i=0; i < dimensions[0]; i++){
        for(int j=0; j < dimensions[1]; j++){
          for(int k=0; k < dimensions[2]; k++){
            for(int l = 0; l < dimensions[3]; l++){
              dataTeuchosArray[counter] = (double)counter;
              counter++;
            }
          }
        }
      }
      
      // Now try to stuff this data into FieldContainer
      myContainer.setValues(dataTeuchosArray());
    }
    catch (std::logic_error err) {
      *outStream  << err.what() << "\n";
    };
    
    
    
    try{ // catch exception (5)
      
      // Trying to use [] with enumeration that is out of range:
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Trying to use [] with enumeration that is out of range: \n";
      myContainer[1000];
    }
    catch (std::logic_error err) {
      *outStream  << err.what() << "\n";
    }
    
    
    
    try{ // catch exception (6)
      
      // Trying to get multi-index from enumeration that is out of bounds:
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Trying to get multi-index from enumeration that is out of bounds: \n";
      myContainer.getMultiIndex(multiIndex,10000);
    }
    catch(std::logic_error err) {
     *outStream << err.what() << "\n";
    }
    
  
    
    try{ // catch exception (7)
      
      //Trying to self-assign FieldContainer
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Trying to self-assign FieldContainer \n";
      myContainer = myContainer;
    }
    catch(std::logic_error err) {
      *outStream << err.what() << "\n"; 
    }

    
    // Container of rank-1
    FieldContainer<double> rank1Container(3);
    
    // catch exception (8): method is for rank-2 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " using a method for rank-2 container \n";
      rank1Container.getEnumeration(1,1); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (9): method is for rank-3 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " using a method for rank-3 container \n";
      rank1Container.getEnumeration(1,1,1); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (10): method is for rank-4 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " using a method for rank-4 container \n";
      rank1Container.getEnumeration(1,1,1,1); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (11): method is for rank-5 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " using a method for rank-5 container \n";
      rank1Container.getEnumeration(1,1,1,1,1); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (12): 4 is out of bounds
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " The specified enumeration is out of bounds \n";
      int i0;
      rank1Container.getMultiIndex(i0,4); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (13): method for rank-2 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Using a method for rank-2 containers \n";
      int i0,i1;
      rank1Container.getMultiIndex(i0,i1,2); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    // catch exception (14): method for rank-3 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Using a method for rank-2 containers \n";
      int i0,i1,i2;
      rank1Container.getMultiIndex(i0,i1,i2,2); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    
    // catch exception (15): method for rank-4 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Using a method for rank-4 containers \n";
      int i0,i1,i2,i3;
      rank1Container.getMultiIndex(i0,i1,i2,i3,2); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    
    // catch exception (16): method for rank-5 container
    try{  
      *outStream << "\n" \
      << "===============================================================================\n"\
      << " Using a method for rank-5 containers \n";
      int i0,i1,i2,i3,i4;
      rank1Container.getMultiIndex(i0,i1,i2,i3,i4,2); 
    }
    catch(std::logic_error err){
      *outStream << err.what() << "\n";
    }
    
    
    // Check if number of caught exceptions matches the expected number
    if (Teuchos::TestForException_getThrowNumber() != endThrowNumber) {
      errorFlag++;
      
    }
  } // outer try block
  catch (std::logic_error err) {
    *outStream << "UNEXPECTED ERROR !!! ----------------------------------------------------------\n";
    *outStream  << err.what() << "\n";
    *outStream << "-------------------------------------------------------------------------------" << "\n\n";
    errorFlag = -1000;
  }
#endif
  
  if (errorFlag != 0)
    std::cout << "End Result: TEST FAILED\n";
  else
    std::cout << "End Result: TEST PASSED\n";
  
  // reset format state of std::cout
  std::cout.copyfmt(oldFormatState);
  
  return errorFlag;
}