Container of linear-system (matrix, vectors) and mapping objects. More...

#include <LinearSystem.hpp>

Inherits stk::linsys::LinearSystemInterface.

Public Member Functions
	LinearSystem (MPI_Comm comm, fei::SharedPtr< fei::Factory > factory)
	Constructor.
virtual	~LinearSystem ()
	Destructor.
void	synchronize_mappings_and_structure ()
	This is a collective call -- will hang if only a subset of processors call it.
void	create_fei_LinearSystem ()
	Uses the fei::Factory (that was passed as a constructor argument) to create a fei::LinearSystem and populate it with a fei::Matrix and fei::Vectors.
void	finalize_assembly ()
	This is a collective call -- will hang if only a subset of processors call it.
const DofMapper &	get_DofMapper () const
	Return DOF-mapping object.
DofMapper &	get_DofMapper ()
	Return DOF-mapping object.
const fei::SharedPtr < fei::MatrixGraph >	get_fei_MatrixGraph () const
	Return fei::MatrixGraph object.
fei::SharedPtr< fei::MatrixGraph >	get_fei_MatrixGraph ()
	Return fei::MatrixGraph object.
const fei::SharedPtr < fei::LinearSystem >	get_fei_LinearSystem () const
	Return fei::LinearSystem object.
fei::SharedPtr< fei::LinearSystem >	get_fei_LinearSystem ()
	Return fei::LinearSystem object.
int	solve (int &status, const Teuchos::ParameterList &params)
	Solve the linear system.

Detailed Description

Container of linear-system (matrix, vectors) and mapping objects.

Definition at line 24 of file LinearSystem.hpp.

Member Function Documentation

void stk::linsys::LinearSystem::synchronize_mappings_and_structure ( )

This is a collective call -- will hang if only a subset of processors call it.

Internally calls fei::MatrixGraph::initComplete() and DofMapper::finalize().

Definition at line 32 of file LinearSystem.cpp.

void stk::linsys::LinearSystem::finalize_assembly ( )

This is a collective call -- will hang if only a subset of processors call it.

Internally calls fei::LinearSystem::loadComplete(), which in turn calls fei::Matrix::globalAssemble() and fei::Vector::gatherFromOverlap(). These operations perform communication to move shared contributions to owning processors, etc.

Definition at line 52 of file LinearSystem.cpp.

int stk::linsys::LinearSystem::solve	(	int &	status,
		const Teuchos::ParameterList &	params
	)

Solve the linear system.

Parameters:

status	Output flag indicating the termination condition of the underlying linear-solver. Values are solver-specific. In general, 0 indicates that the solver achieved a solution that satisfied the stopping test, within the iteration limit, etc. If an iterative solver fails to converge, this status value will generally be non-zero, but the actual value can vary by solver-library.
params	Teuchos::ParameterList for the solver

Returns:: error-code 0 if successful. Note that a 0 error-return does not necessarily mean that the underlying solver achieved a solution. It simply means that no fatal errors were encountered, such as allocation failures, etc.

Definition at line 94 of file LinearSystem.cpp.

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

Public Member Functions

Detailed Description

Member Function Documentation