Panzer Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Private Member Functions | List of all members
panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > Class Template Reference

Tpetra-backed implementation of LinearObjContainer. More...

#include <Panzer_TpetraLinearObjContainer.hpp>

Inheritance diagram for panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >:
Inheritance graph
[legend]

Public Types

typedef LinearObjContainer::Members Members
 
typedef Tpetra::Vector< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > VectorType
 
typedef Tpetra::CrsMatrix< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > CrsMatrixType
 
typedef Tpetra::CrsGraph< LocalOrdinalT, GlobalOrdinalT, NodeT > CrsGraphType
 
typedef Tpetra::Map< LocalOrdinalT, GlobalOrdinalT, NodeT > MapType
 
typedef Tpetra::Import< LocalOrdinalT, GlobalOrdinalT, NodeT > ImportType
 
typedef Tpetra::Export< LocalOrdinalT, GlobalOrdinalT, NodeT > ExportType
 
- Public Types inherited from panzer::LinearObjContainer
enum  Members { X =0x1 , DxDt =0x2 , F =0x4 , Mat =0x8 }
 Bitmask flags identifying which of the linear objects (solution, time derivative, residual, matrix) are present/requested. More...
 

Public Member Functions

 TpetraLinearObjContainer (const Teuchos::RCP< const Tpetra::Map< LocalOrdinalT, GlobalOrdinalT, NodeT > > &domain, const Teuchos::RCP< const Tpetra::Map< LocalOrdinalT, GlobalOrdinalT, NodeT > > &range)
 Construct from the domain (solution) and range (residual) Tpetra maps, building the corresponding Thyra vector spaces.
 
virtual void initialize ()
 Zeroes out whichever of x, dxdt, f, and A are currently set.
 
void clear ()
 Wipe out stored data.
 
- Public Member Functions inherited from panzer::LinearObjContainer
virtual ~LinearObjContainer ()
 
- Public Member Functions inherited from panzer::GlobalEvaluationData_Default
 GlobalEvaluationData_Default ()
 
 GlobalEvaluationData_Default (const GlobalEvaluationData_Default &s)
 
virtual void ghostToGlobal (int)
 
virtual void globalToGhost (int)
 
virtual void initializeData ()
 
void setRequiresDirichletAdjustment (bool b)
 
bool requiresDirichletAdjustment () const
 
- Public Member Functions inherited from panzer::GlobalEvaluationData
virtual ~GlobalEvaluationData ()=0
 
virtual void print (std::ostream &os) const
 Diagnostic function for determinning what's in this object.
 
- Public Member Functions inherited from panzer::ThyraObjContainer< ScalarT >
virtual ~ThyraObjContainer ()
 
void clear ()
 

Private Member Functions

 TpetraLinearObjContainer ()
 

ThyraObjContainer overrides: Thyra-wrapped views of the same underlying Tpetra data.

typedef Thyra::TpetraOperatorVectorExtraction< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > TOE
 
Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > domainSpace
 
Teuchos::RCP< const Thyra::VectorSpaceBase< ScalarT > > rangeSpace
 
Teuchos::RCP< Tpetra::Vector< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > > x
 
Teuchos::RCP< Tpetra::Vector< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > > dxdt
 
Teuchos::RCP< Tpetra::Vector< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > > f
 
Teuchos::RCP< Tpetra::CrsMatrix< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT > > A
 
virtual void set_x_th (const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &in)
 
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > get_x_th () const
 
virtual void set_dxdt_th (const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &in)
 
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > get_dxdt_th () const
 
virtual void set_f_th (const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &in)
 
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > get_f_th () const
 
virtual void set_A_th (const Teuchos::RCP< Thyra::LinearOpBase< ScalarT > > &in)
 
virtual Teuchos::RCP< Thyra::LinearOpBase< ScalarT > > get_A_th () const
 

Direct Tpetra accessors for the solution, time derivative, residual, and Jacobian.

void set_x (const Teuchos::RCP< VectorType > &in)
 
const Teuchos::RCP< VectorType > get_x () const
 
void set_dxdt (const Teuchos::RCP< VectorType > &in)
 
const Teuchos::RCP< VectorType > get_dxdt () const
 
void set_f (const Teuchos::RCP< VectorType > &in)
 
const Teuchos::RCP< VectorType > get_f () const
 
void set_A (const Teuchos::RCP< CrsMatrixType > &in)
 
const Teuchos::RCP< CrsMatrixType > get_A () const
 
void initializeMatrix (ScalarT value)
 Sets every entry of the Jacobian matrix A to value.
 

Detailed Description

template<typename ScalarT, typename LocalOrdinalT, typename GlobalOrdinalT, typename NodeT = panzer::TpetraNodeType>
class panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >

Tpetra-backed implementation of LinearObjContainer.

Holds the solution vector x, its time derivative dxdt, the residual vector f, and the Jacobian matrix A as Tpetra objects, and (via ThyraObjContainer) exposes Thyra-wrapped views of the same data so panzer's linear-algebra-agnostic code can operate on them without depending on Tpetra directly. Built and populated by a matching Tpetra linear object factory.

Template Parameters
ScalarTthe field scalar type.
LocalOrdinalTlocal ordinal type.
GlobalOrdinalTglobal ordinal type.
NodeTKokkos node type; defaults to panzer::TpetraNodeType.

Definition at line 47 of file Panzer_TpetraLinearObjContainer.hpp.

Member Typedef Documentation

◆ Members

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef LinearObjContainer::Members panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::Members

Definition at line 52 of file Panzer_TpetraLinearObjContainer.hpp.

◆ VectorType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::Vector<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::VectorType

Definition at line 54 of file Panzer_TpetraLinearObjContainer.hpp.

◆ CrsMatrixType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::CrsMatrix<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::CrsMatrixType

Definition at line 55 of file Panzer_TpetraLinearObjContainer.hpp.

◆ CrsGraphType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::CrsGraph<LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::CrsGraphType

Definition at line 56 of file Panzer_TpetraLinearObjContainer.hpp.

◆ MapType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::Map<LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::MapType

Definition at line 57 of file Panzer_TpetraLinearObjContainer.hpp.

◆ ImportType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::Import<LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::ImportType

Definition at line 58 of file Panzer_TpetraLinearObjContainer.hpp.

◆ ExportType

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Tpetra::Export<LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::ExportType

Definition at line 59 of file Panzer_TpetraLinearObjContainer.hpp.

◆ TOE

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
typedef Thyra::TpetraOperatorVectorExtraction<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::TOE
private

Definition at line 151 of file Panzer_TpetraLinearObjContainer.hpp.

Constructor & Destructor Documentation

◆ TpetraLinearObjContainer() [1/2]

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::TpetraLinearObjContainer ( )
private

◆ TpetraLinearObjContainer() [2/2]

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::TpetraLinearObjContainer ( const Teuchos::RCP< const Tpetra::Map< LocalOrdinalT, GlobalOrdinalT, NodeT > > &  domain,
const Teuchos::RCP< const Tpetra::Map< LocalOrdinalT, GlobalOrdinalT, NodeT > > &  range 
)
inline

Construct from the domain (solution) and range (residual) Tpetra maps, building the corresponding Thyra vector spaces.

Parameters
[in]domainmap for the solution/time-derivative vectors (x, dxdt) and the Jacobian's domain space.
[in]rangemap for the residual vector (f) and the Jacobian's range space.

Definition at line 66 of file Panzer_TpetraLinearObjContainer.hpp.

Member Function Documentation

◆ initialize()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::initialize ( )
inlinevirtual

Zeroes out whichever of x, dxdt, f, and A are currently set.

Implements panzer::LinearObjContainer.

Definition at line 74 of file Panzer_TpetraLinearObjContainer.hpp.

◆ clear()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::clear ( )
inline

Wipe out stored data.

Definition at line 86 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_x()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_x ( const Teuchos::RCP< VectorType > &  in)
inline

Definition at line 96 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_x()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
const Teuchos::RCP< VectorType > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_x ( ) const
inline

Definition at line 97 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_dxdt()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_dxdt ( const Teuchos::RCP< VectorType > &  in)
inline

Definition at line 99 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_dxdt()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
const Teuchos::RCP< VectorType > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_dxdt ( ) const
inline

Definition at line 100 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_f()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_f ( const Teuchos::RCP< VectorType > &  in)
inline

Definition at line 102 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_f()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
const Teuchos::RCP< VectorType > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_f ( ) const
inline

Definition at line 103 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_A()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_A ( const Teuchos::RCP< CrsMatrixType > &  in)
inline

Definition at line 105 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_A()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
const Teuchos::RCP< CrsMatrixType > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_A ( ) const
inline

Definition at line 106 of file Panzer_TpetraLinearObjContainer.hpp.

◆ initializeMatrix()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::initializeMatrix ( ScalarT  value)
inlinevirtual

Sets every entry of the Jacobian matrix A to value.

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 110 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_x_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_x_th ( const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &  in)
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 117 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_x_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_x_th ( ) const
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 125 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_dxdt_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_dxdt_th ( const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &  in)
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 128 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_dxdt_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_dxdt_th ( ) const
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 136 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_f_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_f_th ( const Teuchos::RCP< Thyra::VectorBase< ScalarT > > &  in)
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 139 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_f_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual Teuchos::RCP< Thyra::VectorBase< ScalarT > > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_f_th ( ) const
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 141 of file Panzer_TpetraLinearObjContainer.hpp.

◆ set_A_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual void panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::set_A_th ( const Teuchos::RCP< Thyra::LinearOpBase< ScalarT > > &  in)
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 144 of file Panzer_TpetraLinearObjContainer.hpp.

◆ get_A_th()

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
virtual Teuchos::RCP< Thyra::LinearOpBase< ScalarT > > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::get_A_th ( ) const
inlinevirtual

Implements panzer::ThyraObjContainer< ScalarT >.

Definition at line 146 of file Panzer_TpetraLinearObjContainer.hpp.

Member Data Documentation

◆ domainSpace

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::domainSpace
private

Definition at line 153 of file Panzer_TpetraLinearObjContainer.hpp.

◆ rangeSpace

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<const Thyra::VectorSpaceBase<ScalarT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::rangeSpace
private

Definition at line 154 of file Panzer_TpetraLinearObjContainer.hpp.

◆ x

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<Tpetra::Vector<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::x
private

Definition at line 156 of file Panzer_TpetraLinearObjContainer.hpp.

◆ dxdt

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<Tpetra::Vector<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::dxdt
private

Definition at line 156 of file Panzer_TpetraLinearObjContainer.hpp.

◆ f

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<Tpetra::Vector<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::f
private

Definition at line 156 of file Panzer_TpetraLinearObjContainer.hpp.

◆ A

template<typename ScalarT , typename LocalOrdinalT , typename GlobalOrdinalT , typename NodeT = panzer::TpetraNodeType>
Teuchos::RCP<Tpetra::CrsMatrix<ScalarT,LocalOrdinalT,GlobalOrdinalT,NodeT> > panzer::TpetraLinearObjContainer< ScalarT, LocalOrdinalT, GlobalOrdinalT, NodeT >::A
private

Definition at line 157 of file Panzer_TpetraLinearObjContainer.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8