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

Virtual interface for LOCA::LAPACK::Group to provide a link to the external code for RHS and Jacobian fills. More...

#include <LOCA_LAPACK_Interface.H>

Inheritance diagram for LOCA::LAPACK::Interface:
Inheritance graph
[legend]
Collaboration diagram for LOCA::LAPACK::Interface:
Collaboration graph
[legend]

Public Member Functions

 Interface ()
 Constructor.
 
virtual ~Interface ()
 Destructor.
 
virtual void setParams (const ParameterVector &p)=0
 Set the problem parameters.
 
virtual void printSolution (const NOX::LAPACK::Vector &, const double)
 Call user's own print routine for vector-parameter pair.
 
virtual bool computeShiftedMatrix (double alpha, double beta, const NOX::LAPACK::Vector &x, NOX::LAPACK::Matrix< double > &A)
 Compute shifted matrix alpha*J + beta*M where J is the Jacobian matrix and M is the mass matrix. Returns true if computation was successful. More...
 
virtual void projectToDraw (const NOX::LAPACK::Vector &x, double *px) const
 Projects solution to a few scalars for multiparameter continuation. More...
 
virtual int projectToDrawDimension () const
 Returns the dimension of the project to draw array.
 
- Public Member Functions inherited from NOX::LAPACK::Interface
 Interface ()
 Constructor.
 
virtual const NOX::LAPACK::VectorgetInitialGuess ()=0
 Get initial guess.
 
virtual bool computeF (NOX::LAPACK::Vector &rhs, const NOX::LAPACK::Vector &x)=0
 Compute RHS given the specified input vector x. Returns true if computation was successful.
 
virtual bool computeJacobian (NOX::LAPACK::Matrix< double > &J, const NOX::LAPACK::Vector &x)=0
 Compute Jacobian given the specified input vector x. Returns true if computation was successful.
 

Detailed Description

Virtual interface for LOCA::LAPACK::Group to provide a link to the external code for RHS and Jacobian fills.

This interface is derived from the NOX::LAPACK::Interface and and additionally provides a method for setting problem parameters.

Member Function Documentation

virtual bool LOCA::LAPACK::Interface::computeShiftedMatrix ( double  alpha,
double  beta,
const NOX::LAPACK::Vector x,
NOX::LAPACK::Matrix< double > &  A 
)
inlinevirtual

Compute shifted matrix alpha*J + beta*M where J is the Jacobian matrix and M is the mass matrix. Returns true if computation was successful.

The default implementation assumes the mass matrix is the identity matrix.

References NOX::LAPACK::Interface::computeJacobian(), NOX::LAPACK::Matrix< T >::numCols(), NOX::LAPACK::Matrix< T >::numRows(), and NOX::LAPACK::Matrix< T >::scale().

virtual void LOCA::LAPACK::Interface::projectToDraw ( const NOX::LAPACK::Vector x,
double *  px 
) const
inlinevirtual

Projects solution to a few scalars for multiparameter continuation.

Default implementation is the max norm

References NOX::Abstract::Vector::MaxNorm, and NOX::LAPACK::Vector::norm().


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