Panzer_Response_Residual.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//
// Copyright 2011 NTESS and the Panzer contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef __Panzer_Response_Residual_hpp__
#define __Panzer_Response_Residual_hpp__

#include <string>

#include "Teuchos_RCP.hpp"

#include "Thyra_VectorBase.hpp"
#include "Thyra_LinearOpBase.hpp"

#include "Panzer_ResponseBase.hpp"
#include "Panzer_LinearObjFactory.hpp"
#include "Panzer_Traits.hpp"

namespace panzer {

template <typename EvalT>
class Response_Residual : public ResponseBase {
public:
  Response_Residual(const std::string & responseName,
                     const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & /* lof */) :
    ResponseBase(responseName) {}
  virtual ~Response_Residual() {}
  virtual void scatterResponse() {}
  virtual void initializeResponse() {}
};

template < >
class Response_Residual<panzer::Traits::Residual> : public ResponseBase {
private:
  Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;

  Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > residual_;
  mutable Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > ghostedResidual_;
      // mutable because of lazy construction (as needed)

public:
  Response_Residual(const std::string & responseName,
                     const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof) 
     : ResponseBase(responseName) 
     , linObjFactory_(lof) {}
  virtual ~Response_Residual() {}

  Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > getGhostedResidual() const; 

  Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > getResidual() const; 

  void setResidual(const Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > & res);

  Teuchos::RCP<Thyra::VectorBase<panzer::Traits::RealType> > allocateResidualVector() const; 

  // Functions inherited from ResponseBase
  virtual void initializeResponse() {}
  virtual void scatterResponse() {}
};

template < >
class Response_Residual<panzer::Traits::Jacobian> : public ResponseBase {
private:
  Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > jacobian_;
  mutable Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > ghostedJacobian_;
      // mutable because of lazy construction (as needed)

public:
  Response_Residual(const std::string & responseName,
                     const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof) 
     : ResponseBase(responseName) 
     , linObjFactory_(lof) {}
  virtual ~Response_Residual() {}

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getGhostedJacobian() const; 

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getJacobian() const; 

  void setJacobian(const Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > & res);

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > allocateJacobian() const; 

  // Functions inherited from ResponseBase
  virtual void initializeResponse() {}
  virtual void scatterResponse() {}
};

#ifdef Panzer_BUILD_HESSIAN_SUPPORT

template < >
class Response_Residual<panzer::Traits::Hessian> : public ResponseBase {
private:
  Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > linObjFactory_;

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > hessian_;
  mutable Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > ghostedHessian_;
      // mutable because of lazy construction (as needed)

public:
  Response_Residual(const std::string & responseName,
                     const Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > & lof) 
     : ResponseBase(responseName) 
     , linObjFactory_(lof) {}
  virtual ~Response_Residual() {}

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getGhostedHessian() const; 

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > getHessian() const; 

  void setHessian(const Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > & res);

  Teuchos::RCP<Thyra::LinearOpBase<panzer::Traits::RealType> > allocateHessian() const; 

  // Functions inherited from ResponseBase
  virtual void initializeResponse() {}
  virtual void scatterResponse() {}
};
#endif

}

#endif