NOX  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | List of all members
LOCA::SingularJacobianSolve::Generic Class Referenceabstract

Generic singular jacobian solve interface. More...

#include <LOCA_SingularJacobianSolve_Generic.H>

Inheritance diagram for LOCA::SingularJacobianSolve::Generic:
Inheritance graph
[legend]

Public Member Functions

 Generic ()
 Constructor. More...
 
 Generic (const Generic &source)
 Copy constructor.
 
virtual ~Generic ()
 Destructor.
 
virtual Generic * clone () const =0
 Clone function.
 
virtual Generic & operator= (const Generic &source)=0
 Assignment operator.
 
virtual
NOX::Abstract::Group::ReturnType 		reset (Teuchos::ParameterList &params)=0
 Reset parameters.
 
virtual
NOX::Abstract::Group::ReturnType 		compute (Teuchos::ParameterList &params, LOCA::Continuation::AbstractGroup &grp, const NOX::Abstract::Vector &input, const NOX::Abstract::Vector &approxNullVec, const NOX::Abstract::Vector &jacApproxNullVec, NOX::Abstract::Vector &result)=0
 Compute solution to singular system. More...
 
virtual
NOX::Abstract::Group::ReturnType 		computeMulti (Teuchos::ParameterList &params, LOCA::Continuation::AbstractGroup &grp, const NOX::Abstract::Vector *const *inputs, const NOX::Abstract::Vector &approxNullVec, const NOX::Abstract::Vector &jacApproxNullVec, NOX::Abstract::Vector **results, int nVecs)=0
 Compute solution to singular system with multiple RHS. More...
 

Detailed Description

Generic singular jacobian solve interface.

Generic interface for solving $Jx=b$ when $J$ is (nearly) singular. All classes the implement a method for computing solutions to nearly singular systems should be derived from this class.

Constructor & Destructor Documentation

LOCA::SingularJacobianSolve::Generic::Generic ( )
inline

Constructor.

Constructors of derived objects should look like reset.

Member Function Documentation

virtual NOX::Abstract::Group::ReturnType LOCA::SingularJacobianSolve::Generic::compute ( Teuchos::ParameterList &  params,
LOCA::Continuation::AbstractGroup &  grp,
const NOX::Abstract::Vector &  input,
const NOX::Abstract::Vector &  approxNullVec,
const NOX::Abstract::Vector &  jacApproxNullVec,
NOX::Abstract::Vector &  result 
)
pure virtual

Compute solution to singular system.

The passed parameters are assumed be the (nonsingular) linear solver parameters.

Implemented in LOCA::SingularJacobianSolve::NicDay, LOCA::SingularJacobianSolve::Nic, LOCA::SingularJacobianSolve::ItRef, LOCA::SingularJacobianSolve::Manager, and LOCA::SingularJacobianSolve::Default.

virtual NOX::Abstract::Group::ReturnType LOCA::SingularJacobianSolve::Generic::computeMulti ( Teuchos::ParameterList &  params,
LOCA::Continuation::AbstractGroup &  grp,
const NOX::Abstract::Vector *const *  inputs,
const NOX::Abstract::Vector &  approxNullVec,
const NOX::Abstract::Vector &  jacApproxNullVec,
NOX::Abstract::Vector **  results,
int  nVecs 
)
pure virtual

Compute solution to singular system with multiple RHS.

The passed parameters are assumed be the (nonsingular) linear solver parameters.

Implemented in LOCA::SingularJacobianSolve::NicDay, LOCA::SingularJacobianSolve::Nic, LOCA::SingularJacobianSolve::ItRef, LOCA::SingularJacobianSolve::Manager, and LOCA::SingularJacobianSolve::Default.

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