Intrepid
test_01.cpp
1 // @HEADER
2 // ************************************************************************
3 //
4 // Intrepid Package
5 // Copyright (2007) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Pavel Bochev (pbboche@sandia.gov)
38 // Denis Ridzal (dridzal@sandia.gov), or
39 // Kara Peterson (kjpeter@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
48 #include "Intrepid_FieldContainer.hpp"
49 #include "Intrepid_HDIV_QUAD_I1_FEM.hpp"
50 #include "Teuchos_oblackholestream.hpp"
51 #include "Teuchos_RCP.hpp"
52 #include "Teuchos_GlobalMPISession.hpp"
53 
54 using namespace std;
55 using namespace Intrepid;
56 
57 #define INTREPID_TEST_COMMAND( S , throwCounter, nException ) \
58 { \
59  ++nException; \
60  try { \
61  S ; \
62  } \
63  catch (const std::logic_error & err) { \
64  ++throwCounter; \
65  *outStream << "Expected Error " << nException << " -------------------------------------------------------------\n"; \
66  *outStream << err.what() << '\n'; \
67  *outStream << "-------------------------------------------------------------------------------" << "\n\n"; \
68  }; \
69 }
70 
71 int main(int argc, char *argv[]) {
72 
73  Teuchos::GlobalMPISession mpiSession(&argc, &argv);
74 
75  // This little trick lets us print to std::cout only if
76  // a (dummy) command-line argument is provided.
77  int iprint = argc - 1;
78  Teuchos::RCP<std::ostream> outStream;
79  Teuchos::oblackholestream bhs; // outputs nothing
80  if (iprint > 0)
81  outStream = Teuchos::rcp(&std::cout, false);
82  else
83  outStream = Teuchos::rcp(&bhs, false);
84 
85  // Save the format state of the original std::cout.
86  Teuchos::oblackholestream oldFormatState;
87  oldFormatState.copyfmt(std::cout);
88 
89  *outStream \
90  << "===============================================================================\n" \
91  << "| |\n" \
92  << "| Unit Test (Basis_HDIV_QUAD_I1_FEM) |\n" \
93  << "| |\n" \
94  << "| 1) Conversion of Dof tags into Dof ordinals and back |\n" \
95  << "| 2) Basis values for VALUE and DIV operators |\n" \
96  << "| |\n" \
97  << "| Questions? Contact Pavel Bochev (pbboche@sandia.gov), |\n" \
98  << "| Denis Ridzal (dridzal@sandia.gov), |\n" \
99  << "| Kara Peterson (kjpeter@sandia.gov). |\n" \
100  << "| |\n" \
101  << "| Intrepid's website: http://trilinos.sandia.gov/packages/intrepid |\n" \
102  << "| Trilinos website: http://trilinos.sandia.gov |\n" \
103  << "| |\n" \
104  << "===============================================================================\n"\
105  << "| TEST 1: Basis creation, exception testing |\n"\
106  << "===============================================================================\n";
107 
108  // Define basis and error flag
109  Basis_HDIV_QUAD_I1_FEM<double, FieldContainer<double> > quadBasis;
110  int errorFlag = 0;
111 
112  // Initialize throw counter for exception testing
113  int nException = 0;
114  int throwCounter = 0;
115 
116  // Array with the 4 vertices of the reference Quadrilateral, its center and 4 more points
117  FieldContainer<double> quadNodes(9, 2);
118  quadNodes(0,0) = -1.0; quadNodes(0,1) = -1.0;
119  quadNodes(1,0) = 1.0; quadNodes(1,1) = -1.0;
120  quadNodes(2,0) = 1.0; quadNodes(2,1) = 1.0;
121  quadNodes(3,0) = -1.0; quadNodes(3,1) = 1.0;
122 
123  quadNodes(4,0) = 0.0; quadNodes(4,1) = 0.0;
124  quadNodes(5,0) = 0.0; quadNodes(5,1) = -0.5;
125  quadNodes(6,0) = 0.0; quadNodes(6,1) = 0.5;
126  quadNodes(7,0) = -0.5; quadNodes(7,1) = 0.0;
127  quadNodes(8,0) = 0.5; quadNodes(8,1) = 0.0;
128 
129  // Generic array for the output values; needs to be properly resized depending on the operator type
130  FieldContainer<double> vals;
131 
132  try{
133 
134  int spaceDim = quadBasis.getBaseCellTopology().getDimension();
135 
136  // exception #1: GRAD cannot be applied to HDIV functions
137  // resize vals to rank-3 container with dimensions (num. basis functions, num. points, arbitrary)
138  vals.resize(quadBasis.getCardinality(), quadNodes.dimension(0), spaceDim );
139  INTREPID_TEST_COMMAND( quadBasis.getValues(vals, quadNodes, OPERATOR_GRAD), throwCounter, nException );
140 
141  // exception #2: CURL cannot be applied to HDIV functions
142  INTREPID_TEST_COMMAND( quadBasis.getValues(vals, quadNodes, OPERATOR_CURL), throwCounter, nException );
143 
144  // Exceptions 3-7: all bf tags/bf Ids below are wrong and should cause getDofOrdinal() and
145  // getDofTag() to access invalid array elements thereby causing bounds check exception
146  // exception #3
147  INTREPID_TEST_COMMAND( quadBasis.getDofOrdinal(3,0,0), throwCounter, nException );
148  // exception #4
149  INTREPID_TEST_COMMAND( quadBasis.getDofOrdinal(1,1,1), throwCounter, nException );
150  // exception #5
151  INTREPID_TEST_COMMAND( quadBasis.getDofOrdinal(0,4,1), throwCounter, nException );
152  // exception #6
153  INTREPID_TEST_COMMAND( quadBasis.getDofTag(12), throwCounter, nException );
154  // exception #7
155  INTREPID_TEST_COMMAND( quadBasis.getDofTag(-1), throwCounter, nException );
156 
157 #ifdef HAVE_INTREPID_DEBUG
158  // Exceptions 8- test exception handling with incorrectly dimensioned input/output arrays
159  // exception #8: input points array must be of rank-2
160  FieldContainer<double> badPoints1(4, 5, 3);
161  INTREPID_TEST_COMMAND( quadBasis.getValues(vals, badPoints1, OPERATOR_VALUE), throwCounter, nException );
162 
163  // exception #9 dimension 1 in the input point array must equal space dimension of the cell
164  FieldContainer<double> badPoints2(4, spaceDim + 1);
165  INTREPID_TEST_COMMAND( quadBasis.getValues(vals, badPoints2, OPERATOR_VALUE), throwCounter, nException );
166 
167  // exception #10 output values must be of rank-3 for OPERATOR_VALUE
168  FieldContainer<double> badVals1(4, 5);
169  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals1, quadNodes, OPERATOR_VALUE), throwCounter, nException );
170 
171  // exception #11 output values must be of rank-2 for OPERATOR_DIV
172  FieldContainer<double> badVals2(4, 5, spaceDim);
173  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals2, quadNodes, OPERATOR_DIV), throwCounter, nException );
174 
175  // exception #12 incorrect 0th dimension of output array (must equal number of basis functions)
176  FieldContainer<double> badVals3(quadBasis.getCardinality() + 1, quadNodes.dimension(0), spaceDim);
177  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals3, quadNodes, OPERATOR_VALUE), throwCounter, nException );
178 
179  // exception #13 incorrect 0th dimension of output array (must equal number of basis functions)
180  FieldContainer<double> badVals4(quadBasis.getCardinality() + 1, quadNodes.dimension(0));
181  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals4, quadNodes, OPERATOR_DIV), throwCounter, nException );
182 
183  // exception #14 incorrect 1st dimension of output array (must equal number of points)
184  FieldContainer<double> badVals5(quadBasis.getCardinality(), quadNodes.dimension(0) + 1, spaceDim);
185  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals5, quadNodes, OPERATOR_VALUE), throwCounter, nException );
186 
187  // exception #15 incorrect 1st dimension of output array (must equal number of points)
188  FieldContainer<double> badVals6(quadBasis.getCardinality(), quadNodes.dimension(0) + 1);
189  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals6, quadNodes, OPERATOR_DIV), throwCounter, nException );
190 
191  // exception #16: incorrect 2nd dimension of output array (must equal the space dimension)
192  FieldContainer<double> badVals7(quadBasis.getCardinality(), quadNodes.dimension(0), spaceDim + 1);
193  INTREPID_TEST_COMMAND( quadBasis.getValues(badVals7, quadNodes, OPERATOR_VALUE), throwCounter, nException );
194 #endif
195 
196  }
197  catch (const std::logic_error & err) {
198  *outStream << "UNEXPECTED ERROR !!! ----------------------------------------------------------\n";
199  *outStream << err.what() << '\n';
200  *outStream << "-------------------------------------------------------------------------------" << "\n\n";
201  errorFlag = -1000;
202  };
203 
204  // Check if number of thrown exceptions matches the one we expect
205  if (throwCounter != nException) {
206  errorFlag++;
207  *outStream << std::setw(70) << "^^^^----FAILURE!" << "\n";
208  }
209 
210  *outStream \
211  << "\n"
212  << "===============================================================================\n"\
213  << "| TEST 2: correctness of tag to enum and enum to tag lookups |\n"\
214  << "===============================================================================\n";
215 
216  try{
217  std::vector<std::vector<int> > allTags = quadBasis.getAllDofTags();
218 
219  // Loop over all tags, lookup the associated dof enumeration and then lookup the tag again
220  for (unsigned i = 0; i < allTags.size(); i++) {
221  int bfOrd = quadBasis.getDofOrdinal(allTags[i][0], allTags[i][1], allTags[i][2]);
222 
223  std::vector<int> myTag = quadBasis.getDofTag(bfOrd);
224  if( !( (myTag[0] == allTags[i][0]) &&
225  (myTag[1] == allTags[i][1]) &&
226  (myTag[2] == allTags[i][2]) &&
227  (myTag[3] == allTags[i][3]) ) ) {
228  errorFlag++;
229  *outStream << std::setw(70) << "^^^^----FAILURE!" << "\n";
230  *outStream << " getDofOrdinal( {"
231  << allTags[i][0] << ", "
232  << allTags[i][1] << ", "
233  << allTags[i][2] << ", "
234  << allTags[i][3] << "}) = " << bfOrd <<" but \n";
235  *outStream << " getDofTag(" << bfOrd << ") = { "
236  << myTag[0] << ", "
237  << myTag[1] << ", "
238  << myTag[2] << ", "
239  << myTag[3] << "}\n";
240  }
241  }
242 
243  // Now do the same but loop over basis functions
244  for( int bfOrd = 0; bfOrd < quadBasis.getCardinality(); bfOrd++) {
245  std::vector<int> myTag = quadBasis.getDofTag(bfOrd);
246  int myBfOrd = quadBasis.getDofOrdinal(myTag[0], myTag[1], myTag[2]);
247  if( bfOrd != myBfOrd) {
248  errorFlag++;
249  *outStream << std::setw(70) << "^^^^----FAILURE!" << "\n";
250  *outStream << " getDofTag(" << bfOrd << ") = { "
251  << myTag[0] << ", "
252  << myTag[1] << ", "
253  << myTag[2] << ", "
254  << myTag[3] << "} but getDofOrdinal({"
255  << myTag[0] << ", "
256  << myTag[1] << ", "
257  << myTag[2] << ", "
258  << myTag[3] << "} ) = " << myBfOrd << "\n";
259  }
260  }
261  }
262  catch (const std::logic_error & err){
263  *outStream << err.what() << "\n\n";
264  errorFlag = -1000;
265  };
266 
267  *outStream \
268  << "\n"
269  << "===============================================================================\n"\
270  << "| TEST 3: correctness of basis function values |\n"\
271  << "===============================================================================\n";
272 
273  outStream -> precision(20);
274 
275  // VALUE: Each row pair gives the 6x3 correct basis set values at an evaluation point: (P,F,D) layout
276  double basisValues[] = {
277  0, -0.500000, 0, 0, 0, 0, -0.500000, 0, 0, -0.500000, 0.500000, 0, 0, \
278  0, 0, 0, 0, 0, 0.500000, 0, 0, 0.500000, 0, 0, 0, 0, 0, 0, 0, \
279  0.500000, -0.500000, 0, 0, -0.250000, 0.250000, 0, 0, 0.250000, \
280  -0.250000, 0, 0, -0.375000, 0.250000, 0, 0, 0.125000, -0.250000, 0, \
281  0, -0.125000, 0.250000, 0, 0, 0.375000, -0.250000, 0, 0, -0.250000, \
282  0.125000, 0, 0, 0.250000, -0.375000, 0, 0, -0.250000, 0.375000, 0, 0, \
283  0.250000, -0.125000, 0 };
284 
285  // DIV: each row gives the 6 correct values of the divergence of the 6 basis functions: (P,F) layout
286  double basisDivs[] = {
287  0.25, 0.25, 0.25, 0.25,
288  0.25, 0.25, 0.25, 0.25,
289  0.25, 0.25, 0.25, 0.25,
290  0.25, 0.25, 0.25, 0.25,
291  0.25, 0.25, 0.25, 0.25,
292  0.25, 0.25, 0.25, 0.25,
293  0.25, 0.25, 0.25, 0.25,
294  0.25, 0.25, 0.25, 0.25,
295  0.25, 0.25, 0.25, 0.25,
296  };
297 
298  try{
299 
300  // Dimensions for the output arrays:
301  int numPoints = quadNodes.dimension(0);
302  int numFields = quadBasis.getCardinality();
303  int spaceDim = quadBasis.getBaseCellTopology().getDimension();
304 
305  // Generic array for values and curls that will be properly sized before each call
306  FieldContainer<double> vals;
307 
308  // Check VALUE of basis functions: resize vals to rank-3 container:
309  vals.resize(numFields, numPoints, spaceDim);
310  quadBasis.getValues(vals, quadNodes, OPERATOR_VALUE);
311  for (int i = 0; i < numFields; i++) {
312  for (int j = 0; j < numPoints; j++) {
313  for (int k = 0; k < spaceDim; k++) {
314 
315  // compute offset for (P,F,D) data layout: indices are P->j, F->i, D->k
316  int l = k + i * spaceDim + j * spaceDim * numFields;
317  if (std::abs(vals(i,j,k) - basisValues[l]) > INTREPID_TOL) {
318  errorFlag++;
319  *outStream << std::setw(70) << "^^^^----FAILURE!" << "\n";
320 
321  // Output the multi-index of the value where the error is:
322  *outStream << " At multi-index { ";
323  *outStream << i << " ";*outStream << j << " ";*outStream << k << " ";
324  *outStream << "} computed value: " << vals(i,j,k)
325  << " but reference value: " << basisValues[l] << "\n";
326  }
327  }
328  }
329  }
330 
331  // Check DIV of basis function: resize vals to rank-2 container
332  vals.resize(numFields, numPoints);
333  quadBasis.getValues(vals, quadNodes, OPERATOR_DIV);
334  for (int i = 0; i < numFields; i++) {
335  for (int j = 0; j < numPoints; j++) {
336  int l = i + j * numFields;
337  if (std::abs(vals(i,j) - basisDivs[l]) > INTREPID_TOL) {
338  errorFlag++;
339  *outStream << std::setw(70) << "^^^^----FAILURE!" << "\n";
340 
341  // Output the multi-index of the value where the error is:
342  *outStream << " At multi-index { ";
343  *outStream << i << " ";*outStream << j << " ";
344  *outStream << "} computed divergence component: " << vals(i,j)
345  << " but reference divergence component: " << basisDivs[l] << "\n";
346  }
347  }
348  }
349 
350  }
351 
352  // Catch unexpected errors
353  catch (const std::logic_error & err) {
354  *outStream << err.what() << "\n\n";
355  errorFlag = -1000;
356  };
357 
358  if (errorFlag != 0)
359  std::cout << "End Result: TEST FAILED\n";
360  else
361  std::cout << "End Result: TEST PASSED\n";
362 
363  // reset format state of std::cout
364  std::cout.copyfmt(oldFormatState);
365 
366  return errorFlag;
367 }
Intrepid::Basis::getDofTag
virtual const std::vector< int > & getDofTag(const int dofOrd)
DoF ordinal to DoF tag lookup.
Definition: Intrepid_BasisDef.hpp:78
Intrepid::Basis::getCardinality
virtual int getCardinality() const
Returns cardinality of the basis.
Definition: Intrepid_BasisDef.hpp:100
Intrepid::Basis::getAllDofTags
virtual const std::vector< std::vector< int > > & getAllDofTags()
Retrieves all DoF tags.
Definition: Intrepid_BasisDef.hpp:89
Intrepid_FieldContainer.hpp
Header file for utility class to provide multidimensional containers.
Intrepid::Basis_HDIV_QUAD_I1_FEM::getValues
void getValues(ArrayScalar &outputValues, const ArrayScalar &inputPoints, const EOperator operatorType) const
Evaluation of a FEM basis on a reference Quadrilateral cell.
Definition: Intrepid_HDIV_QUAD_I1_FEMDef.hpp:93
Intrepid_HDIV_QUAD_I1_FEM.hpp
Header file for the Intrepid::HDIV_QUAD_I1_FEM class.
Intrepid::Basis_HDIV_QUAD_I1_FEM
Implementation of the default H(div)-compatible FEM basis of degree 1 on Quadrilateral cell...
Definition: Intrepid_HDIV_QUAD_I1_FEM.hpp:103
Intrepid::FieldContainer::resize
void resize(const int dim0)
Resizes FieldContainer to a rank-1 container with the specified dimension, initialized by 0...
Definition: Intrepid_FieldContainerDef.hpp:1137
Intrepid::Basis::getDofOrdinal
virtual int getDofOrdinal(const int subcDim, const int subcOrd, const int subcDofOrd)
DoF tag to ordinal lookup.
Definition: Intrepid_BasisDef.hpp:51
Intrepid::Basis::getBaseCellTopology
virtual const shards::CellTopology getBaseCellTopology() const
Returns the base cell topology for which the basis is defined. See Shards documentation http://trilin...
Definition: Intrepid_BasisDef.hpp:112
Generated by   doxygen 1.8.5