Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_Response_Residual.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_Residual_hpp__
44#define __Panzer_Response_Residual_hpp__
45
46#include <string>
47
48#include "Teuchos_RCP.hpp"
49
50#include "Thyra_VectorBase.hpp"
51#include "Thyra_LinearOpBase.hpp"
52
55#include "Panzer_Traits.hpp"
56
57namespace panzer {
58
63template <typename EvalT>
65public:
66 Response_Residual(const std::string & responseName,
67 const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & /* lof */) :
68 ResponseBase(responseName) {}
69 virtual ~Response_Residual() {}
70 virtual void scatterResponse() {}
71 virtual void initializeResponse() {}
72};
73
80template < >
82private:
83 Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;
84
85 Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > residual_;
86 mutable Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > ghostedResidual_;
87 // mutable because of lazy construction (as needed)
88
89public:
90 Response_Residual(const std::string & responseName,
91 const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof)
92 : ResponseBase(responseName)
93 , linObjFactory_(lof) {}
94 virtual ~Response_Residual() {}
95
99 Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > getGhostedResidual() const;
100
104 Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > getResidual() const;
105
109 void setResidual(const Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > & res);
110
114 Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > allocateResidualVector() const;
115
116 // Functions inherited from ResponseBase
117 virtual void initializeResponse() {}
118 virtual void scatterResponse() {}
119};
120
127template < >
129private:
130 Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;
131
132 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > jacobian_;
133 mutable Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > ghostedJacobian_;
134 // mutable because of lazy construction (as needed)
135
136public:
137 Response_Residual(const std::string & responseName,
138 const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof)
139 : ResponseBase(responseName)
140 , linObjFactory_(lof) {}
142
146 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getGhostedJacobian() const;
147
151 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getJacobian() const;
152
156 void setJacobian(const Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > & res);
157
161 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > allocateJacobian() const;
162
163 // Functions inherited from ResponseBase
164 virtual void initializeResponse() {}
165 virtual void scatterResponse() {}
166};
167
168#ifdef Panzer_BUILD_HESSIAN_SUPPORT
175template < >
177private:
178 Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;
179
180 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > hessian_;
181 mutable Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > ghostedHessian_;
182 // mutable because of lazy construction (as needed)
183
184public:
185 Response_Residual(const std::string & responseName,
186 const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof)
187 : ResponseBase(responseName)
188 , linObjFactory_(lof) {}
190
194 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getGhostedHessian() const;
195
199 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getHessian() const;
200
204 void setHessian(const Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > & res);
205
209 Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > allocateHessian() const;
210
211 // Functions inherited from ResponseBase
212 virtual void initializeResponse() {}
213 virtual void scatterResponse() {}
214};
215#endif
216
217}
218
219#endif
Response_Residual(const std::string &responseName, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof)
Teuchos::RCP< Thyra::LinearOpBase< panzer::Traits::RealType > > ghostedHessian_
Teuchos::RCP< Thyra::LinearOpBase< panzer::Traits::RealType > > hessian_
virtual void scatterResponse()
Prepare the response for access by the user (do global communication)
Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > linObjFactory_
Teuchos::RCP< Thyra::LinearOpBase< panzer::Traits::RealType > > jacobian_
Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > linObjFactory_
Teuchos::RCP< Thyra::LinearOpBase< panzer::Traits::RealType > > ghostedJacobian_
Response_Residual(const std::string &responseName, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof)
virtual void scatterResponse()
Prepare the response for access by the user (do global communication)
Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > linObjFactory_
Response_Residual(const std::string &responseName, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof)
Teuchos::RCP< Thyra::VectorBase< panzer::Traits::RealType > > ghostedResidual_
Teuchos::RCP< Thyra::VectorBase< panzer::Traits::RealType > > residual_
virtual void scatterResponse()
Prepare the response for access by the user (do global communication)
Response_Residual(const std::string &responseName, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &)
virtual void scatterResponse()
Prepare the response for access by the user (do global communication)