NOX Development
Public Member Functions
LOCAInterface Class Reference
Inheritance diagram for LOCAInterface:
Inheritance graph
[legend]
Collaboration diagram for LOCAInterface:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LOCAInterface (Teuchos::RCP< ProblemLOCAPrototype > &aProblem, Teuchos::RCP< ContinuationManager > aContinuationManager)
bool computeF (const Epetra_Vector &x, Epetra_Vector &f, const NOX::Epetra::Interface::Required::FillType F)
 Compute the function, F, given the specified input vector x. Returns true if computation was successful.
bool computeJacobian (const Epetra_Vector &x, Epetra_Operator &Jac)
void setParameters (const LOCA::ParameterVector &params)
 Set parameters in the user's application.
void printSolution (const Epetra_Vector &x, const double conParam)
 Call user's own print routine for vector-parameter pair.
virtual bool computeShiftedMatrix (double alpha, double beta, const Epetra_Vector &x, Epetra_Operator &A)
 Call user routine for computing the shifted matrix $\alpha J + \beta M$ where $J$ is the Jacobian matrix and $M$ is the mass matrix.
virtual void setXdot (const Epetra_Vector &xdot, const double time)
 Routine used in XYZT to set x_dot and time in the interface.

Member Function Documentation

bool LOCAInterface::computeJacobian ( const Epetra_Vector x,
Epetra_Operator Jac 
) [virtual]

Compute Jacobian given the specified input vector x. Returns true if computation was successful.

Implements NOX::Epetra::Interface::Jacobian.

void LOCAInterface::setParameters ( const LOCA::ParameterVector p) [virtual]

Set parameters in the user's application.

Should be called prior to calling one of the compute functions.

Implements LOCA::Epetra::Interface::Required.

References LOCA::ParameterVector::getLabel(), LOCA::ParameterVector::getValue(), and LOCA::ParameterVector::length().

void LOCAInterface::setXdot ( const Epetra_Vector xdot,
const double  time 
) [virtual]

Routine used in XYZT to set x_dot and time in the interface.

The computeF() routine for XYZT problems needs to be a function of x_dot, but th NOX/LOCA computeF() does not take x_dot as an argument. This is used to set x_dot in the application interface so the subsequent call to computeF has the correct x_dot value. The timeStep argument is sent so the use can set the global time, for cases when computeF, computeJacobian, computeMassMatrix fills are functions of time (nonautonomous systems).

Reimplemented from LOCA::Epetra::Interface::TimeDependent.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends