/usr/include/trilinos/Thyra_DefaultMultiPeriodModelEvaluator.hpp is in libtrilinos-thyra-dev 12.10.1-3.
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 | // @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_DEFAULT_MULTI_PERIOD_MODEL_EVALUATOR_HPP
#define THYRA_DEFAULT_MULTI_PERIOD_MODEL_EVALUATOR_HPP
#include "Thyra_ModelEvaluatorDefaultBase.hpp"
#include "Thyra_DefaultProductVectorSpace.hpp"
#include "Thyra_DefaultBlockedTriangularLinearOpWithSolveFactory.hpp" // Default implementation
#include "Thyra_DefaultBlockedLinearOp.hpp"
#include "Thyra_ModelEvaluatorDelegatorBase.hpp"
#include "Thyra_ProductVectorBase.hpp"
#include "Teuchos_implicit_cast.hpp"
#include "Teuchos_AbstractFactory.hpp" // Interface
#include "Teuchos_AbstractFactoryStd.hpp" // Implementation
namespace Thyra {
/** \brief Composite subclass that takes a single <tt>ModelEvaluator</tt>
* object and represents it as a single aggregate multi-period
* <tt>ModelEvalator</tt> object.
*
* Mathematically, this subclass is used to form a multi-period (or
* multi-point) problem of the form:
\verbatim
(x_bar,{p_l}\p_period) -> f_bar
(x_bar,{p_l}\p_period) -> g_bar
\endverbatim
* where
\verbatim
x_bar = [ x[0]; x[1]; ...; x[N-1]]
{p_l}\p_period = { p_(0), p_(1), ..., p_(z_index-1), p_(z_index+1), ..., p_(Np-1) }
f_bar(...) = [ f(x[0],{p_l},z[0]); f(x[1],{p_l},z[1]); ..., f(x[N-1],{p_l},z[N-1]) ]
g_bar(...) = sum( g_weights[i]*g[g_index](x[0],{p_l},z[i]), i = 0,...,N-1 )
\endverbatim
* Above, the notation <tt>{p_l}\p_period</tt> is meant to represent the set
* of all parameter subvectors in each of the constituent models minus the
* parameter subvector used to define period data.
*
* This gives the first derivative objects:
\verbatim
[ W[0], 0, ... 0 ]
[ 0, W[i], ... 0 ]
W_bar = DfDx_bar = [ ., ., ... . ]
[ 0, 0, ... W[N-1] ]
[ DfDp[0][l] ]
[ DfDp[1][l] ]
DfDp_bar[l] = [ ... ]
[ DfDp[N=1][l] ]
[ g_wieght[0] * DgDx_dot[0] ]
[ g_wieght[1] * DgDx_dot[1] ]
DgDx_dot_bar = [ ... ]
[ g_wieght[N-1] * DgDx_dot[N-1] ]
[ g_wieght[0] * DgDx[0] ]
[ g_wieght[1] * DgDx[1] ]
DgDx_bar = [ ... ]
[ g_wieght[N-1] * DgDx[N-1] ]
DgDp_bar = sum( g_weights[i]*DgDp[i][g_index], i = 0,...,N-1 )
\endverbatim
* This class could be made much more general but for now ???
*
* \ingroup Thyra_Nonlin_ME_support_grp
*/
template<class Scalar>
class DefaultMultiPeriodModelEvaluator
: virtual public ModelEvaluatorDefaultBase<Scalar>
{
public:
/** \name Constructors/Intializers/Accessors */
//@{
/** \brief . */
DefaultMultiPeriodModelEvaluator();
/** \brief Calls <tt>intialize(...)</tt>. */
DefaultMultiPeriodModelEvaluator(
const int N,
const Array<RCP<ModelEvaluator<Scalar> > > &periodModels,
const Array<int> &z_indexes,
const Array<Array<RCP<const VectorBase<Scalar> > > > &z,
const int g_index,
const Array<Scalar> g_weights,
const RCP<const ProductVectorSpaceBase<Scalar> > &x_bar_space = Teuchos::null,
const RCP<const ProductVectorSpaceBase<Scalar> > &f_bar_space = Teuchos::null,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &W_bar_factory = Teuchos::null
);
/** \brief Initialize.
*
* \param N [in] The number of periods.
*
* \param periodModels [in] Array (length <tt>N</tt>) of the period models.
* For now, each of the period models at <tt>periodModels[i]</tt> must have
* an identical structure for every input and output. The reason that
* different models are passed in is so that different behaviors of the
* output functions and different nominal values for each period's
* <tt>x</tt> and bounds can be specified. The nominal values from
* <tt>periodModels[0]</tt> will be used to set the nominal values for the
* non-peroid parameters.
*
* \param z_indexes [in] Array of sorted zero-based indexes of the model's
* parameter subvector that represents <tt>z[i]</tt>. Note, this array must
* be sorted from smallest to largets and can not have any duplicate
* entires!
*
* \param z [in] Array (length <tt>N</tt>) of the period defining auxiliary
* paramter subvectors. Each entry <tt>z[i]</tt> is an array of subvectors
* where <tt>z[i][k]</tt> is the subvector <tt>p(z_indexes[k])</tt> in the
* underlying perild model. Therefore, the array <tt>z[i]</tt> must be
* ordered according to <tt>z_indexes</tt>. Note that <tt>z[i][k]</tt> is
* allowed to be <tt>null</tt> in which case the underlying default value
* for this parameter will be used.
*
* \param g_index [in] The index of the response function that will be used
* for the period objective function.
*
* \param g_weights [in] Array (length <tt>N</tt>) of the g_weights for the
* auxiliary response functions in the summation for <tt>g_bar(...)</tt>
* shown above.
*
* \param x_bar_space [in] The product vector space that represents the
* space for <tt>x_bar</tt> as defined above. If
* <tt>x_bar_space.get()==NULL</tt> then a default version of this product
* space will be created internally.
*
* \param f_bar_space [in] The product vector space that represents the
* space for <tt>f_bar</tt> as defined above. If
* <tt>f_bar_space.get()==NULL</tt> then a default version of this product
* space will be created internally.
*
* \param W_bar_factory [in] Factory object that is used to create the block
* LOWS object that will be used to represent the block diagonal object
* <tt>W_bar</tt>. If <tt>is_null(W_bar_factory)==true</tt> on input then a
* <tt>DefaultBlockedTriangularLinearOpWithSolveFactory</tt> object will be
* created and used internally.
*
* <b>Preconditions:</b><ul>
* <li><tt>N > 0</tt>
* <li><tt>periodModels.size()==N</tt>.
* <li><li>z_indexes.size() > 0</tt> and <tt>z_indexes[k] >= 0</tt> and <tt>z_indexes[k]</tt>
* are sorted low to high and are unique.
* <li><tt>z.size()==N</tt> and <tt>z[i].size()==z_indexes.size()</tt>, for <tt>i=0...N-1</tt>
* </ul>
*
*/
void initialize(
const int N,
const Array<RCP<ModelEvaluator<Scalar> > > &periodModels,
const Array<int> &z_indexes,
const Array<Array<RCP<const VectorBase<Scalar> > > > &z,
const int g_index,
const Array<Scalar> g_weights,
const RCP<const ProductVectorSpaceBase<Scalar> > &x_bar_space = Teuchos::null,
const RCP<const ProductVectorSpaceBase<Scalar> > &f_bar_space = Teuchos::null,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &W_bar_factory = Teuchos::null
);
/** \brief Reset z.
*
* \param z [in] See <tt>initialize()</tt>.
*
* <b>Preconditions:</b><ul>
* <li>See <tt>initialize()</tt>
* </ul>
*
*/
void reset_z(
const Array<Array<RCP<const VectorBase<Scalar> > > > &z
);
//@}
/** \name Public functions overridden from ModelEvaulator. */
//@{
/** \brief . */
int Np() const;
/** \brief . */
int Ng() const;
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > get_x_space() const;
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > get_f_space() const;
/** \brief. */
RCP<const VectorSpaceBase<Scalar> > get_p_space(int l) const;
/** \brief . */
RCP<const Array<std::string> > get_p_names(int l) const;
/** \brief . */
RCP<const VectorSpaceBase<Scalar> > get_g_space(int j) const;
/** \brief . */
ArrayView<const std::string> get_g_names(int j) const;
/** \brief . */
ModelEvaluatorBase::InArgs<Scalar> getNominalValues() const;
/** \brief . */
ModelEvaluatorBase::InArgs<Scalar> getLowerBounds() const;
/** \brief . */
ModelEvaluatorBase::InArgs<Scalar> getUpperBounds() const;
/** \breif . */
RCP<LinearOpBase<Scalar> > create_W_op() const;
/** \breif . */
RCP<PreconditionerBase<Scalar> > create_W_prec() const;
/** \breif . */
RCP<const LinearOpWithSolveFactoryBase<Scalar> > get_W_factory() const;
/** \brief . */
ModelEvaluatorBase::InArgs<Scalar> createInArgs() const;
/** \brief Ignores the final point. */
void reportFinalPoint(
const ModelEvaluatorBase::InArgs<Scalar> &finalPoint,
const bool wasSolved
);
//@}
private:
/** \name Private functions overridden from ModelEvaulatorDefaultBase. */
//@{
/** \brief . */
RCP<LinearOpBase<Scalar> > create_DfDp_op_impl(int l) const;
/** \brief . */
RCP<LinearOpBase<Scalar> > create_DgDx_dot_op_impl(int j) const;
/** \brief . */
RCP<LinearOpBase<Scalar> > create_DgDx_op_impl(int j) const;
/** \brief . */
RCP<LinearOpBase<Scalar> > create_DgDp_op_impl(int j, int l) const;
/** \brief . */
ModelEvaluatorBase::OutArgs<Scalar> createOutArgsImpl() const;
/** \brief . */
void evalModelImpl(
const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
) const;
//@}
private:
// //////////////////////////
// Private types
typedef Array<Scalar> g_weights_t;
typedef Array<Array<RCP<const VectorBase<Scalar> > > > z_t;
// /////////////////////////
// Private data members
RCP<ModelEvaluator<Scalar> > periodModel_;
Array<RCP<ModelEvaluator<Scalar> > > periodModels_;
Array<int> z_indexes_;
Array<int> period_l_map_;
z_t z_; // size == N
int g_index_;
g_weights_t g_weights_; // size == N
RCP<const ProductVectorSpaceBase<Scalar> > x_bar_space_;
RCP<const ProductVectorSpaceBase<Scalar> > f_bar_space_;
RCP<LinearOpWithSolveFactoryBase<Scalar> > W_bar_factory_;
int Np_;
int Ng_;
ModelEvaluatorBase::InArgs<Scalar> nominalValues_;
ModelEvaluatorBase::InArgs<Scalar> lowerBounds_;
ModelEvaluatorBase::InArgs<Scalar> upperBounds_;
// /////////////////////////
// Private member functions
void set_z_indexes_and_create_period_l_map( const Array<int> &z_indexes );
void wrapNominalValuesAndBounds();
static
RCP<ProductVectorBase<Scalar> >
createProductVector(
const RCP<const ProductVectorSpaceBase<Scalar> > &prodVecSpc
);
// Return the index of a "free" parameter in the period model given its
// index in this mulit-period model.
int period_l(const int l) const
{
TEUCHOS_TEST_FOR_EXCEPT( !( 0 <= l && l < Np_) );
return period_l_map_[l];
}
int numPeriodZs() const { return z_indexes_.size(); }
int N() const { return x_bar_space_->numBlocks(); }
};
// /////////////////////////////////
// Implementations
// Constructors/Intializers/Accessors
template<class Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::DefaultMultiPeriodModelEvaluator()
:g_index_(-1), Np_(-1), Ng_(-1)
{}
template<class Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::DefaultMultiPeriodModelEvaluator(
const int N,
const Array<RCP<ModelEvaluator<Scalar> > > &periodModels,
const Array<int> &z_indexes,
const Array<Array<RCP<const VectorBase<Scalar> > > > &z,
const int g_index,
const Array<Scalar> g_weights,
const RCP<const ProductVectorSpaceBase<Scalar> > &x_bar_space,
const RCP<const ProductVectorSpaceBase<Scalar> > &f_bar_space,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &W_bar_factory
)
:g_index_(-1), Np_(-1), Ng_(-1)
{
initialize(
N, periodModels, z_indexes, z, g_index, g_weights,
x_bar_space, f_bar_space, W_bar_factory
);
}
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::initialize(
const int N,
const Array<RCP<ModelEvaluator<Scalar> > > &periodModels,
const Array<int> &z_indexes,
const Array<Array<RCP<const VectorBase<Scalar> > > > &z,
const int g_index,
const Array<Scalar> g_weights,
const RCP<const ProductVectorSpaceBase<Scalar> > &x_bar_space,
const RCP<const ProductVectorSpaceBase<Scalar> > &f_bar_space,
const RCP<LinearOpWithSolveFactoryBase<Scalar> > &W_bar_factory
)
{
using Teuchos::implicit_cast;
typedef Teuchos::ScalarTraits<Scalar> ST;
typedef ModelEvaluatorBase MEB;
TEUCHOS_TEST_FOR_EXCEPT( N <= 0 );
TEUCHOS_TEST_FOR_EXCEPT( implicit_cast<int>(periodModels.size()) != N );
MEB::InArgs<Scalar> periodInArgs = periodModels[0]->createInArgs();
MEB::OutArgs<Scalar> periodOutArgs = periodModels[0]->createOutArgs();
for ( int k = 0; k < implicit_cast<int>(z_indexes.size()); ++k ) {
TEUCHOS_TEST_FOR_EXCEPT( !( 0 <= z_indexes[k] && z_indexes[k] < periodInArgs.Np() ) );
}
TEUCHOS_TEST_FOR_EXCEPT( implicit_cast<int>(z.size())!=N );
TEUCHOS_TEST_FOR_EXCEPT( !( 0 <= g_index && g_index < periodOutArgs.Ng() ) );
TEUCHOS_TEST_FOR_EXCEPT( implicit_cast<int>(g_weights.size())!=N );
// ToDo: Assert that the different period models are compatible!
Np_ = periodInArgs.Np() - z_indexes.size();
Ng_ = 1;
set_z_indexes_and_create_period_l_map(z_indexes);
periodModel_ = periodModels[0]; // Assume basic structure!
periodModels_ = periodModels;
z_.resize(N);
reset_z(z);
g_index_ = g_index;
g_weights_ = g_weights;
if ( periodInArgs.supports(MEB::IN_ARG_x) ) {
if( !is_null(x_bar_space) ) {
TEUCHOS_TEST_FOR_EXCEPT(!(x_bar_space->numBlocks()==N));
// ToDo: Check the constituent spaces more carefully against models[]->get_x_space().
x_bar_space_ = x_bar_space;
}
else {
x_bar_space_ = productVectorSpace(periodModel_->get_x_space(),N);
// ToDo: Update to build from different models for different x spaces!
}
}
if ( periodOutArgs.supports(MEB::OUT_ARG_f) ) {
if( !is_null(f_bar_space) ) {
TEUCHOS_TEST_FOR_EXCEPT(!(f_bar_space->numBlocks()==N));
// ToDo: Check the constituent spaces more carefully against models[]->get_f_space().
f_bar_space_ = f_bar_space;
}
else {
f_bar_space_ = productVectorSpace(periodModel_->get_f_space(),N);
// ToDo: Update to build from different models for different f spaces!
}
}
if ( periodOutArgs.supports(MEB::OUT_ARG_W) ) {
if ( !is_null(W_bar_factory) ) {
// ToDo: Check the compatability of the W_bar objects created using this object!
W_bar_factory_ = W_bar_factory;
}
else {
W_bar_factory_ =
defaultBlockedTriangularLinearOpWithSolveFactory<Scalar>(
periodModel_->get_W_factory() );
}
}
wrapNominalValuesAndBounds();
}
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::reset_z(
const Array<Array<RCP<const VectorBase<Scalar> > > > &z
)
{
using Teuchos::implicit_cast;
const int N = z_.size();
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT( N == 0 && "Error, must have called initialize() first!" );
TEUCHOS_TEST_FOR_EXCEPT( implicit_cast<int>(z.size()) != N );
#endif
for( int i = 0; i < N; ++i ) {
const Array<RCP<const VectorBase<Scalar> > > &z_i = z[i];
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT( z_i.size() != z_indexes_.size() );
#endif
z_[i] = z_i;
}
}
// Public functions overridden from ModelEvaulator
template<class Scalar>
int DefaultMultiPeriodModelEvaluator<Scalar>::Np() const
{
return Np_;
}
template<class Scalar>
int DefaultMultiPeriodModelEvaluator<Scalar>::Ng() const
{
return Ng_;
}
template<class Scalar>
RCP<const VectorSpaceBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_x_space() const
{
return x_bar_space_;
}
template<class Scalar>
RCP<const VectorSpaceBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_f_space() const
{
return f_bar_space_;
}
template<class Scalar>
RCP<const VectorSpaceBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_p_space(int l) const
{
return periodModel_->get_p_space(period_l(l));
}
template<class Scalar>
RCP<const Array<std::string> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_p_names(int l) const
{
return periodModel_->get_p_names(period_l(l));
}
template<class Scalar>
RCP<const VectorSpaceBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_g_space(int j) const
{
TEUCHOS_TEST_FOR_EXCEPT(j!=0);
return periodModel_->get_g_space(g_index_);
}
template<class Scalar>
ArrayView<const std::string>
DefaultMultiPeriodModelEvaluator<Scalar>::get_g_names(int j) const
{
return periodModel_->get_g_names(j);
}
template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::getNominalValues() const
{
return nominalValues_;
}
template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::getLowerBounds() const
{
return lowerBounds_;
}
template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::getUpperBounds() const
{
return upperBounds_;
}
template<class Scalar>
RCP<LinearOpBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_W_op() const
{
// Set up the block structure ready to have the blocks filled!
const RCP<PhysicallyBlockedLinearOpBase<Scalar> >
W_op_bar = defaultBlockedLinearOp<Scalar>();
W_op_bar->beginBlockFill(f_bar_space_,x_bar_space_);
const int N = x_bar_space_->numBlocks();
for ( int i = 0; i < N; ++i ) {
W_op_bar->setNonconstBlock( i, i, periodModel_->create_W_op() );
}
W_op_bar->endBlockFill();
return W_op_bar;
}
template<class Scalar>
RCP<PreconditionerBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_W_prec() const
{
return Teuchos::null;
}
template<class Scalar>
RCP<const LinearOpWithSolveFactoryBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::get_W_factory() const
{
return W_bar_factory_;
}
template<class Scalar>
ModelEvaluatorBase::InArgs<Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::createInArgs() const
{
typedef ModelEvaluatorBase MEB;
MEB::InArgs<Scalar> periodInArgs = periodModel_->createInArgs();
MEB::InArgsSetup<Scalar> inArgs;
inArgs.setModelEvalDescription(this->description());
inArgs.set_Np(Np_);
inArgs.setSupports( MEB::IN_ARG_x, periodInArgs.supports(MEB::IN_ARG_x) );
return inArgs;
}
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::reportFinalPoint(
const ModelEvaluatorBase::InArgs<Scalar> &finalPoint
,const bool wasSolved
)
{
// We are just going to ignore the final point here. It is not clear how to
// report a "final" point back to the underlying *periodModel_ object since
// we have so many different "points" that we could return (i.e. one for
// each period). I guess we could report back the final parameter values
// (other than the z parameter) but there are multiple states x[i] and
// period parameters z[i] that we can report back.
}
// Public functions overridden from ModelEvaulatorDefaultBase
template<class Scalar>
RCP<LinearOpBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_DfDp_op_impl(int l) const
{
TEUCHOS_TEST_FOR_EXCEPT("This class does not support DfDp(l) as a linear operator yet.");
return Teuchos::null;
}
template<class Scalar>
RCP<LinearOpBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_DgDx_dot_op_impl(int j) const
{
TEUCHOS_TEST_FOR_EXCEPT("This class does not support DgDx_dot(j) as a linear operator yet.");
return Teuchos::null;
}
template<class Scalar>
RCP<LinearOpBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_DgDx_op_impl(int j) const
{
TEUCHOS_TEST_FOR_EXCEPT("This class does not support DgDx(j) as a linear operator yet.");
return Teuchos::null;
}
template<class Scalar>
RCP<LinearOpBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::create_DgDp_op_impl(int j, int l) const
{
TEUCHOS_TEST_FOR_EXCEPT("This class does not support DgDp(j,l) as a linear operator yet.");
return Teuchos::null;
}
template<class Scalar>
ModelEvaluatorBase::OutArgs<Scalar>
DefaultMultiPeriodModelEvaluator<Scalar>::createOutArgsImpl() const
{
typedef ModelEvaluatorBase MEB;
MEB::OutArgs<Scalar> periodOutArgs = periodModel_->createOutArgs();
MEB::OutArgsSetup<Scalar> outArgs;
outArgs.setModelEvalDescription(this->description());
outArgs.set_Np_Ng(Np_,Ng_);
// f
if (periodOutArgs.supports(MEB::OUT_ARG_f) ) {
outArgs.setSupports(MEB::OUT_ARG_f);
}
// W_op
if (periodOutArgs.supports(MEB::OUT_ARG_W_op) ) {
outArgs.setSupports(MEB::OUT_ARG_W_op);
outArgs.set_W_properties(periodOutArgs.get_W_properties());
}
// Note: We will not directly support the LOWSB form W as we will let the
// default base class handle this given our W_factory!
// DfDp(l)
for ( int l = 0; l < Np_; ++l ) {
const int period_l = this->period_l(l);
const MEB::DerivativeSupport period_DfDp_l_support
= periodOutArgs.supports(MEB::OUT_ARG_DfDp,period_l);
if (!period_DfDp_l_support.none()) {
outArgs.setSupports( MEB::OUT_ARG_DfDp, l, period_DfDp_l_support );
outArgs.set_DfDp_properties(
l, periodOutArgs.get_DfDp_properties(period_l) );
}
}
// DgDx_dot
const MEB::DerivativeSupport
period_DgDx_dot_support = periodOutArgs.supports(MEB::OUT_ARG_DgDx_dot,g_index_);
if (!period_DgDx_dot_support.none()) {
outArgs.setSupports( MEB::OUT_ARG_DgDx_dot, 0, period_DgDx_dot_support );
outArgs.set_DgDx_dot_properties(
0, periodOutArgs.get_DgDx_dot_properties(g_index_) );
}
// DgDx
const MEB::DerivativeSupport
period_DgDx_support = periodOutArgs.supports(MEB::OUT_ARG_DgDx,g_index_);
if (!period_DgDx_support.none()) {
outArgs.setSupports( MEB::OUT_ARG_DgDx, 0, period_DgDx_support );
outArgs.set_DgDx_properties(
0, periodOutArgs.get_DgDx_properties(g_index_) );
}
// DgDp(l)
for ( int l = 0; l < Np_; ++l ) {
const int period_l = this->period_l(l);
const MEB::DerivativeSupport period_DgDp_l_support
= periodOutArgs.supports(MEB::OUT_ARG_DgDp, g_index_, period_l);
if (!period_DgDp_l_support.none()) {
outArgs.setSupports( MEB::OUT_ARG_DgDp, 0, l, period_DgDp_l_support );
outArgs.set_DgDp_properties(
0, l, periodOutArgs.get_DgDp_properties(g_index_,period_l) );
}
}
return outArgs;
}
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::evalModelImpl(
const ModelEvaluatorBase::InArgs<Scalar> &inArgs,
const ModelEvaluatorBase::OutArgs<Scalar> &outArgs
) const
{
using Teuchos::rcp_dynamic_cast;
typedef Teuchos::ScalarTraits<Scalar> ST;
typedef ModelEvaluatorBase MEB;
typedef Teuchos::VerboseObjectTempState<ModelEvaluatorBase> VOTSME;
THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_GEN_BEGIN(
"DefaultMultiPeriodModelEvaluator",inArgs,outArgs,periodModel_ );
// ToDo: You will have to set the verbosity level for each of the
// periodModels_[i] individually below!
const int N = x_bar_space_->numBlocks();
const int Np = this->Np_;
//const int Ng = this->Ng_;
//
// A) Setup InArgs
//
RCP<const ProductVectorBase<Scalar> > x_bar;
if (inArgs.supports(MEB::IN_ARG_x)) {
x_bar = rcp_dynamic_cast<const ProductVectorBase<Scalar> >(
inArgs.get_x(), true );
TEUCHOS_TEST_FOR_EXCEPTION(
is_null(x_bar), std::logic_error,
"Error, if x is supported, it must be set!"
);
}
//
// B) Setup OutArgs
//
RCP<ProductVectorBase<Scalar> > f_bar;
if (outArgs.supports(MEB::OUT_ARG_f)) {
f_bar = rcp_dynamic_cast<ProductVectorBase<Scalar> >(
outArgs.get_f(), true );
}
Array<MEB::Derivative<Scalar> > DfDp_bar(Np);
Array<RCP<ProductMultiVectorBase<Scalar> > > DfDp_bar_mv(Np);
for ( int l = 0; l < Np; ++l ) {
if (!outArgs.supports(MEB::OUT_ARG_DfDp,l).none()) {
MEB::Derivative<Scalar>
DfDp_bar_l = outArgs.get_DfDp(l);
DfDp_bar[l] = DfDp_bar_l;
DfDp_bar_mv[l] = rcp_dynamic_cast<ProductMultiVectorBase<Scalar> >(
DfDp_bar_l.getMultiVector(), true );
TEUCHOS_TEST_FOR_EXCEPTION(
(
!DfDp_bar_l.isEmpty()
&&
(
is_null(DfDp_bar_mv[l])
||
DfDp_bar_l.getMultiVectorOrientation() != MEB::DERIV_MV_BY_COL
)
),
std::logic_error,
"Error, we currently can only handle DfDp as an column-based multi-vector!"
);
}
}
RCP<BlockedLinearOpBase<Scalar> > W_op_bar;
if (outArgs.supports(MEB::OUT_ARG_W_op)) {
W_op_bar = rcp_dynamic_cast<BlockedLinearOpBase<Scalar> >(
outArgs.get_W_op(), true
);
}
RCP<VectorBase<Scalar> >
g_bar = outArgs.get_g(0);
MEB::Derivative<Scalar> DgDx_dot_bar;
RCP<ProductMultiVectorBase<Scalar> > DgDx_dot_bar_mv;
if (!outArgs.supports(MEB::OUT_ARG_DgDx_dot,0).none()) {
DgDx_dot_bar = outArgs.get_DgDx_dot(0);
DgDx_dot_bar_mv = rcp_dynamic_cast<ProductMultiVectorBase<Scalar> >(
DgDx_dot_bar.getMultiVector(), true );
TEUCHOS_TEST_FOR_EXCEPTION(
(
!DgDx_dot_bar.isEmpty()
&&
(
is_null(DgDx_dot_bar_mv)
||
DgDx_dot_bar.getMultiVectorOrientation() != MEB::DERIV_TRANS_MV_BY_ROW
)
),
std::logic_error,
"Error, we currently can only handle DgDx_dot as an row-based multi-vector!"
);
}
MEB::Derivative<Scalar> DgDx_bar;
RCP<ProductMultiVectorBase<Scalar> > DgDx_bar_mv;
if (!outArgs.supports(MEB::OUT_ARG_DgDx,0).none()) {
DgDx_bar = outArgs.get_DgDx(0);
DgDx_bar_mv = rcp_dynamic_cast<ProductMultiVectorBase<Scalar> >(
DgDx_bar.getMultiVector(), true );
TEUCHOS_TEST_FOR_EXCEPTION(
(
!DgDx_bar.isEmpty()
&&
(
is_null(DgDx_bar_mv)
||
DgDx_bar.getMultiVectorOrientation() != MEB::DERIV_TRANS_MV_BY_ROW
)
),
std::logic_error,
"Error, we currently can only handle DgDx as an row-based multi-vector!"
);
}
Array<MEB::Derivative<Scalar> > DgDp_bar(Np);
Array<RCP<MultiVectorBase<Scalar> > > DgDp_bar_mv(Np);
for ( int l = 0; l < Np; ++l ) {
if (!outArgs.supports(MEB::OUT_ARG_DgDp,0,l).none()) {
MEB::Derivative<Scalar>
DgDp_bar_l = outArgs.get_DgDp(0,l);
DgDp_bar[l] = DgDp_bar_l;
DgDp_bar_mv[l] = DgDp_bar_l.getMultiVector();
TEUCHOS_TEST_FOR_EXCEPTION(
!DgDp_bar_l.isEmpty() && is_null(DgDp_bar_mv[l]),
std::logic_error,
"Error, we currently can only handle DgDp as some type of multi-vector!"
);
}
}
//
// C) Evaluate the model
//
// C.1) Set up storage and do some initializations
MEB::InArgs<Scalar>
periodInArgs = periodModel_->createInArgs();
// ToDo: The above will have to change if you allow different structures for
// each period model!
// Set all of the parameters that will just be passed through
for ( int l = 0; l < Np; ++l )
periodInArgs.set_p( period_l(l), inArgs.get_p(l) ); // Can be null just fine
MEB::OutArgs<Scalar>
periodOutArgs = periodModel_->createOutArgs();
// ToDo: The above will have to change if you allow different structures for
// each period model!
// Create storage for period g's that will be summed into global g_bar
periodOutArgs.set_g(
g_index_, createMember<Scalar>( periodModel_->get_g_space(g_index_) ) );
// Zero out global g_bar that will be summed into below
if (!is_null(g_bar) )
assign( g_bar.ptr(), ST::zero() );
// Set up storage for peroid DgDp[l] objects that will be summed into global
// DgDp_bar[l] and zero out DgDp_bar[l] that will be summed into.
for ( int l = 0; l < Np; ++l ) {
if ( !is_null(DgDp_bar_mv[l]) ) {
assign(DgDp_bar_mv[l].ptr(), ST::zero());
periodOutArgs.set_DgDp(
g_index_, period_l(l),
create_DgDp_mv(
*periodModel_, g_index_, period_l(l),
DgDp_bar[l].getMultiVectorOrientation()
)
);
}
}
// C.2) Loop over periods and assemble the model
for ( int i = 0; i < N; ++i ) {
VOTSME thyraModel_outputTempState(periodModels_[i],out,verbLevel);
// C.2.a) Set period-speicific InArgs and OutArgs
for ( int k = 0; k < numPeriodZs(); ++k )
periodInArgs.set_p( z_indexes_[k], z_[i][k] );
if (!is_null(x_bar))
periodInArgs.set_x(x_bar->getVectorBlock(i));
if (!is_null(f_bar))
periodOutArgs.set_f(f_bar->getNonconstVectorBlock(i)); // Updated in place!
if ( !is_null(W_op_bar) )
periodOutArgs.set_W_op(W_op_bar->getNonconstBlock(i,i));
for ( int l = 0; l < Np; ++l ) {
if ( !is_null(DfDp_bar_mv[l]) ) {
periodOutArgs.set_DfDp(
period_l(l),
MEB::Derivative<Scalar>(
DfDp_bar_mv[l]->getNonconstMultiVectorBlock(i),
MEB::DERIV_MV_BY_COL
)
);
}
}
if ( !is_null(DgDx_dot_bar_mv) ) {
periodOutArgs.set_DgDx_dot(
g_index_,
MEB::Derivative<Scalar>(
DgDx_dot_bar_mv->getNonconstMultiVectorBlock(i),
MEB::DERIV_TRANS_MV_BY_ROW
)
);
}
if ( !is_null(DgDx_bar_mv) ) {
periodOutArgs.set_DgDx(
g_index_,
MEB::Derivative<Scalar>(
DgDx_bar_mv->getNonconstMultiVectorBlock(i),
MEB::DERIV_TRANS_MV_BY_ROW
)
);
}
// C.2.b) Evaluate the period model
periodModels_[i]->evalModel( periodInArgs, periodOutArgs );
// C.2.c) Process output arguments that need processed
// Sum into global g_bar
if (!is_null(g_bar)) {
Vp_StV( g_bar.ptr(), g_weights_[i], *periodOutArgs.get_g(g_index_) );
}
// Sum into global DgDp_bar
for ( int l = 0; l < Np; ++l ) {
if ( !is_null(DgDp_bar_mv[l]) ) {
update(
g_weights_[i],
*periodOutArgs.get_DgDp(g_index_,period_l(l)).getMultiVector(),
DgDp_bar_mv[l].ptr()
);
}
}
// Scale DgDx_dot_bar_mv[i]
if ( !is_null(DgDx_dot_bar_mv) ) {
scale( g_weights_[i],
DgDx_dot_bar_mv->getNonconstMultiVectorBlock(i).ptr() );
}
// Scale DgDx_bar_mv[i]
if ( !is_null(DgDx_bar_mv) ) {
scale( g_weights_[i],
DgDx_bar_mv->getNonconstMultiVectorBlock(i).ptr() );
}
}
// ToDo: We need to do some type of global sum of g_bar and DgDp_bar to
// account for other clusters of processes. I might do this with a separate
// non-ANA class.
// Once we get here, all of the quantities should be updated and we should
// be all done!
THYRA_MODEL_EVALUATOR_DECORATOR_EVAL_MODEL_END();
}
// private
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::set_z_indexes_and_create_period_l_map(
const Array<int> &z_indexes
)
{
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT( Np_ <= 0 && "Error, Np must be set!" );
#endif
z_indexes_ = z_indexes;
period_l_map_.resize(0);
const int numTotalParams = Np_ + z_indexes_.size();
Array<int>::const_iterator
z_indexes_itr = z_indexes_.begin(),
z_indexes_end = z_indexes_.end();
int last_z_index = -1;
for ( int k = 0; k < numTotalParams; ++k ) {
if ( z_indexes_itr == z_indexes_end || k < *z_indexes_itr ) {
// This is a "free" parameter subvector
period_l_map_.push_back(k);
}
else {
// This is a "fixed" period parameter subvector so increment
// z_indexes iterator.
#ifdef TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPT( k != *z_indexes_itr && "This should never happen!" );
#endif
const int tmp_last_z_index = *z_indexes_itr;
++z_indexes_itr;
if ( z_indexes_itr != z_indexes_end ) {
#ifdef TEUCHOS_DEBUG
if ( last_z_index >= 0 ) {
TEUCHOS_TEST_FOR_EXCEPTION(
*z_indexes_itr <= last_z_index, std::logic_error,
"Error, the z_indexes array = " << toString(z_indexes_)
<< " is not sorted or contains duplicate entries!"
);
}
#endif
last_z_index = tmp_last_z_index;
}
}
}
}
template<class Scalar>
void DefaultMultiPeriodModelEvaluator<Scalar>::wrapNominalValuesAndBounds()
{
using Teuchos::rcp_dynamic_cast;
typedef ModelEvaluatorBase MEB;
nominalValues_ = this->createInArgs();
lowerBounds_ = this->createInArgs();
upperBounds_ = this->createInArgs();
const MEB::InArgs<Scalar>
periodNominalValues = periodModel_->getNominalValues(),
periodLowerBounds = periodModel_->getLowerBounds(),
periodUpperBounds = periodModel_->getUpperBounds();
if (periodNominalValues.supports(MEB::IN_ARG_x)) {
if( !is_null(periodNominalValues.get_x()) ) {
// If the first peroid model has nominal values for x, then all of them
// must also!
RCP<Thyra::ProductVectorBase<Scalar> >
x_bar_init = createProductVector(x_bar_space_);
const int N = this->N();
for ( int i = 0; i < N; ++i ) {
assign(
x_bar_init->getNonconstVectorBlock(i).ptr(),
*periodModels_[i]->getNominalValues().get_x()
);
}
nominalValues_.set_x(x_bar_init);
}
if( !is_null(periodLowerBounds.get_x()) ) {
// If the first peroid model has lower bounds for for x, then all of
// them must also!
RCP<Thyra::ProductVectorBase<Scalar> >
x_bar_l = createProductVector(x_bar_space_);
const int N = this->N();
for ( int i = 0; i < N; ++i ) {
assign(
x_bar_l->getNonconstVectorBlock(i).ptr(),
*periodModels_[i]->getLowerBounds().get_x()
);
}
lowerBounds_.set_x(x_bar_l);
}
if( !is_null(periodUpperBounds.get_x()) ) {
// If the first peroid model has upper bounds for for x, then all of
// them must also!
RCP<Thyra::ProductVectorBase<Scalar> >
x_bar_u = createProductVector(x_bar_space_);
const int N = this->N();
for ( int i = 0; i < N; ++i ) {
assign(
x_bar_u->getNonconstVectorBlock(i).ptr(),
*periodModels_[i]->getUpperBounds().get_x()
);
}
upperBounds_.set_x(x_bar_u);
}
}
// There can only be one set of nominal values for the non-period parameters
// so just take them from the first period!
for ( int l = 0; l < Np_; ++l ) {
const int period_l = this->period_l(l);
nominalValues_.set_p(l,periodNominalValues.get_p(period_l));
lowerBounds_.set_p(l,periodLowerBounds.get_p(period_l));
upperBounds_.set_p(l,periodUpperBounds.get_p(period_l));
}
}
template<class Scalar>
RCP<ProductVectorBase<Scalar> >
DefaultMultiPeriodModelEvaluator<Scalar>::createProductVector(
const RCP<const ProductVectorSpaceBase<Scalar> > &prodVecSpc
)
{
return Teuchos::rcp_dynamic_cast<ProductVectorBase<Scalar> >(
Thyra::createMember<Scalar>(prodVecSpc), true );
}
} // namespace Thyra
#endif // THYRA_DEFAULT_MULTI_PERIOD_MODEL_EVALUATOR_HPP
|