waves
Basic FE playground
katoptron::LinearSolver Class Reference

Solver class which includes utilities such as timers and VTK writers. More...

#include <LinearSolver.h>

Inheritance diagram for katoptron::LinearSolver:
Collaboration diagram for katoptron::LinearSolver:

Public Member Functions

 LinearSolver (Problem &_pbl, Teuchos::RCP< Teuchos::ParameterList > _solverList, int _numPrimalDPN, size_t _minimum_ensemble_size)
 LinearSolver constructor. More...
 
virtual ~LinearSolver ()
 
void setGUI (DisplayHook &hook)
 Set the GUI. More...
 

Static Public Member Functions

static fwk::Timers & getTimers ()
 Manage timers. More...
 

Public Attributes

Problempbl
 
Teuchos::RCP< Teuchos::ParameterList > solverList
 
const int numPrimalDPN
 
const size_t minimum_ensemble_size
 
size_t active_set_iteration
 
DisplayHookdhook
 

Protected Member Functions

template<typename scalar >
void writeResults (Teuchos::RCP< Tpetra::Vector< scalar, Map::local_ordinal_type, Map::global_ordinal_type >> xPost, size_t numNodes, std::string name, size_t ast, bool final_result, bool write_txt, Teuchos::RCP< Map > map, Teuchos::RCP< RandomField< scalar, Kokkos::DefaultExecutionSpace >> random_field)
 Write results on disk in VTK format. More...
 

Detailed Description

Solver class which includes utilities such as timers and VTK writers.

Constructor & Destructor Documentation

◆ LinearSolver()

katoptron::LinearSolver::LinearSolver ( Problem _pbl,
Teuchos::RCP< Teuchos::ParameterList >  _solverList,
int  _numPrimalDPN,
size_t  _minimum_ensemble_size 
)
inline

LinearSolver constructor.

Arguments:

  • _pbl: A Problem object,
  • _solverList: an RCP to a ParameterList object which describes the solver,
  • _numPrimalDPN: the number of degrees of freedom per node (without taking into account the Lagrange multipliers),
  • _minimum_ensemble_size: the used ensemble size (1, 8, 16, 24, or 32),

◆ ~LinearSolver()

virtual katoptron::LinearSolver::~LinearSolver ( )
inlinevirtual

Member Function Documentation

◆ getTimers()

static fwk::Timers& katoptron::LinearSolver::getTimers ( )
inlinestatic

Manage timers.

◆ setGUI()

void katoptron::LinearSolver::setGUI ( DisplayHook hook)
inline

Set the GUI.

◆ writeResults()

template<typename scalar >
void katoptron::LinearSolver::writeResults ( Teuchos::RCP< Tpetra::Vector< scalar, Map::local_ordinal_type, Map::global_ordinal_type >>  xPost,
size_t  numNodes,
std::string  name,
size_t  ast,
bool  final_result,
bool  write_txt,
Teuchos::RCP< Map map,
Teuchos::RCP< RandomField< scalar, Kokkos::DefaultExecutionSpace >>  random_field 
)
inlineprotected

Write results on disk in VTK format.

Member Data Documentation

◆ active_set_iteration

size_t katoptron::LinearSolver::active_set_iteration

◆ dhook

DisplayHook* katoptron::LinearSolver::dhook

◆ minimum_ensemble_size

const size_t katoptron::LinearSolver::minimum_ensemble_size

◆ numPrimalDPN

const int katoptron::LinearSolver::numPrimalDPN

◆ pbl

Problem& katoptron::LinearSolver::pbl

◆ solverList

Teuchos::RCP<Teuchos::ParameterList> katoptron::LinearSolver::solverList

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