Inheritance diagram for LOCA::PhaseTransition::ExtendedGroup:

Collaboration diagram for LOCA::PhaseTransition::ExtendedGroup:

Public Member Functions
	ExtendedGroup (const Teuchos::RCP< LOCA::GlobalData > gD, const Teuchos::RCP< Teuchos::ParameterList > &bifurcationparams_, const Teuchos::RCP< LOCA::PhaseTransition::AbstractGroup > &grp_)
	Constructor.
	ExtendedGroup (const LOCA::PhaseTransition::ExtendedGroup &source, NOX::CopyType type=NOX::DeepCopy)
	Copy constructor.
	~ExtendedGroup ()
	Destructor.
NOX::Abstract::Group &	operator= (const NOX::Abstract::Group &source)
	Copies the source group into this group.
NOX::Abstract::Group &	operator= (const LOCA::PhaseTransition::ExtendedGroup &source)
	See above.
virtual Teuchos::RCP < NOX::Abstract::Group >	clone (NOX::CopyType type=NOX::DeepCopy) const
	Create a new Group of the same derived type as this one by cloning this one, and return a ref count pointer to the new group.
void	print () const
	Print out the group.
virtual Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup >	getUnderlyingGroup () const
	Return underlying group.
virtual Teuchos::RCP < LOCA::MultiContinuation::AbstractGroup >	getUnderlyingGroup ()
	Return underlying group.
virtual void	setParamsMulti (const std::vector< int > &paramIDs, const NOX::Abstract::MultiVector::DenseMatrix &vals)
	Set parameters indexed by (integer) paramIDs.
virtual NOX::Abstract::Group::ReturnType	computeDfDpMulti (const std::vector< int > &paramIDs, NOX::Abstract::MultiVector &dfdp, bool isValid_F)
"Compute" functions.
void	setX (const NOX::Abstract::Vector &y)
	Set the solution vector x to y.
void	setX (const LOCA::PhaseTransition::ExtendedVector &y)
	See above.
void	computeX (const NOX::Abstract::Group &grp, const NOX::Abstract::Vector &d, double step)
	Compute x = grp.x + step * d.
void	computeX (const LOCA::PhaseTransition::ExtendedGroup &grp, const LOCA::PhaseTransition::ExtendedVector &d, double step)
	See above.
NOX::Abstract::Group::ReturnType	computeF ()
	Compute and store F(x).
NOX::Abstract::Group::ReturnType	computeJacobian ()
	Compute and store Jacobian.
NOX::Abstract::Group::ReturnType	computeNewton (Teuchos::ParameterList &params)
	Compute the Newton direction, using parameters for the linear solve.
Jacobian operations.
Operations using the Jacobian matrix. These may not be defined in matrix-free scenarios.
NOX::Abstract::Group::ReturnType	applyJacobian (const LOCA::PhaseTransition::ExtendedVector &input, LOCA::PhaseTransition::ExtendedVector &result) const
NOX::Abstract::Group::ReturnType	applyJacobian (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	See above.
NOX::Abstract::Group::ReturnType	applyJacobianInverse (Teuchos::ParameterList &params, const LOCA::PhaseTransition::ExtendedVector &input, LOCA::PhaseTransition::ExtendedVector &result) const
NOX::Abstract::Group::ReturnType	applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.
"Is" functions
Checks to see if various objects have been computed. Returns true if the corresponding "compute" function has been called since the last update to the solution vector (via instantiation or computeX).
bool	isF () const
	Return true if F is valid.
bool	isJacobian () const
	Return true if the Jacobian is valid.
bool	isNewton () const
	Return true if the Newton direction is valid.
"Get" functions
Note that these function do not check whether or not the vectors are valid. Must use the "Is" functions for that purpose.
const NOX::Abstract::Vector &	getX () const
	Return solution vector.
const NOX::Abstract::Vector &	getF () const
	Return F(x)
double	getNormF () const
	Return 2-norm of F(x).
const NOX::Abstract::Vector &	getNewton () const
	Return Newton direction.
const NOX::Abstract::Vector &	getGradient () const
	Return gradient.
Teuchos::RCP< const NOX::Abstract::Vector >	getXPtr () const
	Return RCP to solution vector.
Teuchos::RCP< const NOX::Abstract::Vector >	getFPtr () const
	Return RCP to F(x)
Teuchos::RCP< const NOX::Abstract::Vector >	getNewtonPtr () const
	Return RCP to Newton direction.
Teuchos::RCP< const NOX::Abstract::Vector >	getGradientPtr () const
	Return RCP to gradient.

void	copy (const NOX::Abstract::Group &source)
	Start methods for LOCA::Abstract::Group.
void	setParams (const LOCA::ParameterVector &p)
	Set the parameter vector in the group to p (pVector = p).
void	setParam (int paramID, double val)
	Set parameter indexed by (integer) paramID.
void	setParam (std::string paramID, double val)
	Set parameter indexed by (std::string) paramID.
const LOCA::ParameterVector &	getParams () const
	Return a const reference to the ParameterVector owned by the group.
double	getParam (int paramID) const
	Return copy of parameter indexed by (integer) paramID.
double	getParam (std::string paramID) const
	Return copy of parameter indexed by (std::string) paramID.
void	printSolution (const NOX::Abstract::Vector &solution, const double param) const
	Set parameter indexed by (std::string) paramID.
void	printSolution (const double param) const
	Function to print out solution and parameter after successful step.
Protected Member Functions
void	resetIsValid ()
	resets the isValid flags to false
Protected Attributes
Teuchos::RCP < LOCA::PhaseTransition::AbstractGroup >	grp
	Solution vector.
double	normF
const Teuchos::RCP < LOCA::GlobalData >	globalData
int	bifParamID
Vectors
Teuchos::RCP < LOCA::PhaseTransition::ExtendedVector >	xVector
	Solution vector.
Teuchos::RCP < LOCA::PhaseTransition::ExtendedVector >	fVector
	Right-hand-side vector (function evaluation).
Teuchos::RCP < LOCA::PhaseTransition::ExtendedVector >	newtonVector
	Newton direction vector.
IsValid flags
True if the current solution is up-to-date with respect to the currect xVector.
bool	isValidF
bool	isValidJacobian
bool	isValidNewton

Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::PhaseTransition::ExtendedGroup::applyJacobianInverse	(	Teuchos::ParameterList &	params,
		const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result
	)		const `[virtual]`

Applies the inverse of the Jacobian matrix to the given input vector and puts the answer in result.

Computes

$v = J^{-1} u,$

where $J$ is the Jacobian, $u$ is the input vector, and $v$ is the result vector.

The "Tolerance" parameter specifies that the solution should be such that

$\frac{\| J v - u \|_2}{\max \{ 1, \|u\|_2\} } < \mbox{Tolerance}$

Returns:

NOX::Abstract::Group::NotDefined - Returned by default implementation in NOX::Abstract::Group
NOX::Abstract::Group::BadDependency - If has not been computed
NOX::Abstract::Group::NotConverged - If the linear solve fails to satisfy the "Tolerance" specified in params
NOX::Abstract::Group::Failed - If the computation fails
NOX::Abstract::Group::Ok - Otherwise

The parameter "Tolerance" may be added/modified in the list of parameters - this is the ideal solution tolerance for an iterative linear solve.

Reimplemented from NOX::Abstract::Group.

Teuchos::RCP< NOX::Abstract::Group > LOCA::PhaseTransition::ExtendedGroup::clone ( NOX::CopyType type = NOX::DeepCopy ) const [virtual]

Create a new Group of the same derived type as this one by cloning this one, and return a ref count pointer to the new group.

If type is NOX::DeepCopy, then we need to create an exact replica of "this". Otherwise, if type is NOX::ShapeCopy, we need only replicate the shape of "this" (only the memory is allocated, the values are not copied into the vectors and Jacobian). Returns NULL if clone is not supported.

Note:: Any shared data should have its ownership transfered to this group from the source for a NOX::DeepCopy.

Implements NOX::Abstract::Group.

References Teuchos::rcp().

NOX::Abstract::Group::ReturnType LOCA::PhaseTransition::ExtendedGroup::computeDfDpMulti	(	const std::vector< int > &	paramIDs,
		NOX::Abstract::MultiVector &	dfdp,
		bool	isValidF
	)		`[virtual]`

Compute $\partial F/\partial p$ for each parameter $p$ indexed by paramIDs. The first column of dfdp holds F, which is valid if isValidF is true. Otherwise F must be computed.

Implements LOCA::MultiContinuation::AbstractGroup.

References NOX::Abstract::Group::BadDependency.

NOX::Abstract::Group::ReturnType LOCA::PhaseTransition::ExtendedGroup::computeF ( ) [virtual]

Compute and store F(x).

Note:: It's generally useful to also compute and store the 2-norm of F(x) at this point for later access by the getNormF() function.

Returns:

NOX::Abstract::Group::Failed - If the computation fails in any way
NOX::Abstract::Group::Ok - Otherwise

Implements NOX::Abstract::Group.

References NOX::Abstract::Group::Ok.

NOX::Abstract::Group::ReturnType LOCA::PhaseTransition::ExtendedGroup::computeJacobian ( ) [virtual]

Compute and store Jacobian.

Recall that

$F(x) = \left[ \begin{array}{c} F_1(x) \\ F_2(x) \\ \vdots \\ F_n(x) \\ \end{array} \right].$

The Jacobian is denoted by $J$ and defined by

$J_{ij} = \frac{\partial F_i}{\partial x_j} (x).$

Note:: If this is a shared object, this group should taken ownership of the Jacobian before it computes it.

Returns:

NOX::Abstract::Group::NotDefined - Returned by default implementation in NOX::Abstract::Group
NOX::Abstract::Group::Failed - If the computation fails in any other way
NOX::Abstract::Group::Ok - Otherwise

Reimplemented from NOX::Abstract::Group.

References NOX::Abstract::Group::Ok.

NOX::Abstract::Group::ReturnType LOCA::PhaseTransition::ExtendedGroup::computeNewton ( Teuchos::ParameterList & params ) [virtual]

Compute the Newton direction, using parameters for the linear solve.

The Newton direction is the solution, s, of

$J s = -F.$

The parameters are from the "Linear %Solver" sublist of the "Direction" sublist that is passed to solver during construction.

The "Tolerance" parameter may be added/modified in the sublist of "Linear Solver" parameters that is passed into this function. The solution should be such that

$\frac{\| J s - (-F) \|_2}{\max \{ 1, \|F\|_2\} } < \mbox{Tolerance}$

Returns:

NOX::Abstract::Group::NotDefined - Returned by default implementation in NOX::Abstract::Group
NOX::Abstract::Group::BadDependency - If either or has not been computed
NOX::Abstract::Group::NotConverged - If the linear solve fails to satisfy the "Tolerance" specified in params
NOX::Abstract::Group::Failed - If the computation fails in any other way
NOX::Abstract::Group::Ok - Otherwise

Reimplemented from NOX::Abstract::Group.

References NOX::Abstract::Group::Ok.

void LOCA::PhaseTransition::ExtendedGroup::computeX	(	const NOX::Abstract::Group &	grp,
		const NOX::Abstract::Vector &	d,
		double	step
	)		`[virtual]`

Compute x = grp.x + step * d.

Let $x$ denote this group's solution vector. Let $\hat x$ denote the result of grp.getX(). Then set

$x = \hat x + \mbox{step} \; d.$

Note:: This should invalidate the function value, Jacobian, gradient, and Newton direction.; Throw an error if the copy fails.

Returns:: Reference to this object

Implements NOX::Abstract::Group.

double LOCA::PhaseTransition::ExtendedGroup::getNormF ( ) const [virtual]

Return 2-norm of F(x).

In other words,

$\sqrt{\sum_{i=1}^n F_i^2}$

Implements NOX::Abstract::Group.

bool LOCA::PhaseTransition::ExtendedGroup::isJacobian ( ) const [virtual]

Return true if the Jacobian is valid.

Note:: Default implementation in NOX::Abstract::Group returns false.

Reimplemented from NOX::Abstract::Group.

bool LOCA::PhaseTransition::ExtendedGroup::isNewton ( ) const [virtual]

Return true if the Newton direction is valid.

Note:: Default implementation in NOX::Abstract::Group returns false.

Reimplemented from NOX::Abstract::Group.

NOX::Abstract::Group & LOCA::PhaseTransition::ExtendedGroup::operator= ( const NOX::Abstract::Group & source ) [virtual]

Copies the source group into this group.

Note:: Any shared data owned by the source should have its ownership transfered to this group. This may result in a secret modification to the source object.

Implements NOX::Abstract::Group.

void LOCA::PhaseTransition::ExtendedGroup::printSolution ( const double conParam ) const [virtual]

Function to print out solution and parameter after successful step.

Empty default definition.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

void LOCA::PhaseTransition::ExtendedGroup::setX ( const NOX::Abstract::Vector & y ) [virtual]

Set the solution vector x to y.

Note:: This should invalidate the function value, Jacobian, gradient, and Newton direction.; Throw an error if the copy fails.

Returns:: Reference to this object

Implements NOX::Abstract::Group.

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

LOCA_PhaseTransition_ExtendedGroup.H
LOCA_PhaseTransition_ExtendedGroup.C

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation