Thyra Package Browser (Single Doxygen Collection)  Version of the Day
EpetraThyraWrappers_UnitTests.cpp
Go to the documentation of this file.
1 /*
2 // @HEADER
3 // ***********************************************************************
4 //
5 // Thyra: Interfaces and Support for Abstract Numerical Algorithms
6 // Copyright (2004) Sandia Corporation
7 //
8 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
9 // license for use of this work by or on behalf of the U.S. Government.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
39 //
40 // ***********************************************************************
41 // @HEADER
42 */
43 
44 #include "Thyra_DefaultProductVectorSpace.hpp"
45 #include "Thyra_VectorStdOps.hpp"
46 #include "Thyra_MultiVectorStdOps.hpp"
47 #include "Thyra_SpmdVectorSpaceBase.hpp"
48 #include "Thyra_VectorSpaceTester.hpp"
49 #include "Thyra_TestingTools.hpp"
50 #include "Epetra_Vector.h"
51 #include "Teuchos_GlobalMPISession.hpp"
52 
54 
55 #include "Teuchos_UnitTestHarness.hpp"
56 
57 
58 namespace {
59 
60 
61 using Teuchos::ptrFromRef;
62 using Teuchos::Comm;
63 using Teuchos::rcp_dynamic_cast;
64 using Teuchos::rcp;
65 
66 
67 void runVectorSpaceTesterTest(const int emptyProc,
68  Teuchos::FancyOStream &out, bool &success)
69 {
70  using Thyra::VectorSpaceBase;
71  using Thyra::SpmdVectorSpaceBase;
72  using Thyra::MultiVectorBase;
73 
74  RCP<const VectorSpaceBase<double> > vs;
75  RCP<const Epetra_Map> epetra_map;
76  createEpetraVsAndMap(g_localDim, outArg(vs), outArg(epetra_map), emptyProc);
77  const int numProcs = epetra_map->Comm().NumProc();
78 
79  if (emptyProc >= numProcs) {
80  out << "emptyProc = " << emptyProc << " >= numProcs = " << numProcs
81  << ": Skipping this test case!\n";
82  return;
83  }
84 
85  const Ordinal dimMultiplier = (emptyProc < 0 ? numProcs : numProcs-1);
86 
87  TEST_EQUALITY(vs->dim(), g_localDim * dimMultiplier);
88 
89  const RCP<const SpmdVectorSpaceBase<double> > spmd_vs =
90  rcp_dynamic_cast<const SpmdVectorSpaceBase<double> >(vs, true);
91 
92  TEST_EQUALITY(spmd_vs->localSubDim(), as<int>(epetra_map->NumMyElements()));
93 
94  Thyra::VectorSpaceTester<double> vectorSpaceTester;
95  const double tol = 100.0 * Teuchos::ScalarTraits<double>::eps();
96  vectorSpaceTester.warning_tol((0.1)*tol);
97  vectorSpaceTester.error_tol(tol);
98  vectorSpaceTester.show_all_tests(g_show_all_tests);
99  vectorSpaceTester.dump_all(g_dumpAll);
100  TEST_ASSERT(vectorSpaceTester.check(*vs, &out));
101 }
102 
103 
104 void runCreateVectorUnitTest(const int emptyProc,
105  Teuchos::FancyOStream &out, bool &success)
106 {
107  using Thyra::VectorBase;
108  using Thyra::VectorSpaceBase;
109  using Thyra::MultiVectorBase;
110 
111  RCP<const VectorSpaceBase<double> > vs;
112  RCP<const Epetra_Map> epetra_map;
113  createEpetraVsAndMap(g_localDim, outArg(vs), outArg(epetra_map), emptyProc);
114  const int numProcs = epetra_map->Comm().NumProc();
115 
116  if (emptyProc >= numProcs) {
117  out << "emptyProc = " << emptyProc << " >= numProcs = " << numProcs
118  << ": Skipping this test case!\n";
119  return;
120  }
121 
122  const RCP<Epetra_Vector> epetra_vec = rcp(new Epetra_Vector(*epetra_map));
123  const RCP<VectorBase<double> > thyra_vec = Thyra::create_Vector(epetra_vec, vs);
124  const RCP<Epetra_Vector> epetra_vec2 =
125  Thyra::get_Epetra_Vector(*epetra_map, thyra_vec);
126  TEST_EQUALITY(epetra_vec, epetra_vec2);
127 
128  const RCP<const Epetra_Vector> const_epetra_vec2 =
129  Thyra::get_Epetra_Vector(*epetra_map, thyra_vec.getConst());
130  TEST_EQUALITY(epetra_vec.getConst(), const_epetra_vec2);
131 
132 }
133 
134 
135 //
136 // Unit Tests
137 //
138 
139 
140 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, comm )
141 {
142  typedef Teuchos::GlobalMPISession GMPIS;
143  const RCP<const Epetra_Comm> epetra_comm = getEpetraComm();
144  TEST_EQUALITY(epetra_comm->NumProc(), GMPIS::getNProc());
145  TEST_EQUALITY(epetra_comm->MyPID(), GMPIS::getRank());
146  const RCP<const Comm<Ordinal> > comm = Thyra::create_Comm(epetra_comm);
147  TEST_EQUALITY(comm->getSize(), GMPIS::getNProc());
148  TEST_EQUALITY(comm->getRank(), GMPIS::getRank());
149  const RCP<const Epetra_Comm> epetra_comm2 = Thyra::get_Epetra_Comm(*comm);
150  TEST_EQUALITY(epetra_comm2->NumProc(), GMPIS::getNProc());
151  TEST_EQUALITY(epetra_comm2->MyPID(), GMPIS::getRank());
152 }
153 
154 
155 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, vectorSpaceTester )
156 {
157  runVectorSpaceTesterTest(-1, out, success);
158 }
159 
160 
161 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, vectorSpaceTester_empty_p0 )
162 {
163  runVectorSpaceTesterTest(0, out, success);
164 }
165 
166 
167 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, vectorSpaceTester_empty_p1 )
168 {
169  runVectorSpaceTesterTest(1, out, success);
170 }
171 
172 
173 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, vectorSpaceTester_empty_pLast )
174 {
175  runVectorSpaceTesterTest(Teuchos::GlobalMPISession::getNProc()-1, out, success);
176 }
177 
178 
179 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, createAndViewVector_empty_p0 )
180 {
181  runCreateVectorUnitTest(0, out, success);
182 }
183 
184 
185 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, createAndViewVector_empty_p1 )
186 {
187  runCreateVectorUnitTest(1, out, success);
188 }
189 
190 
191 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, createAndViewVector_empty_pLast )
192 {
193  runCreateVectorUnitTest(Teuchos::GlobalMPISession::getNProc()-1, out, success);
194 }
195 
196 
197 // Test Thyra::create_MultiVector() (const and nonconst) and all views with empty processes
198 
199 
200 TEUCHOS_UNIT_TEST( EpetraThyraWrappers, get_Epetra_MultiVector_singleBlockProductVector )
201 {
202 using Thyra::VectorSpaceBase;
203 using Thyra::MultiVectorBase;
204 
205  RCP<const VectorSpaceBase<double> > vs;
206  RCP<const Epetra_Map> epetra_map;
207  createEpetraVsAndMap(g_localDim, outArg(vs), outArg(epetra_map));
208 
209  const RCP<const VectorSpaceBase<double> > pvs = Thyra::productVectorSpace(vs, 1);
210 
211  const RCP<MultiVectorBase<double> > pmv = Thyra::createMembers(pvs, 1);
212 
213  const double alpha = 3.5;
214  Thyra::assign<double>( pmv.ptr(), alpha );
215 
216  const RCP<Epetra_MultiVector> epetra_mv =
217  Thyra::get_Epetra_MultiVector(*epetra_map, pmv);
218 
219  const RCP<MultiVectorBase<double> > mv2 =
220  Thyra::create_MultiVector(epetra_mv, pvs);
221 
222  Thyra::testRelNormDiffErr<double>(
223  "*pmv->col(0)", *pmv->col(0),
224  "*mv2->col(0)", *mv2->col(0),
225  "max-error", 0.0,
226  "max-warning", 0.0,
227  &out
228  );
229 
230 }
231 
232 
233 } // namespace
RCP< Epetra_MultiVector > get_Epetra_MultiVector(const Epetra_Map &map, const RCP< MultiVectorBase< double > > &mv)
Get a non-const Epetra_MultiVector view from a non-const MultiVectorBase object if possible...
RCP< MultiVectorBase< double > > create_MultiVector(const RCP< Epetra_MultiVector > &epetra_mv, const RCP< const VectorSpaceBase< double > > &range, const RCP< const VectorSpaceBase< double > > &domain=Teuchos::null)
Create a non-const MultiVectorBase object from a non-const Epetra_MultiVector object.
TEUCHOS_UNIT_TEST(EpetraOperatorWrapper, basic)
RCP< VectorBase< double > > create_Vector(const RCP< Epetra_Vector > &epetra_v, const RCP< const VectorSpaceBase< double > > &space)
Create a non-const VectorBase object from a non-const Epetra_Vector object.
RCP< Epetra_Vector > get_Epetra_Vector(const Epetra_Map &map, const RCP< VectorBase< double > > &v)
Get a non-const Epetra_Vector view from a non-const VectorBase object if possible.
RCP< const Epetra_Comm > get_Epetra_Comm(const Teuchos::Comm< Ordinal > &comm)
Get (or create) and Epetra_Comm given a Teuchos::Comm object.
Teuchos_Ordinal Ordinal
RCP< const Teuchos::Comm< Ordinal > > create_Comm(const RCP< const Epetra_Comm > &epetraComm)
Given an Epetra_Comm object, return an equivalent Teuchos::Comm object.