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

Abstract factory for building a Tempus integrator observer that has access to the STK mesh, DOF manager, and linear object factory, e.g. for writing solution snapshots to disk between time steps. More...

#include <Panzer_STK_TempusObserverFactory.hpp>

Public Member Functions

virtual ~TempusObserverFactory ()
 
virtual bool useNOXObserver () const =0
 Returns true if a NOX observer should also be attached alongside the Tempus observer.
 
virtual Teuchos::RCP< Tempus::IntegratorObserver< double > > buildTempusObserver (const Teuchos::RCP< panzer_stk::STK_Interface > &mesh, const Teuchos::RCP< const panzer::GlobalIndexer > &dof_manager, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof) const =0
 Builds a Tempus integrator observer configured with the given mesh, DOF manager, and linear object factory.
 

Detailed Description

Abstract factory for building a Tempus integrator observer that has access to the STK mesh, DOF manager, and linear object factory, e.g. for writing solution snapshots to disk between time steps.

Definition at line 32 of file Panzer_STK_TempusObserverFactory.hpp.

Constructor & Destructor Documentation

◆ ~TempusObserverFactory()

virtual panzer_stk::TempusObserverFactory::~TempusObserverFactory ( )
inlinevirtual

Definition at line 36 of file Panzer_STK_TempusObserverFactory.hpp.

Member Function Documentation

◆ useNOXObserver()

virtual bool panzer_stk::TempusObserverFactory::useNOXObserver ( ) const
pure virtual

Returns true if a NOX observer should also be attached alongside the Tempus observer.

◆ buildTempusObserver()

virtual Teuchos::RCP< Tempus::IntegratorObserver< double > > panzer_stk::TempusObserverFactory::buildTempusObserver ( const Teuchos::RCP< panzer_stk::STK_Interface > &  mesh,
const Teuchos::RCP< const panzer::GlobalIndexer > &  dof_manager,
const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &  lof 
) const
pure virtual

Builds a Tempus integrator observer configured with the given mesh, DOF manager, and linear object factory.

Parameters
[in]meshthe STK mesh the observer may write solution data to.
[in]dof_managermaps solution vector entries to mesh fields.
[in]loflinear object factory used to interpret the solution vector passed to the observer.

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