/usr/include/trilinos/Thyra_ModelEvaluatorBase_decl.hpp is in libtrilinos-thyra-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 | // @HEADER
// ***********************************************************************
//
// Thyra: Interfaces and Support for Abstract Numerical Algorithms
// Copyright (2004) 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 Roscoe A. Bartlett (bartlettra@ornl.gov)
//
// ***********************************************************************
// @HEADER
#ifndef THYRA_MODEL_EVALUATOR_BASE_DECL_HPP
#define THYRA_MODEL_EVALUATOR_BASE_DECL_HPP
#include "Thyra_LinearOpWithSolveBase.hpp"
#include "Teuchos_Describable.hpp"
#include "Teuchos_any.hpp"
#include "Teuchos_Assert.hpp"
#ifdef HAVE_THYRA_ME_POLYNOMIAL
# include "Teuchos_Polynomial.hpp"
#endif
namespace Stokhos {
class ProductEpetraVector;
class ProductEpetraMultiVector;
class ProductEpetraOperator;
}
namespace Thyra {
/** \brief Base subclass for <tt>ModelEvaluator</tt> that defines some basic
* types.
*
* This non-templated base class is used for two very important reasons.
*
* First, a non-templated base class holding templated nested classes makes it
* easier for client to form the names of the nested classes. This also makes
* it easier to access non-tempated enum types and values as well. While most
* of these nested types could have been defined outside of a base class, by
* putting them in a base class, we get better namespace scoping and can
* therefore use shorter names.
*
* Second, there are some protected nested classes (i.e. <tt>InArgsSetup</tt>
* and <tt>OutArgsSetup</tt>0 that only subclasses should be able to access.
* This makes the design very secure to help avoid bad usage of the nested
* classes.
*
* \ingroup Thyra_Nonlinear_model_evaluator_interfaces_code_grp
*/
class ModelEvaluatorBase
: virtual public Teuchos::Describable,
virtual public Teuchos::VerboseObject<ModelEvaluatorBase>
{
public:
/** \name Public types */
//@{
/** \brief . */
enum EInArgsMembers {
IN_ARG_x_dot_dot ///< .
,IN_ARG_x_dot ///< .
,IN_ARG_x ///< .
,IN_ARG_x_dot_poly ///< .
,IN_ARG_x_poly ///< .
,IN_ARG_x_dot_mp ///< .
,IN_ARG_x_mp ///< .
,IN_ARG_t ///< .
,IN_ARG_alpha ///< .
,IN_ARG_beta ///< .
,IN_ARG_W_x_dot_dot_coeff ///< .
,IN_ARG_step_size///< .
,IN_ARG_stage_number///< .
};
/** \brief . */
static const int NUM_E_IN_ARGS_MEMBERS=13;
/** \brief . */
enum EInArgs_p_mp {
IN_ARG_p_mp ///< .
};
/** \brief Concrete aggregate class for all input arguments computable by a
* <tt>ModelEvaluator</tt> subclass object.
*
* The set of supported objects is returned from the <tt>supports()</tt>
* function.
*
* A client can not directly set what input arguments are supported or not
* supported. Only a subclass of <tt>ModelEvaluator</tt> can do that
* (through the <tt>InArgsSetup</tt> subclass).
*
* Extended types: The methods for %supports(), set() and get() that
* are templated on the <tt>ObjectType</tt> are used to support what
* are called extended types. This functionality allows developers
* to inject new objects into the ModelEvaluator evaluations. This
* can be used for expermenting with new capabilities that require
* adding new/special arguments to the inArgs. This also can be used
* to reduce the clutter and complexity of the model evaluator
* inArgs object. For example, users could create their own inArgs
* for a stochastic computation:
*
* \code{.cpp}
* struct StochasticInArgs {
* StochLib::MultiVector<Scalar> stochastic_x;
* ...
* };
* \endcode
*
* This object could then be used in a model evaluator without
* changing the base classes in Thyra:
*
* \code{.cpp}
* auto inArgs = model->createInArgs();
* assert(inArgs.template supports<StochasticInArgs<Scalar>>());
*
* RCP<StochasticInArgs> stochInArgs = rcp(new StochasticInArgs<Scalar>);
*
* stochInArgs->stochastic_x = ... // create and set objects
* ...
*
* inArgs.set(stochInArgs);
* \endcode
*/
template<class Scalar>
class InArgs : public Teuchos::Describable {
public:
/** \brief . */
typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType ScalarMag;
/** \brief . */
InArgs();
/** \brief Return the number of parameter subvectors <tt>p(l)</tt>
* supported (<tt>Np >= 0</tt>). */
int Np() const;
/** \brief Determines if an input argument is supported or not. */
bool supports(EInArgsMembers arg) const;
/** \brief Precondition: <tt>supports(IN_ARG_x_dot_dot)==true</tt>. */
void set_x_dot_dot( const RCP<const VectorBase<Scalar> > &x_dot_dot );
/** \brief Precondition: <tt>supports(IN_ARG_x_dot_dot)==true</tt>. */
RCP<const VectorBase<Scalar> > get_x_dot_dot() const;
/** \brief Precondition: <tt>supports(IN_ARG_x_dot)==true</tt>. */
void set_x_dot( const RCP<const VectorBase<Scalar> > &x_dot );
/** \brief Precondition: <tt>supports(IN_ARG_x_dot)==true</tt>. */
RCP<const VectorBase<Scalar> > get_x_dot() const;
/** \brief Precondition: <tt>supports(IN_ARG_x)==true</tt>. */
void set_x( const RCP<const VectorBase<Scalar> > &x );
/** \brief Precondition: <tt>supports(IN_ARG_x)==true</tt>. */
RCP<const VectorBase<Scalar> > get_x() const;
/** \brief Determines if an extended input argument of type <tt>ObjectType</tt> is supported. */
template<typename ObjectType>
bool supports() const;
/** \brief Set an extended input object of type <tt>ObjectType</tt> in the InArgs. Precondition: <tt>supports()==true</tt>. */
template<typename ObjectType>
void set(const RCP<const ObjectType>& uo);
/** \brief Get an extended input object of type <tt>ObjectType>/tt> from the InArgs. Precondition: <tt>supports()==true</tt>. */
template<typename ObjectType>
RCP<const ObjectType> get() const;
#ifdef HAVE_THYRA_ME_POLYNOMIAL
/** \brief Precondition: <tt>supports(IN_ARG_x_poly)==true</tt>. */
void set_x_poly(
const RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > &x_poly );
/** \brief Precondition: <tt>supports(IN_ARG_x)==true</tt>. */
RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > get_x_poly() const;
/** \brief Precondition: <tt>supports(IN_ARG_x_dot_poly)==true</tt>. */
void set_x_dot_poly(
const RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > &x_dot_poly );
/** \brief Precondition: <tt>supports(IN_ARG_x_dot_poly)==true</tt>. */
RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > get_x_dot_poly() const;
#endif // HAVE_THYRA_ME_POLYNOMIAL
/** \brief Set <tt>p(l)</tt> where <tt>0 <= l && l < this->Np()</tt>. */
void set_p( int l, const RCP<const VectorBase<Scalar> > &p_l );
/** \brief Get <tt>p(l)</tt> where <tt>0 <= l && l < this->Np()</tt>. */
RCP<const VectorBase<Scalar> > get_p(int l) const;
/** \brief Precondition: <tt>supports(IN_ARG_x_dot_mp)==true</tt>. */
void set_x_dot_mp( const RCP<const Stokhos::ProductEpetraVector > &x_dot_mp );
/** \brief Precondition: <tt>supports(IN_ARG_x_dotmp)==true</tt>. */
RCP<const Stokhos::ProductEpetraVector > get_x_dot_mp() const;
/** \brief Precondition: <tt>supports(IN_ARG_x_mp)==true</tt>. */
void set_x_mp( const RCP<const Stokhos::ProductEpetraVector > &x_mp );
/** \brief Precondition: <tt>supports(IN_ARG_x_mp)==true</tt>. */
RCP<const Stokhos::ProductEpetraVector > get_x_mp() const;
void set_p_mp( int l, const RCP<const Stokhos::ProductEpetraVector > &p_mp_l );
RCP<const Stokhos::ProductEpetraVector > get_p_mp(int l) const;
/** Whether p_mp is supported for parameter vector l */
bool supports(EInArgs_p_mp arg, int l) const;
/** \brief Precondition: <tt>supports(IN_ARG_t)==true</tt>. */
void set_t( ScalarMag t );
/** \brief .Precondition: <tt>supports(IN_ARG_t)==true</tt> */
ScalarMag get_t() const;
/** \brief Precondition: <tt>supports(IN_ARG_alpha)==true</tt>. */
void set_alpha( Scalar alpha );
/** \brief Precondition: <tt>supports(IN_ARG_alpha)==true</tt>. */
Scalar get_alpha() const;
/** \brief Precondition: <tt>supports(IN_ARG_beta)==true</tt>. */
void set_beta( Scalar beta );
/** \brief Precondition: <tt>supports(IN_ARG_beta)==true</tt>. */
Scalar get_beta() const;
/** \brief Precondition: <tt>supports(IN_ARG_W_x_dot_dot_coeff)==true</tt>. */
void set_W_x_dot_dot_coeff( Scalar W_x_dot_dot_coeff );
/** \brief Precondition: <tt>supports(IN_ARG_W_x_dot_dot_coeff)==true</tt>. */
Scalar get_W_x_dot_dot_coeff() const;
/** \brief Precondition: <tt>supports(IN_ARG_step_size)==true</tt>. */
void set_step_size( Scalar step_size);
/** \brief Precondition: <tt>supports(IN_ARG_step_size)==true</tt>. */
Scalar get_step_size() const;
/** \brief Precondition: <tt>supports(IN_ARG_stage_number)==true</tt>. */
void set_stage_number( Scalar stage_number);
/** \brief Precondition: <tt>supports(IN_ARG_stage_number)==true</tt>. */
Scalar get_stage_number() const;
/** \brief Set non-null arguments (does not overwrite non-NULLs with
* NULLs) . */
void setArgs(
const InArgs<Scalar>& inArgs, bool ignoreUnsupported = false,
bool cloneObjects = false
);
/** \brief Assert that two InArgs objects have the same support.*/
void assertSameSupport( const InArgs<Scalar> &inArgs ) const;
/** \brief . */
std::string modelEvalDescription() const;
/** \brief . */
std::string description() const;
/** \brief Create a more detailed description along about this object and
* the ModelEvaluator that created it. */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const;
protected:
/** \brief . */
void _setModelEvalDescription( const std::string &modelEvalDescription );
/** \brief . */
void _set_Np(int Np);
/** \brief . */
void _setSupports( EInArgsMembers arg, bool supports );
/** \brief . */
void _setSupports( EInArgs_p_mp arg, int l, bool supports );
/** \brief . */
void _setSupports( const InArgs<Scalar>& inputInArgs, const int Np );
/** \brief . */
template<typename ObjectType>
void _setSupports( const bool supports );
/** \brief . */
void _setUnsupportsAndRelated( EInArgsMembers arg );
private:
// types
typedef Teuchos::Array<RCP<const VectorBase<Scalar> > > p_t;
// data
std::string modelEvalDescription_;
RCP<const VectorBase<Scalar> > x_dot_dot_;
RCP<const VectorBase<Scalar> > x_dot_;
RCP<const VectorBase<Scalar> > x_;
RCP<const Stokhos::ProductEpetraVector > x_dot_mp_;
RCP<const Stokhos::ProductEpetraVector > x_mp_;
Teuchos::Array< RCP< const Stokhos::ProductEpetraVector > > p_mp_;
#ifdef HAVE_THYRA_ME_POLYNOMIAL
RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > x_dot_poly_;
RCP<const Teuchos::Polynomial< VectorBase<Scalar> > > x_poly_;
#endif // HAVE_THYRA_ME_POLYNOMIAL
p_t p_;
ScalarMag t_;
Scalar alpha_;
Scalar beta_;
Scalar W_x_dot_dot_coeff_;
Scalar step_size_;
Scalar stage_number_;
bool supports_[NUM_E_IN_ARGS_MEMBERS];
Teuchos::Array<bool> supports_p_mp_; //Np
// functions
void assert_supports(EInArgsMembers arg) const;
void assert_supports(EInArgs_p_mp arg, int l) const;
void assert_l(int l) const;
std::map<std::string,Teuchos::any> extended_inargs_;
};
/** \brief The type of an evaluation. */
enum EEvalType {
EVAL_TYPE_EXACT = 0, /// Do an exact evaluation (default)
EVAL_TYPE_APPROX_DERIV, /// An approx. eval. for a F.D. deriv.
EVAL_TYPE_VERY_APPROX_DERIV /// An approx. eval. for a F.D. prec.
};
/** \brief Type to embed evaluation accuracy with an RCP-managed object.
*
* This type derives from Teuchos::RCP and therefore is a drop in
* replacement for an RCP object as it implicitly converts to an from such a
* type.
*/
template<class ObjType>
class Evaluation : public RCP<ObjType> {
public:
/** \brief . */
Evaluation(Teuchos::ENull)
: evalType_(EVAL_TYPE_EXACT) {}
/** \brief . */
Evaluation() : evalType_(EVAL_TYPE_EXACT) {}
/** \brief Implicit conversion from RCP<ObjType>. */
Evaluation( const RCP<ObjType> &obj )
: RCP<ObjType>(obj), evalType_(EVAL_TYPE_EXACT) {}
/** \brief . */
Evaluation( const RCP<ObjType> &obj, EEvalType evalType )
: RCP<ObjType>(obj), evalType_(evalType) {}
/** \brief . */
EEvalType getType() const { return evalType_; }
/** \brief . */
void reset( const RCP<ObjType> &obj, EEvalType evalType )
{ this->operator=(obj); evalType_ = evalType; }
private:
EEvalType evalType_;
};
/** \brief . */
enum EDerivativeMultiVectorOrientation {
DERIV_MV_JACOBIAN_FORM, ///< Jacobian form DhDz (nz columns of h_space vectors)
DERIV_MV_GRADIENT_FORM, ///< Gradient form DhDz^T (nh columns of z_space vectors)
DERIV_MV_BY_COL = DERIV_MV_JACOBIAN_FORM, ///< Deprecated!
DERIV_TRANS_MV_BY_ROW = DERIV_MV_GRADIENT_FORM ///< Deprecated!
};
/** \brief . */
enum EDerivativeLinearOp {
DERIV_LINEAR_OP ///< .
};
/** \brief Determines the forms of a general derivative that are
* supported. */
class DerivativeSupport {
public:
/** \brief . */
DerivativeSupport()
:supportsLinearOp_(false), supportsMVByCol_(false), supportsTransMVByRow_(false)
{}
/** \brief . */
DerivativeSupport( EDerivativeLinearOp )
:supportsLinearOp_(true), supportsMVByCol_(false), supportsTransMVByRow_(false)
{}
/** \brief . */
DerivativeSupport( EDerivativeMultiVectorOrientation mvOrientation )
:supportsLinearOp_(false), supportsMVByCol_(mvOrientation==DERIV_MV_BY_COL)
,supportsTransMVByRow_(mvOrientation==DERIV_TRANS_MV_BY_ROW)
{}
/** \brief . */
DerivativeSupport& plus(EDerivativeLinearOp)
{ supportsLinearOp_ = true; return *this; }
/** \brief . */
DerivativeSupport& plus(EDerivativeMultiVectorOrientation mvOrientation)
{
switch(mvOrientation) {
case DERIV_MV_BY_COL: supportsMVByCol_ = true; break;
case DERIV_TRANS_MV_BY_ROW: supportsTransMVByRow_ = true; break;
default: TEUCHOS_TEST_FOR_EXCEPT(true);
}
return *this;
}
/** \brief . */
bool none() const
{ return ( !supportsLinearOp_ && !supportsMVByCol_ && !supportsTransMVByRow_ ); }
/** \brief . */
bool supports(EDerivativeLinearOp) const
{ return supportsLinearOp_; }
/** \brief . */
bool supports(EDerivativeMultiVectorOrientation mvOrientation) const
{
switch(mvOrientation) {
case DERIV_MV_BY_COL: return supportsMVByCol_;
case DERIV_TRANS_MV_BY_ROW: return supportsTransMVByRow_;
default: TEUCHOS_TEST_FOR_EXCEPT(true);
}
TEUCHOS_UNREACHABLE_RETURN(false);
}
/** \brief . */
bool isSameSupport(const DerivativeSupport &derivSupport) const
{
return (
supportsLinearOp_ == derivSupport.supportsLinearOp_
&& supportsMVByCol_ == derivSupport.supportsMVByCol_
&& supportsTransMVByRow_ == derivSupport.supportsTransMVByRow_
);
}
/** \brief . */
std::string description() const;
private:
bool supportsLinearOp_;
bool supportsMVByCol_;
bool supportsTransMVByRow_;
public:
};
/** \brief . */
enum EDerivativeLinearity {
DERIV_LINEARITY_UNKNOWN ///< .
,DERIV_LINEARITY_CONST ///< .
,DERIV_LINEARITY_NONCONST ///< .
};
/** \brief . */
enum ERankStatus {
DERIV_RANK_UNKNOWN ///< .
,DERIV_RANK_FULL ///< .
,DERIV_RANK_DEFICIENT ///< .
};
/** \brief Simple public strict containing properties of a derivative
* object. */
struct DerivativeProperties {
/** \brief . */
EDerivativeLinearity linearity;
/** \brief . */
ERankStatus rank;
/** \brief . */
bool supportsAdjoint;
/** \brief . */
DerivativeProperties()
:linearity(DERIV_LINEARITY_UNKNOWN),
rank(DERIV_RANK_UNKNOWN),supportsAdjoint(false)
{}
/** \brief . */
DerivativeProperties(
EDerivativeLinearity in_linearity, ERankStatus in_rank,
bool in_supportsAdjoint
)
:linearity(in_linearity),rank(in_rank),
supportsAdjoint(in_supportsAdjoint)
{}
};
/** \brief Simple aggregate class for a derivative object represented as a
* column-wise multi-vector or its transpose as a row-wise multi-vector.
*/
template<class Scalar>
class DerivativeMultiVector {
public:
/** \brief . */
DerivativeMultiVector()
:orientation_(DERIV_MV_BY_COL)
{}
/** \brief . */
DerivativeMultiVector(
const RCP<MultiVectorBase<Scalar> > &mv
,const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
) : mv_(mv.assert_not_null()), orientation_(orientation) {}
/** \brief . */
void changeOrientation( const EDerivativeMultiVectorOrientation orientation )
{ orientation_ = orientation; };
/** \brief . */
const DerivativeMultiVector<Scalar>& assert_not_null() const
{ mv_.assert_not_null(); return *this; }
/** \brief . */
RCP<MultiVectorBase<Scalar> > getMultiVector() const
{ return mv_; }
/** \brief . */
EDerivativeMultiVectorOrientation getOrientation() const
{ return orientation_; }
/** \brief . */
std::string description() const;
/** \brief . */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const;
private:
RCP<MultiVectorBase<Scalar> > mv_;
EDerivativeMultiVectorOrientation orientation_;
};
/** \brief Simple aggregate class that stores a derivative object
* as a general linear operator or as a multi-vector.
*/
template<class Scalar>
class Derivative {
public:
/** \brief . */
Derivative() {}
/** \brief . */
Derivative( const RCP<LinearOpBase<Scalar> > &lo )
: lo_(lo.assert_not_null()) {}
/** \brief . */
Derivative(
const RCP<MultiVectorBase<Scalar> > &mv,
const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
) : dmv_(mv,orientation) {}
/** \brief . */
Derivative( const DerivativeMultiVector<Scalar> &dmv )
: dmv_(dmv) {}
/** \brief . */
bool isEmpty() const
{ return ( lo_.get()==NULL && dmv_.getMultiVector().get()==NULL ); }
/** \brief . */
const Derivative<Scalar>& assert_not_null() const
{ dmv_.assert_not_null(); lo_.assert_not_null(); return *this; }
/** \brief . */
RCP<LinearOpBase<Scalar> > getLinearOp() const
{ return lo_; }
/** \brief . */
RCP<MultiVectorBase<Scalar> > getMultiVector() const
{ return dmv_.getMultiVector(); }
/** \brief . */
EDerivativeMultiVectorOrientation getMultiVectorOrientation() const
{ return dmv_.getOrientation(); }
/** \brief . */
DerivativeMultiVector<Scalar> getDerivativeMultiVector() const
{ return dmv_; }
/** \brief Returns true if the form of the derivative contained here is
* supported by deriveSupport.
*/
bool isSupportedBy( const DerivativeSupport &derivSupport ) const
{
// If there is not derivative support then we will return false!
if (derivSupport.none())
return false;
if (!is_null(getMultiVector())) {
return derivSupport.supports(getMultiVectorOrientation());
}
else if(!is_null(getLinearOp())) {
return derivSupport.supports(DERIV_LINEAR_OP);
}
// If nothing is set then of course we support that!
return true;
}
/** \brief . */
std::string description() const;
/** \brief . */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const;
private:
RCP<LinearOpBase<Scalar> > lo_;
DerivativeMultiVector<Scalar> dmv_;
};
/** \brief Simple aggregate class for a derivative object represented as a
* column-wise multi-vector or its transpose as a row-wise multi-vector.
*/
class MPDerivativeMultiVector {
public:
/** \brief . */
MPDerivativeMultiVector()
:orientation_(DERIV_MV_BY_COL)
{}
/** \brief . */
MPDerivativeMultiVector(
const RCP<Stokhos::ProductEpetraMultiVector > &mv
,const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
,const Teuchos::Array<int> ¶mIndexes = Teuchos::Array<int>()
) : mv_(mv.assert_not_null()), orientation_(orientation), paramIndexes_(paramIndexes) {}
/** \brief . */
void changeOrientation( const EDerivativeMultiVectorOrientation orientation )
{ orientation_ = orientation; };
/** \brief . */
const MPDerivativeMultiVector& assert_not_null() const
{ mv_.assert_not_null(); return *this; }
/** \brief . */
RCP<Stokhos::ProductEpetraMultiVector > getMultiVector() const
{ return mv_; }
/** \brief . */
EDerivativeMultiVectorOrientation getOrientation() const
{ return orientation_; }
/** \brief . */
const Teuchos::Array<int>& getParamIndexes() const
{ return paramIndexes_; }
/** \brief . */
std::string description() const {return "\n";}
/** \brief . */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const {}
private:
RCP<Stokhos::ProductEpetraMultiVector > mv_;
EDerivativeMultiVectorOrientation orientation_;
Teuchos::Array<int> paramIndexes_;
};
/** \brief Simple aggregate class that stores a derivative object
* as a general linear operator or as a multi-vector.
*/
class MPDerivative {
public:
/** \brief . */
MPDerivative() {}
/** \brief . */
MPDerivative( const RCP<Stokhos::ProductEpetraOperator > &lo )
: lo_(lo.assert_not_null()) {}
/** \brief . */
MPDerivative(
const RCP<Stokhos::ProductEpetraMultiVector > &mv,
const EDerivativeMultiVectorOrientation orientation = DERIV_MV_BY_COL
) : dmv_(mv,orientation) {}
/** \brief . */
MPDerivative( const MPDerivativeMultiVector &dmv )
: dmv_(dmv) {}
/** \brief . */
bool isEmpty() const
{ return ( lo_.get()==NULL && dmv_.getMultiVector().get()==NULL ); }
/** \brief . */
const MPDerivative& assert_not_null() const
{ dmv_.assert_not_null(); lo_.assert_not_null(); return *this; }
/** \brief . */
RCP<Stokhos::ProductEpetraOperator > getLinearOp() const
{ return lo_; }
/** \brief . */
RCP<Stokhos::ProductEpetraMultiVector > getMultiVector() const
{ return dmv_.getMultiVector(); }
/** \brief . */
EDerivativeMultiVectorOrientation getMultiVectorOrientation() const
{ return dmv_.getOrientation(); }
/** \brief . */
MPDerivativeMultiVector getDerivativeMultiVector() const
{ return dmv_; }
/** \brief Returns true if the form of the derivative contained here is
* supported by deriveSupport.
*/
bool isSupportedBy( const DerivativeSupport &derivSupport ) const
{
// If there is not derivative support then we will return false!
if (derivSupport.none())
return false;
if (!is_null(getMultiVector())) {
return derivSupport.supports(getMultiVectorOrientation());
}
else if(!is_null(getLinearOp())) {
return derivSupport.supports(DERIV_LINEAR_OP);
}
// If nothing is set then of course we support that!
return true;
}
/** \brief . */
std::string description() const {return "\n";}
/** \brief . */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const {}
private:
RCP<Stokhos::ProductEpetraOperator > lo_;
MPDerivativeMultiVector dmv_;
};
/** \brief . */
enum EOutArgsMembers {
OUT_ARG_f, ///< .
OUT_ARG_W, ///< .
OUT_ARG_f_mp, ///< .
OUT_ARG_W_mp, ///< .
OUT_ARG_W_op, ///< .
OUT_ARG_W_prec, ///< .
OUT_ARG_f_poly ///< .
};
/** \brief . */
static const int NUM_E_OUT_ARGS_MEMBERS=7;
/** \brief . */
enum EOutArgsDfDp {
OUT_ARG_DfDp ///< .
};
/** \brief . */
enum EOutArgsDgDx_dot {
OUT_ARG_DgDx_dot ///< .
};
/** \brief . */
enum EOutArgsDgDx {
OUT_ARG_DgDx ///< .
};
/** \brief . */
enum EOutArgsDgDp {
OUT_ARG_DgDp ///< .
};
/** \brief . */
enum EOutArgsDfDp_mp {
OUT_ARG_DfDp_mp ///< .
};
/** \brief . */
enum EOutArgs_g_mp {
OUT_ARG_g_mp ///< .
};
/** \brief . */
enum EOutArgsDgDx_dot_mp {
OUT_ARG_DgDx_dot_mp ///< .
};
/** \brief . */
enum EOutArgsDgDx_mp {
OUT_ARG_DgDx_mp ///< .
};
/** \brief . */
enum EOutArgsDgDp_mp {
OUT_ARG_DgDp_mp ///< .
};
/** \brief Concrete aggregate class for all output arguments computable by a
* <tt>ModelEvaluator</tt> subclass object.
*
* Note that <tt>const OutArgs</tt> object means that a client can not
* change what output objects are being pointed to but they can still change
* the states of the contained objects. This is slight variation on the
* concept of logical const-ness in C++ but it is totally consistent with
* the vary nature of this class.
*
* In addition to storing the output objects themselves, this class also
* allows the storage if the properties of some of the objects as well.
* Therefore, objects of this type are used to communicate a lot of
* different information about the output functions and derivatives
* supported by a model. It tells clients what functions and derivatives
* are supported and what the know properties are.
*
* A client can not directly set what input arguments are supported or not
* supported. Only a subclass of <tt>ModelEvaluator</tt> can do that
* (through the <tt>OutArgsSetup</tt> subclass).
*
* Extended types: The methods for %supports(), set() and get() that
* are templated on the <tt>ObjectType</tt> are used to support what
* are called extended types. This functionality allows developers
* to inject new objects into the ModelEvaluator evaluations. This
* can be used for expermenting with new capabilities that require
* adding new/special arguments to the outArgs. This also can be
* used to reduce the clutter and complexity of the model evaluator
* outArgs object. For example, users could create their own outArgs
* for a stochastic computation:
*
* \code{.cpp}
* struct StochasticOutArgs {
* StochLib::MultiVector<Scalar> stochastic_f;
* ...
* };
* \endcode
*
* This object could then be used in a model evaluator without
* changing the base classes in Thyra:
*
* \code{.cpp}
* auto outArgs = model->createOutArgs();
* assert(outArgs.template supports<StochasticOutArgs<Scalar>>());
*
* RCP<StochasticOutArgs> stochOutArgs = rcp(new StochasticOutArgs<Scalar>);
*
* stochOutArgs->stochastic_f = ... // create and set objects
* ...
*
* outArgs.set(stochOutArgs);
* \endcode
*/
template<class Scalar>
class OutArgs : public Teuchos::Describable {
public:
/** \brief . */
OutArgs();
/** \brief Return the number of parameter subvectors <tt>p(l)</tt>
* supported (<tt>Np >= 0</tt>). */
int Np() const;
/** \brief Return the number of axillary response functions
* <tt>g(j)(...)</tt> supported (<tt>Ng >= 0</tt>). */
int Ng() const;
/** \brief Determine if an input argument is supported or not. */
bool supports(EOutArgsMembers arg) const;
/** \brief Determine if <tt>DfDp(l)</tt> is supported or not, where <tt>0
* <= l && l < Np()</tt>. */
const DerivativeSupport& supports(EOutArgsDfDp arg, int l) const;
/** \brief Determine if <tt>DgDx_dot(j)</tt> is supported or not, <tt>0 <= j
* && j < Ng()</tt>. */
const DerivativeSupport& supports(EOutArgsDgDx_dot arg, int j) const;
/** \brief Determine if <tt>DgDx(j)</tt> is supported or not, <tt>0 <= j
* && j < Ng()</tt>. */
const DerivativeSupport& supports(EOutArgsDgDx arg, int j) const;
/** \brief Determine if <tt>DgDp(j,l)</tt> is supported or not, <tt>0 <= j
* && j < Ng()</tt> and <tt>0 <= l && l < Np()</tt>. */
const DerivativeSupport& supports(EOutArgsDgDp arg, int j, int l) const;
/** \brief Precondition: <tt>supports(OUT_ARG_f)==true</tt>. */
void set_f( const Evaluation<VectorBase<Scalar> > &f );
/** \brief Precondition: <tt>supports(OUT_ARG_f)==true</tt>. */
Evaluation<VectorBase<Scalar> > get_f() const;
/** \brief Precondition: <tt>supports(OUT_ARG_g)==true</tt>. */
void set_g( int j, const Evaluation<VectorBase<Scalar> > &g_j );
/** \brief Precondition: <tt>supports(OUT_ARG_g)==true</tt>.. */
Evaluation<VectorBase<Scalar> > get_g(int j) const;
/** \brief Precondition: <tt>supports(OUT_ARG_W)==true</tt>. */
void set_W( const RCP<LinearOpWithSolveBase<Scalar> > &W );
/** \brief Precondition: <tt>supports(OUT_ARG_W)==true</tt>. */
RCP<LinearOpWithSolveBase<Scalar> > get_W() const;
/** \brief Determines if an extended output argument of type <tt>ObjectType</tt> is supported. */
template<typename ObjectType>
bool supports() const;
/** \brief Set an extended output argument of type <tt>ObjectType</tt> in OutArgs. Precondition: <tt>supports()==true</tt>. */
template<typename ObjectType>
void set(const RCP<const ObjectType>& uo);
/** \brief Get an extended output argument of type <tt>ObjectType</tt> from OutArgs. Precondition: <tt>supports()==true</tt>. */
template<typename ObjectType>
RCP<const ObjectType> get() const;
const DerivativeSupport& supports(EOutArgsDfDp_mp arg, int l) const;
bool supports(EOutArgs_g_mp arg, int j) const;
const DerivativeSupport& supports(EOutArgsDgDx_dot_mp arg, int j) const;
const DerivativeSupport& supports(EOutArgsDgDx_mp arg, int j) const;
const DerivativeSupport& supports(EOutArgsDgDp_mp arg, int j, int l) const;
/** \brief Precondition: <tt>supports(OUT_ARG_f_mp)==true</tt>. */
void set_f_mp( const RCP<Stokhos::ProductEpetraVector> &f_mp );
/** \brief Precondition: <tt>supports(OUT_ARG_f_mp)==true</tt>. */
RCP<Stokhos::ProductEpetraVector> get_f_mp() const;
/** \brief Precondition: <tt>supports(OUT_ARG_g_mp)==true</tt>. */
void set_g_mp( int j, const RCP<Stokhos::ProductEpetraVector> &g_mp_j );
/** \brief Precondition: <tt>supports(OUT_ARG_g_mp)==true</tt>.. */
RCP<Stokhos::ProductEpetraVector> get_g_mp(int j) const;
/** \brief Precondition: <tt>supports(OUT_ARG_W_mp)==true</tt>. */
void set_W_mp( const RCP<Stokhos::ProductEpetraOperator> &W_mp );
/** \brief Precondition: <tt>supports(OUT_ARG_W_mp)==true</tt>. */
RCP<Stokhos::ProductEpetraOperator> get_W_mp() const;
/** \brief Precondition: <tt>supports(OUT_ARG_W_op)==true</tt>. */
void set_W_op( const RCP<LinearOpBase<Scalar> > &W_op );
/** \brief Precondition: <tt>supports(OUT_ARG_W_op)==true</tt>. */
RCP<LinearOpBase<Scalar> > get_W_op() const;
/** \brief Precondition: <tt>supports(OUT_ARG_W_op)==true</tt>. */
void set_W_prec( const RCP<PreconditionerBase<Scalar> > &W_prec );
/** \brief Precondition: <tt>supports(OUT_ARG_W_op)==true</tt>. */
RCP<PreconditionerBase<Scalar> > get_W_prec() const;
/** \brief Return the known properties of <tt>W</tt> (precondition:
* <tt>supports(OUT_ARG_f)==true</tt>). */
DerivativeProperties get_W_properties() const;
/** \brief Precondition: <tt>supports(OUT_ARG_DfDp,l)==true</tt>. */
void set_DfDp(int l, const Derivative<Scalar> &DfDp_l);
/** \brief Precondition: <tt>supports(OUT_ARG_DfDp,l)==true</tt>. */
Derivative<Scalar> get_DfDp(int l) const;
/** \brief Return the know properties of <tt>DfDp(l)</tt> (precondition:
* <tt>supports(OUT_ARG_DfDp,l)==true</tt>). */
DerivativeProperties get_DfDp_properties(int l) const;
/** \brief Precondition: <tt>supports(OUT_ARG_DgDx_dot,j)==true</tt>. */
void set_DgDx_dot(int j, const Derivative<Scalar> &DgDx_dot_j);
/** \brief Precondition: <tt>supports(OUT_ARG_DgDx_dot,j)==true</tt>. */
Derivative<Scalar> get_DgDx_dot(int j) const;
/** \brief Return the know properties of <tt>DgDx_dot(j)</tt> (precondition:
* <tt>supports(OUT_ARG_DgDx_dot,j)==true</tt>). */
DerivativeProperties get_DgDx_dot_properties(int j) const;
/** \brief Precondition: <tt>supports(OUT_ARG_DgDx,j)==true</tt>. */
void set_DgDx(int j, const Derivative<Scalar> &DgDx_j);
/** \brief Precondition: <tt>supports(OUT_ARG_DgDx,j)==true</tt>. */
Derivative<Scalar> get_DgDx(int j) const;
/** \brief Return the know properties of <tt>DgDx(j)</tt> (precondition:
* <tt>supports(OUT_ARG_DgDx,j)==true</tt>). */
DerivativeProperties get_DgDx_properties(int j) const;
/** \brief Precondition: <tt>supports(OUT_ARG_DgDp,j,l)==true</tt>. */
void set_DgDp( int j, int l, const Derivative<Scalar> &DgDp_j_l );
/** \brief Precondition: <tt>supports(OUT_ARG_DgDp,j,l)==true</tt>. */
Derivative<Scalar> get_DgDp(int j, int l) const;
/** \brief Return the know properties of <tt>DgDp(j,l)</tt> (precondition:
* <tt>supports(OUT_ARG_DgDp,j,l)==true</tt>). */
DerivativeProperties get_DgDp_properties(int j, int l) const;
void set_DfDp_mp(int l, const MPDerivative &DfDp_mp_l);
MPDerivative get_DfDp_mp(int l) const;
DerivativeProperties get_DfDp_mp_properties(int l) const;
void set_DgDx_dot_mp(int j, const MPDerivative &DgDx_dot_mp_j);
MPDerivative get_DgDx_dot_mp(int j) const;
DerivativeProperties get_DgDx_dot_mp_properties(int j) const;
void set_DgDx_mp(int j, const MPDerivative &DgDx_mp_j);
MPDerivative get_DgDx_mp(int j) const;
DerivativeProperties get_DgDx_mp_properties(int j) const;
void set_DgDp_mp( int j, int l, const MPDerivative &DgDp_mp_j_l );
MPDerivative get_DgDp_mp(int j, int l) const;
DerivativeProperties get_DgDp_mp_properties(int j, int l) const;
#ifdef HAVE_THYRA_ME_POLYNOMIAL
/** \brief Precondition: <tt>supports(OUT_ARG_f_poly)==true</tt>. */
void set_f_poly( const RCP<Teuchos::Polynomial< VectorBase<Scalar> > > &f_poly );
/** \brief Precondition: <tt>supports(OUT_ARG_f_poly)==true</tt>. */
RCP<Teuchos::Polynomial< VectorBase<Scalar> > > get_f_poly() const;
#endif // HAVE_THYRA_ME_POLYNOMIAL
/** \brief Set all arguments fron <tt>outArgs</tt> into <tt>*this</tt>.
*
* If <tt>ignoreUnsupported==true</tt>, then arguments in <tt>outArgs</tt>
* that are not supported in <tt>*this</tt> will be ignored. Othereise,
* if an unsupported argument is set, then an exception will be thrown.*/
void setArgs( const OutArgs<Scalar>& outArgs, bool ignoreUnsupported = false );
/** \brief Set that the evaluation as a whole failed.
*
* Note that this function is declared as <tt>const</tt> even through it
* technically changes the state of <tt>*this</tt> object. This was done
* so that this property could be set by a <tt>ModelEvaluator</tt>
* subclass in <tt>evalModel()</tt> which takes a <tt>const OutArgs</tt>
* object. This is consistent with the behavior of the rest of a
* <tt>const OutArgs</tt> object in that a client is allowed to change the
* state of objects through a <tt>const OutArgs</tt> object, they just
* can't change what objects are pointed to.
*/
void setFailed() const;
/** \brief Return if the evaluation failed or not.
*
* If the evaluation failed, no assumptions should be made at all about
* the state of the output objects.
*/
bool isFailed() const;
/** \brief . */
bool isEmpty() const;
/** \brief Assert that two OutArgs objects have the same support.*/
void assertSameSupport( const OutArgs<Scalar> &outArgs ) const;
/** \brief . */
std::string modelEvalDescription() const;
/** \brief . */
std::string description() const;
/** \brief Create a more detailed description along about this object and
* the ModelEvaluator that created it. */
void describe(
Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel
) const;
protected:
/** \brief . */
void _setModelEvalDescription( const std::string &modelEvalDescription );
/** \brief . */
void _set_Np_Ng(int Np, int Ng);
/** \brief . */
void _setSupports( EOutArgsMembers arg, bool supports );
/** \brief . */
template<typename ObjectType>
void _setSupports( const bool supports );
/** \brief . */
void _setSupports( EOutArgsDfDp arg, int l, const DerivativeSupport& );
/** \brief . */
void _setSupports( EOutArgsDgDx_dot arg, int j, const DerivativeSupport& );
/** \brief . */
void _setSupports( EOutArgsDgDx arg, int j, const DerivativeSupport& );
/** \brief . */
void _setSupports( EOutArgsDgDp arg, int j, int l, const DerivativeSupport& );
void _setSupports( EOutArgs_g_mp arg, int j, bool supports );
void _setSupports( EOutArgsDfDp_mp arg, int l, const DerivativeSupport& );
void _setSupports( EOutArgsDgDx_dot_mp arg, int j, const DerivativeSupport& );
void _setSupports( EOutArgsDgDx_mp arg, int j, const DerivativeSupport& );
void _setSupports( EOutArgsDgDp_mp arg, int j, int l, const DerivativeSupport& );
/** \brief . */
void _set_W_properties( const DerivativeProperties &properties );
/** \brief . */
void _set_DfDp_properties( int l, const DerivativeProperties &properties );
/** \brief . */
void _set_DgDx_dot_properties( int j, const DerivativeProperties &properties );
/** \brief . */
void _set_DgDx_properties( int j, const DerivativeProperties &properties );
/** \brief . */
void _set_DgDp_properties( int j, int l, const DerivativeProperties &properties );
void _set_DfDp_mp_properties( int l, const DerivativeProperties &properties );
void _set_DgDx_dot_mp_properties( int j, const DerivativeProperties &properties );
void _set_DgDx_mp_properties( int j, const DerivativeProperties &properties );
void _set_DgDp_mp_properties( int j, int l, const DerivativeProperties &properties );
/** \brief . */
void _setSupports( const OutArgs<Scalar>& inputOutArgs );
/** \brief . */
void _setUnsupportsAndRelated( EInArgsMembers arg );
/** \brief . */
void _setUnsupportsAndRelated( EOutArgsMembers arg );
private:
// types
typedef Teuchos::Array<Evaluation<VectorBase<Scalar> > > g_t;
typedef Teuchos::Array<Derivative<Scalar> > deriv_t;
typedef Teuchos::Array<DerivativeProperties> deriv_properties_t;
typedef Teuchos::Array<DerivativeSupport> supports_t;
// data
std::string modelEvalDescription_;
bool supports_[NUM_E_OUT_ARGS_MEMBERS];
supports_t supports_DfDp_; // Np
supports_t supports_DgDx_dot_; // Ng
supports_t supports_DgDx_; // Ng
supports_t supports_DgDp_; // Ng x Np
Evaluation<VectorBase<Scalar> > f_;
g_t g_; // Ng
RCP<LinearOpWithSolveBase<Scalar> > W_;
RCP<LinearOpBase<Scalar> > W_op_;
RCP<PreconditionerBase<Scalar> > W_prec_;
DerivativeProperties W_properties_;
deriv_t DfDp_; // Np
deriv_properties_t DfDp_properties_; // Np
deriv_t DgDx_dot_; // Ng
deriv_t DgDx_; // Ng
deriv_properties_t DgDx_dot_properties_; // Ng
deriv_properties_t DgDx_properties_; // Ng
deriv_t DgDp_; // Ng x Np
deriv_properties_t DgDp_properties_; // Ng x Np
Teuchos::Array<bool> supports_g_mp_; //Ng
supports_t supports_DfDp_mp_; // Np_mp
supports_t supports_DgDx_dot_mp_; // Ng_mp
supports_t supports_DgDx_mp_; // Ng_mp
supports_t supports_DgDp_mp_; // Ng_mp x Np_mp
Teuchos::Array< RCP< Stokhos::ProductEpetraVector > > g_mp_;
RCP<Stokhos::ProductEpetraVector> f_mp_;
RCP<Stokhos::ProductEpetraOperator> W_mp_;
Teuchos::Array<MPDerivative> DfDp_mp_;
Teuchos::Array<MPDerivative> DgDx_dot_mp_;
Teuchos::Array<MPDerivative> DgDx_mp_;
Teuchos::Array<MPDerivative> DgDp_mp_;
deriv_properties_t DfDp_mp_properties_;
deriv_properties_t DgDx_dot_mp_properties_;
deriv_properties_t DgDx_mp_properties_;
deriv_properties_t DgDp_mp_properties_;
#ifdef HAVE_THYRA_ME_POLYNOMIAL
RCP<Teuchos::Polynomial< VectorBase<Scalar> > > f_poly_;
#endif // HAVE_THYRA_ME_POLYNOMIAL
mutable bool isFailed_;
std::map<std::string,Teuchos::any> extended_outargs_;
// functions
void assert_supports(EOutArgsMembers arg) const;
void assert_supports(
EOutArgsDfDp arg, int l,
const Derivative<Scalar> &deriv = Derivative<Scalar>()
) const;
void assert_supports(
EOutArgsDgDx_dot arg, int j,
const Derivative<Scalar> &deriv = Derivative<Scalar>()
) const;
void assert_supports(
EOutArgsDgDx arg, int j,
const Derivative<Scalar> &deriv = Derivative<Scalar>()
) const;
void assert_supports(
EOutArgsDgDp arg, int j, int l,
const Derivative<Scalar> &deriv = Derivative<Scalar>()
) const;
void assert_supports(EOutArgs_g_mp arg, int j) const;
void assert_supports(
EOutArgsDfDp_mp arg, int l,
const MPDerivative &deriv = MPDerivative()
) const;
void assert_supports(
EOutArgsDgDx_dot_mp arg, int j,
const MPDerivative &deriv = MPDerivative()
) const;
void assert_supports(
EOutArgsDgDx_mp arg, int j,
const MPDerivative &deriv = MPDerivative()
) const;
void assert_supports(
EOutArgsDgDp_mp arg, int j, int l,
const MPDerivative &deriv = MPDerivative()
) const;
void assert_l(int l) const;
void assert_j(int j) const;
};
//@}
// Added since at least gcc 3.3.4 does not do the right thing here!
#ifdef HAVE_PROTECTED_NESTED_TEMPLATE_CLASS_ACCESS
protected:
#endif
/** \name Protected types */
//@{
/** \brief Protected subclass of <tt>InArgs</tt> that only
* <tt>ModelEvaluator</tt> subclasses can access to set up the selection of
* supported input arguments.
*
* Objects of this type must be created in overrides of
* <tt>ModelEvaluator::createInArgs()</tt>.
*/
template<class Scalar>
class InArgsSetup : public InArgs<Scalar> {
public:
/** \brief . */
InArgsSetup();
/** \brief . */
InArgsSetup( const InArgs<Scalar>& );
/** \brief . */
void setModelEvalDescription( const std::string &modelEvalDescription );
/** \brief . */
void set_Np(int Np);
/** \brief . */
void setSupports( EInArgsMembers arg, bool supports = true );
/** \brief . */
void setSupports( const InArgs<Scalar>& inputInArgs, const int Np = -1 );
/** \brief Set support for specific extended data types. */
template<typename ObjectType>
void setSupports(const bool supports = true);
/** \brief . */
void setUnsupportsAndRelated( EInArgsMembers arg );
void setSupports( EInArgs_p_mp arg, int l, bool supports);
};
/** \brief Protected subclass of <tt>OutArgs</tt> that only
* <tt>ModelEvaluator</tt> subclasses can access to set up the selection of
* supported input arguments.
*
* Objects of this type must be created in overrides of
* <tt>ModelEvaluator::createOutArgs()</tt>.
*/
template<class Scalar>
class OutArgsSetup : public OutArgs<Scalar> {
public:
/** \brief . */
OutArgsSetup();
/** \brief . */
OutArgsSetup( const OutArgs<Scalar>& );
/** \brief . */
void setModelEvalDescription( const std::string &modelEvalDescription );
/** \brief . */
void set_Np_Ng(int Np, int Ng);
/** \brief . */
void setSupports( EOutArgsMembers arg, bool supports = true );
/** \brief . */
void setSupports(EOutArgsDfDp arg, int l, const DerivativeSupport& );
/** \brief . */
void setSupports(EOutArgsDgDx_dot arg, int j, const DerivativeSupport& );
/** \brief . */
void setSupports(EOutArgsDgDx arg, int j, const DerivativeSupport& );
/** \brief . */
void setSupports(EOutArgsDgDp arg, int j, int l, const DerivativeSupport& );
/** \brief Set support for specific extended data types. */
template<typename ObjectType>
void setSupports(const bool supports = true);
void setSupports( EOutArgs_g_mp arg, int j, bool supports);
void setSupports(EOutArgsDfDp_mp arg, int l, const DerivativeSupport& );
void setSupports(EOutArgsDgDx_dot_mp arg, int j, const DerivativeSupport& );
void setSupports(EOutArgsDgDx_mp arg, int j, const DerivativeSupport& );
void setSupports(EOutArgsDgDp_mp arg, int j, int l, const DerivativeSupport& );
/** \brief . */
void set_W_properties( const DerivativeProperties &properties );
/** \brief . */
void set_DfDp_properties( int l, const DerivativeProperties &properties );
/** \brief . */
void set_DgDx_dot_properties( int j, const DerivativeProperties &properties );
/** \brief . */
void set_DgDx_properties( int j, const DerivativeProperties &properties );
/** \brief . */
void set_DgDp_properties( int j, int l, const DerivativeProperties &properties );
void set_DfDp_mp_properties( int l, const DerivativeProperties &properties );
void set_DgDx_dot_mp_properties( int j, const DerivativeProperties &properties );
void set_DgDx_mp_properties( int j, const DerivativeProperties &properties );
void set_DgDp_mp_properties( int j, int l, const DerivativeProperties &properties );
/** \brief . */
void setSupports( const OutArgs<Scalar>& inputOutArgs );
/** \brief . */
void setUnsupportsAndRelated( EInArgsMembers arg );
/** \brief Must be called after the above function. */
void setUnsupportsAndRelated( EOutArgsMembers arg );
};
//@}
/** \brief constructor */
//@{
/** \brief . */
ModelEvaluatorBase();
//@}
private:
// Not defined and not to be called
ModelEvaluatorBase(const ModelEvaluatorBase&);
ModelEvaluatorBase& operator=(const ModelEvaluatorBase&);
}; // ModelEvaluatorBase
/** \relates ModelEvaluatorBase */
std::string toString(ModelEvaluatorBase::EInArgsMembers);
/** \relates ModelEvaluatorBase */
std::string toString(ModelEvaluatorBase::EOutArgsMembers);
/** \relates ModelEvaluatorBase */
std::string toString(
ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
);
/** \relates ModelEvaluatorBase */
ModelEvaluatorBase::EDerivativeMultiVectorOrientation
getOtherDerivativeMultiVectorOrientation(
ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
);
} // namespace Thyra
// //////////////////////////////////
// Inline Defintions
// Extended InArgs
template<class Scalar>
template<typename ObjectType>
bool Thyra::ModelEvaluatorBase::InArgs<Scalar>::supports() const
{
std::map<std::string,Teuchos::any>::const_iterator search =
extended_inargs_.find(typeid(ObjectType).name());
if (search == extended_inargs_.end())
return false;
return true;
}
template<class Scalar>
template<typename ObjectType>
void Thyra::ModelEvaluatorBase::InArgs<Scalar>::set(const Teuchos::RCP<const ObjectType>& eo)
{
std::map<std::string,Teuchos::any>::iterator search = extended_inargs_.find(typeid(ObjectType).name());
TEUCHOS_TEST_FOR_EXCEPTION(search == extended_inargs_.end(),
std::runtime_error,
"ERROR: InArgs::set<ObjectType>() was called with unsupported extended data type \""
<< typeid(ObjectType).name() << "\"!");
search->second = Teuchos::any(eo);
}
template<class Scalar>
template<typename ObjectType>
Teuchos::RCP<const ObjectType>
Thyra::ModelEvaluatorBase::InArgs<Scalar>::get() const
{
std::map<std::string,Teuchos::any>::const_iterator search = extended_inargs_.find(typeid(ObjectType).name());
TEUCHOS_TEST_FOR_EXCEPTION(search == extended_inargs_.end(),
std::runtime_error,
"ERROR: InArgs::get<ObjectType>() was called with unsupported extended data type \""
<< typeid(ObjectType).name() << "\"!");
return Teuchos::any_cast<Teuchos::RCP<const ObjectType> >(search->second);
}
template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::InArgsSetup<Scalar>::
setSupports(const bool in_supports)
{
this->template _setSupports<ObjectType>(in_supports);
}
template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::InArgs<Scalar>::
_setSupports(const bool in_supports)
{
if (in_supports)
// When supports() is called, the map is searched to check for
// supporting a type. If we support the type, we will insert an
// empty placholder for now so that the search is successful for
// support checks.
this->extended_inargs_[typeid(ObjectType).name()] = Teuchos::any();
else {
// if false, remove the entry
std::map<std::string,Teuchos::any>::iterator search =
this->extended_inargs_.find(typeid(ObjectType).name());
if (search != this->extended_inargs_.end())
this->extended_inargs_.erase(typeid(ObjectType).name());
}
}
// Extended OutArgs
template<class Scalar>
template<typename ObjectType>
bool Thyra::ModelEvaluatorBase::OutArgs<Scalar>::supports() const
{
std::map<std::string,Teuchos::any>::const_iterator search =
extended_outargs_.find(typeid(ObjectType).name());
if (search == extended_outargs_.end())
return false;
return true;
}
template<class Scalar>
template<typename ObjectType>
void Thyra::ModelEvaluatorBase::OutArgs<Scalar>::set(const Teuchos::RCP<const ObjectType>& eo)
{
std::map<std::string,Teuchos::any>::iterator search = extended_outargs_.find(typeid(ObjectType).name());
TEUCHOS_TEST_FOR_EXCEPTION(search == extended_outargs_.end(),
std::runtime_error,
"ERROR: OutArgs::set<ObjectType>() was called with unsupported extended data type \""
<< typeid(ObjectType).name() << "\"!");
search->second = Teuchos::any(eo);
}
template<class Scalar>
template<typename ObjectType>
Teuchos::RCP<const ObjectType>
Thyra::ModelEvaluatorBase::OutArgs<Scalar>::get() const
{
std::map<std::string,Teuchos::any>::const_iterator search = extended_outargs_.find(typeid(ObjectType).name());
TEUCHOS_TEST_FOR_EXCEPTION(search == extended_outargs_.end(),
std::runtime_error,
"ERROR: OutArgs::get<ObjectType>() was called with unsupported extended data type \""
<< typeid(ObjectType).name() << "\"!");
return Teuchos::any_cast<Teuchos::RCP<const ObjectType> >(search->second);
}
template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::OutArgsSetup<Scalar>::
setSupports(const bool in_supports)
{
this->template _setSupports<ObjectType>(in_supports);
}
template<class Scalar>
template<class ObjectType>
void Thyra::ModelEvaluatorBase::OutArgs<Scalar>::
_setSupports(const bool in_supports)
{
if (in_supports)
// When supports() is called, the map is searched to check for
// supporting a type. If we support the type, we will insert an
// empty placholder for now so that the search is successful for
// support checks.
this->extended_outargs_[typeid(ObjectType).name()] = Teuchos::any();
else {
// if false, remove the entry
std::map<std::string,Teuchos::any>::iterator search =
this->extended_outargs_.find(typeid(ObjectType).name());
if (search != this->extended_outargs_.end())
this->extended_outargs_.erase(typeid(ObjectType).name());
}
}
//
// Thyra_MEB_helper_functions_grp
//
inline
std::string Thyra::toString(ModelEvaluatorBase::EInArgsMembers arg)
{
switch(arg) {
case ModelEvaluatorBase::IN_ARG_x_dot_dot:
return "IN_ARG_x_dot_dot";
case ModelEvaluatorBase::IN_ARG_x_dot:
return "IN_ARG_x_dot";
case ModelEvaluatorBase::IN_ARG_x:
return "IN_ARG_x";
case ModelEvaluatorBase::IN_ARG_x_dot_poly:
return "IN_ARG_x_dot_poly";
case ModelEvaluatorBase::IN_ARG_x_poly:
return "IN_ARG_x_poly";
case ModelEvaluatorBase::IN_ARG_x_dot_mp:
return "IN_ARG_x_dot_mp";
case ModelEvaluatorBase::IN_ARG_x_mp:
return "IN_ARG_x_mp";
case ModelEvaluatorBase::IN_ARG_t:
return "IN_ARG_t";
case ModelEvaluatorBase::IN_ARG_alpha:
return "IN_ARG_alpha";
case ModelEvaluatorBase::IN_ARG_beta:
return "IN_ARG_beta";
case ModelEvaluatorBase::IN_ARG_W_x_dot_dot_coeff:
return "IN_ARG_W_x_dot_dot_coeff";
case ModelEvaluatorBase::IN_ARG_step_size:
return "IN_ARG_step_size";
case ModelEvaluatorBase::IN_ARG_stage_number:
return "IN_ARG_stage_number";
#ifdef TEUCHOS_DEBUG
default:
TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
}
return ""; // Will never be executed!
}
inline
std::string Thyra::toString(ModelEvaluatorBase::EOutArgsMembers arg)
{
switch(arg) {
case ModelEvaluatorBase::OUT_ARG_f:
return "OUT_ARG_f";
case ModelEvaluatorBase::OUT_ARG_W:
return "OUT_ARG_W";
case ModelEvaluatorBase::OUT_ARG_f_mp:
return "OUT_ARG_f_mp";
case ModelEvaluatorBase::OUT_ARG_W_mp:
return "OUT_ARG_W_mp";
case ModelEvaluatorBase::OUT_ARG_W_op:
return "OUT_ARG_W_op";
case ModelEvaluatorBase::OUT_ARG_W_prec:
return "OUT_ARG_W_prec";
case ModelEvaluatorBase::OUT_ARG_f_poly:
return "OUT_ARG_f_poly";
#ifdef TEUCHOS_DEBUG
default:
TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
}
return ""; // Will never be executed!
}
inline
std::string Thyra::toString(
ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
)
{
switch(orientation) {
case ModelEvaluatorBase::DERIV_MV_BY_COL:
return "DERIV_MV_BY_COL";
case ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW:
return "DERIV_TRANS_MV_BY_ROW";
#ifdef TEUCHOS_DEBUG
default:
TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
}
return ""; // Should never execute this!
}
inline
Thyra::ModelEvaluatorBase::EDerivativeMultiVectorOrientation
Thyra::getOtherDerivativeMultiVectorOrientation(
ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation
)
{
switch(orientation) {
case ModelEvaluatorBase::DERIV_MV_BY_COL:
return ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW;
case ModelEvaluatorBase::DERIV_TRANS_MV_BY_ROW:
return ModelEvaluatorBase::DERIV_MV_BY_COL;
#ifdef TEUCHOS_DEBUG
default:
TEUCHOS_TEST_FOR_EXCEPT(true);
#endif
}
return ModelEvaluatorBase::DERIV_MV_BY_COL; // Should never execute this!
}
#endif // THYRA_MODEL_EVALUATOR_BASE_DECL_HPP
|