Panzer Version of the Day
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
panzer::LinearObjContainer Class Referenceabstract

Abstract, linear-algebra-library-agnostic container for the vectors and matrix used in a nonlinear/transient solve. More...

#include <Panzer_LinearObjContainer.hpp>

Inheritance diagram for panzer::LinearObjContainer:
Inheritance graph
[legend]

Public Types

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

virtual ~LinearObjContainer ()
 
virtual void initialize ()=0
 Zeroes out all linear objects currently held by this container.
 
- 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.
 

Detailed Description

Abstract, linear-algebra-library-agnostic container for the vectors and matrix used in a nonlinear/transient solve.

Concrete subclasses (e.g. panzer::TpetraLinearObjContainer) hold the actual solution vector x, its time derivative dxdt, the residual vector f, and the Jacobian matrix, in whatever linear algebra library they wrap, and are produced/consumed by a matching LinearObjFactory. As a GlobalEvaluationData_Default, it participates in the gather/scatter preEvaluate lookup mechanism but performs no ghost/global communication itself (that is handled by the owning LinearObjFactory).

Definition at line 39 of file Panzer_LinearObjContainer.hpp.

Member Enumeration Documentation

◆ Members

Bitmask flags identifying which of the linear objects (solution, time derivative, residual, matrix) are present/requested.

Enumerator
DxDt 
Mat 

Definition at line 44 of file Panzer_LinearObjContainer.hpp.

Constructor & Destructor Documentation

◆ ~LinearObjContainer()

virtual panzer::LinearObjContainer::~LinearObjContainer ( )
inlinevirtual

Definition at line 41 of file Panzer_LinearObjContainer.hpp.

Member Function Documentation

◆ initialize()

virtual void panzer::LinearObjContainer::initialize ( )
pure virtual

The documentation for this class was generated from the following file: