Panzer  Version of the Day
Panzer_Response_ExtremeValue.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Panzer: A partial differential equation assembly
5 // engine for strongly coupled complex multiphysics systems
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
39 // Eric C. Cyr (eccyr@sandia.gov)
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef __Panzer_Response_ExtremeValue_hpp__
44 #define __Panzer_Response_ExtremeValue_hpp__
45 
46 #include <string>
47 #include <limits>
48 
49 #include <mpi.h> // need for comm
50 
51 #include "Teuchos_RCP.hpp"
52 
53 #include "Thyra_VectorBase.hpp"
54 #include "Thyra_VectorSpaceBase.hpp"
55 
56 #include "Epetra_Map.h"
57 #include "Epetra_Vector.h"
58 #include "Epetra_MpiComm.h"
59 
65 
66 
67 namespace panzer {
68 
73 template <typename EvalT>
76 public:
77  typedef typename EvalT::ScalarT ScalarT;
78 
79  Response_ExtremeValue(const std::string & responseName,MPI_Comm comm,bool useMax,
80  const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & linObjFact=Teuchos::null)
81  : ResponseMESupport_Default<EvalT>(responseName,comm), value(0.0), linObjFactory_(linObjFact), useMax_(useMax)
82  {
83  if(linObjFactory_!=Teuchos::null) {
84  // requires thyra object factory
85  thyraObjFactory_ = Teuchos::rcp_dynamic_cast<const panzer::ThyraObjFactory<double> >(linObjFactory_,true);
86  setSolnVectorSpace(thyraObjFactory_->getThyraDomainSpace());
87 
88  // build a ghosted container, with a solution vector
89  ghostedContainer_ = linObjFactory_->buildGhostedLinearObjContainer();
90 
91  // set ghosted container (work space for assembly)
93 
94  using Teuchos::rcp_dynamic_cast;
95  }
96  }
97 
100 
102  virtual void scatterResponse();
103 
104  virtual void initializeResponse()
105  { if(useMax_)
106  value = -std::numeric_limits<ScalarT>::max();
107  else
108  value = std::numeric_limits<ScalarT>::max();
109 
110  if(ghostedContainer_!=Teuchos::null) ghostedContainer_->initialize(); }
111 
112  // from ResponseMESupport_Default
113 
115  virtual std::size_t localSizeRequired() const { return 1; }
116 
118  virtual bool vectorIsDistributed() const { return false; }
119 
121  Teuchos::RCP<Thyra::VectorBase<double> > getGhostedVector() const
122  { return Teuchos::rcp_dynamic_cast<const ThyraObjContainer<double> >(ghostedContainer_)->get_x_th(); }
123 
124  void adjustForDirichletConditions(const GlobalEvaluationData & localBCRows,const GlobalEvaluationData & globalBCRows);
125 
126 private:
128  void setSolnVectorSpace(const Teuchos::RCP<const Thyra::VectorSpaceBase<double> > & soln_vs);
129 
130  // hide these methods
133 
134  Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;
135  Teuchos::RCP<const panzer::ThyraObjFactory<double> > thyraObjFactory_;
136 
137  Teuchos::RCP<LinearObjContainer> uniqueContainer_;
138  Teuchos::RCP<LinearObjContainer> ghostedContainer_;
139 
140  bool useMax_;
141 };
142 
143 }
144 
145 #endif
Teuchos::RCP< Thyra::VectorBase< double > > getGhostedVector() const
Get ghosted responses (this will be filled by the evaluator)
Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > linObjFactory_
Teuchos::RCP< const panzer::ThyraObjFactory< double > > thyraObjFactory_
virtual void scatterResponse()
This simply does global summation, then shoves the result into a vector.
Response_ExtremeValue(const std::string &responseName, MPI_Comm comm, bool useMax, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &linObjFact=Teuchos::null)
virtual std::size_t localSizeRequired() const
What is the number of values you need locally.
virtual bool vectorIsDistributed() const
Is the vector distributed (or replicated)
ScalarT value
provide direct access, this thing is pretty simple
void setSolnVectorSpace(const Teuchos::RCP< const Thyra::VectorSpaceBase< double > > &soln_vs)
Set solution vector space.
Teuchos::RCP< LinearObjContainer > uniqueContainer_
Teuchos::RCP< LinearObjContainer > ghostedContainer_
void adjustForDirichletConditions(const GlobalEvaluationData &localBCRows, const GlobalEvaluationData &globalBCRows)