A group representing the minimally augemented Hopf equations. More...

#include <LOCA_Hopf_MinimallyAugmented_ExtendedGroup.H>

Inheritance diagram for LOCA::Hopf::MinimallyAugmented::ExtendedGroup:

Collaboration diagram for LOCA::Hopf::MinimallyAugmented::ExtendedGroup:

Public Member Functions
	ExtendedGroup (const Teuchos::RCP< LOCA::GlobalData > &global_data, const Teuchos::RCP< LOCA::Parameter::SublistParser > &topParams, const Teuchos::RCP< Teuchos::ParameterList > &hpfParams, const Teuchos::RCP< LOCA::Hopf::MinimallyAugmented::AbstractGroup > &grp)
	Constructor.
	ExtendedGroup (const ExtendedGroup &source, NOX::CopyType type=NOX::DeepCopy)
	Copy constructor.
virtual	~ExtendedGroup ()
	Destructor.
double	getBifParam () const
	Get bifurcation parameter.
Implementation of NOX::Abstract::Group virtual methods
virtual NOX::Abstract::Group &	operator= (const NOX::Abstract::Group &source)
	Assignment operator.
virtual Teuchos::RCP< NOX::Abstract::Group >	clone (NOX::CopyType type=NOX::DeepCopy) const
	Clone function.
virtual void	setX (const NOX::Abstract::Vector &y)
	Set the solution vector to y.
virtual void	computeX (const NOX::Abstract::Group &g, const NOX::Abstract::Vector &d, double step)
	Compute and return solution vector, x, where this.x = grp.x + step * d.
virtual NOX::Abstract::Group::ReturnType	computeF ()
	Compute extended continuation equations.
virtual NOX::Abstract::Group::ReturnType	computeJacobian ()
	Compute extended continuation jacobian.
virtual NOX::Abstract::Group::ReturnType	computeGradient ()
	Gradient is not defined for this system.
virtual NOX::Abstract::Group::ReturnType	computeNewton (Teuchos::ParameterList &params)
	Compute Newton direction for extended continuation system.
virtual NOX::Abstract::Group::ReturnType	applyJacobian (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	Applies Jacobian for extended system.
virtual NOX::Abstract::Group::ReturnType	applyJacobianTranspose (const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	Jacobian transpose not defined for this system.
virtual NOX::Abstract::Group::ReturnType	applyJacobianInverse (Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	Applies Jacobian inverse for extended system.
virtual NOX::Abstract::Group::ReturnType	applyJacobianMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
	Applies Jacobian for extended system.
virtual NOX::Abstract::Group::ReturnType	applyJacobianTransposeMultiVector (const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
	Jacobian transpose not defined for this system.
virtual NOX::Abstract::Group::ReturnType	applyJacobianInverseMultiVector (Teuchos::ParameterList &params, const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
	Applies Jacobian inverse for extended system.
virtual bool	isF () const
	Return `true` if extended residual is valid.
virtual bool	isJacobian () const
	Return `true` if the extended Jacobian is valid.
virtual bool	isGradient () const
	Always returns false.
virtual bool	isNewton () const
	Return `true` if the extended Newton direction is valid.
virtual const NOX::Abstract::Vector &	getX () const
	Return extended solution vector.
virtual const NOX::Abstract::Vector &	getF () const
	Return extended residual.
virtual double	getNormF () const
	Return 2-norm of extended residual.
virtual const NOX::Abstract::Vector &	getGradient () const
	Gradient is never valid.
virtual const NOX::Abstract::Vector &	getNewton () const
	Return extended Newton direction.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getXPtr () const
	Return RCP to extended solution vector.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getFPtr () const
	Return RCP to extended residual.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getGradientPtr () const
	Gradient is never valid.
virtual Teuchos::RCP< const NOX::Abstract::Vector >	getNewtonPtr () const
	Return RCP to extended Newton direction.
virtual double	getNormNewtonSolveResidual () const
	Returns 2-norm of extended Newton solve residual.
Implementation of LOCA::Extended::MultiAbstractGroup
virtual methods
virtual Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup >	getUnderlyingGroup () const
	Return underlying group.
virtual Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup >	getUnderlyingGroup ()
	Return underlying group.
Implementation of LOCA::MultiContinuation::AbstractGroup
virtual methods
virtual void	copy (const NOX::Abstract::Group &source)
	Assignment operator.
virtual void	setParamsMulti (const std::vector< int > &paramIDs, const NOX::Abstract::MultiVector::DenseMatrix &vals)
	Set parameters indexed by (integer) paramIDs.
virtual void	setParams (const ParameterVector &p)
	Set the parameter vector in the group to p (pVector = p).
virtual void	setParam (int paramID, double val)
	Set parameter indexed by (integer) paramID.
virtual void	setParam (std::string paramID, double val)
	Set parameter indexed by (std::string) paramID.
virtual const ParameterVector &	getParams () const
	Return a const reference to the ParameterVector owned by the group.
virtual double	getParam (int paramID) const
	Return copy of parameter indexed by (integer) paramID.
virtual double	getParam (std::string paramID) const
	Return copy of parameter indexed by (std::string) paramID.
virtual NOX::Abstract::Group::ReturnType	computeDfDpMulti (const std::vector< int > &paramIDs, NOX::Abstract::MultiVector &dfdp, bool isValidF)
virtual void	preProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Perform any preprocessing before a continuation step starts.
virtual void	postProcessContinuationStep (LOCA::Abstract::Iterator::StepStatus stepStatus)
	Perform any postprocessing after a continuation step finishes.
virtual void	projectToDraw (const NOX::Abstract::Vector &x, double *px) const
	Projects solution to a few scalars for multiparameter continuation.
virtual int	projectToDrawDimension () const
	Returns the dimension of the project to draw array.
virtual double	computeScaledDotProduct (const NOX::Abstract::Vector &a, const NOX::Abstract::Vector &b) const
	Compute a scaled dot product.
virtual void	printSolution (const double conParam) const
	Function to print out solution and parameter after successful step.
virtual void	printSolution (const NOX::Abstract::Vector &x, const double conParam) const
	Function to print out a vector and parameter after successful step.
virtual void	scaleVector (NOX::Abstract::Vector &x) const
	Scales a vector using scaling vector.
Public Member Functions inherited from LOCA::Extended::MultiAbstractGroup
	MultiAbstractGroup ()
	Default constructor.
virtual	~MultiAbstractGroup ()
	Destructor.
virtual Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup >	getBaseLevelUnderlyingGroup () const
	Return base-level underlying group.
virtual Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup >	getBaseLevelUnderlyingGroup ()
	Return base-level underlying group.
virtual NOX::Abstract::Group &	operator= (const NOX::Abstract::Group &source)=0
	Bring NOX::Abstract::Group::operator=() into scope.
Public Member Functions inherited from NOX::Abstract::Group
	Group ()
	Constructor.
virtual	~Group ()
	Destructor.
virtual NOX::Abstract::Group::ReturnType	applyRightPreconditioning (bool useTranspose, Teuchos::ParameterList &params, const NOX::Abstract::Vector &input, NOX::Abstract::Vector &result) const
	Apply right preconditiong to the given input vector.
virtual NOX::Abstract::Group::ReturnType	applyRightPreconditioningMultiVector (bool useTranspose, Teuchos::ParameterList &params, const NOX::Abstract::MultiVector &input, NOX::Abstract::MultiVector &result) const
	applyRightPreconditioning for multiple right-hand sides
virtual const NOX::Abstract::Vector &	getScaledX () const
virtual void	logLastLinearSolveStats (NOX::SolverStats &stats) const
	Adds statistics from last linear solve to the SovlerStats object.
virtual NOX::Abstract::Group::ReturnType	getNormLastLinearSolveResidual (double &residual) const
	Return the norm of the last linear solve residual as the result of either a call to computeNewton() or applyJacobianInverse().
Public Member Functions inherited from LOCA::MultiContinuation::AbstractGroup
	AbstractGroup ()
	Default constructor.
virtual	~AbstractGroup ()
	Destructor.
Public Member Functions inherited from LOCA::BorderedSystem::AbstractGroup
	AbstractGroup ()
	Constructor.
virtual	~AbstractGroup ()
	Destructor.

Implementation of
LOCA::BorderedSystem::AbstractGroup virtual methods
Teuchos::RCP< LOCA::GlobalData >	globalData
	Pointer LOCA global data object.
Teuchos::RCP< LOCA::Parameter::SublistParser >	parsedParams
	Parsed top-level parameters.
Teuchos::RCP< Teuchos::ParameterList >	hopfParams
	Hopf parameter list.
Teuchos::RCP< LOCA::Hopf::MinimallyAugmented::AbstractGroup >	grpPtr
	Pointer to base group that defines .
Teuchos::RCP< LOCA::BorderedSystem::AbstractGroup >	bordered_grp
	Pointer to base group as a bordered group.
Teuchos::RCP< LOCA::Hopf::MinimallyAugmented::Constraint >	constraintsPtr
	Pointer to constraint object.
LOCA::MultiContinuation::ExtendedMultiVector	xMultiVec
	Stores the extended solution vector.
LOCA::MultiContinuation::ExtendedMultiVector	fMultiVec
	Stores the extended residual vector and df/dp.
LOCA::MultiContinuation::ExtendedMultiVector	newtonMultiVec
	Stores the extended Newton vector.
LOCA::MultiContinuation::ExtendedMultiVector	gradientMultiVec
	Stores the extended gradient vector.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVector >	xVec
	Stores view of first column of xMultiVec.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVector >	fVec
	Stores view of first column of fMultiVec.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedMultiVector >	ffMultiVec
	Stores view of first column of fMultiVec as a multivec.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedMultiVector >	dfdpMultiVec
	Stores view of df/dp columns of fMultiVec.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedMultiVector >	fBifMultiVec
	Stores view of f and first column of df/dp.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVector >	newtonVec
	Stores view of first column of newtonMultiVec.
Teuchos::RCP< LOCA::MultiContinuation::ExtendedVector >	gradientVec
	Stores view of first column of gradientMultiVec.
Teuchos::RCP< LOCA::BorderedSolver::JacobianOperator >	jacOp
Teuchos::RCP< LOCA::BorderedSolver::AbstractStrategy >	borderedSolver
	Stores bordered solver strategy.
std::vector< int >	index_f
	Stores indices for getting f part of fMultiVec.
std::vector< int >	index_dfdp
	Stores indices for getting df/dp part of fMultiVec.
int	bifParamID
	Stores the bifurcation parameter index.
bool	isValidF
	Is residual vector valid.
bool	isValidJacobian
	Is Jacobian matrix valid.
bool	isValidNewton
	Is Newton vector valid.
bool	isValidGradient
	Is Gradient vector valid.
bool	isBordered
	Flag that indicates whether underlying group is a bordered group.
virtual int	getBorderedWidth () const
	Return the total width of the bordered rows/columns.
virtual Teuchos::RCP< const NOX::Abstract::Group >	getUnborderedGroup () const
	Get bottom-level unbordered group.
virtual bool	isCombinedAZero () const
	Indicates whether combined A block is zero.
virtual bool	isCombinedBZero () const
	Indicates whether combined B block is zero.
virtual bool	isCombinedCZero () const
	Indicates whether combined C block is zero.
virtual void	extractSolutionComponent (const NOX::Abstract::MultiVector &v, NOX::Abstract::MultiVector &v_x) const
virtual void	extractParameterComponent (bool use_transpose, const NOX::Abstract::MultiVector &v, NOX::Abstract::MultiVector::DenseMatrix &v_p) const
virtual void	loadNestedComponents (const NOX::Abstract::MultiVector &v_x, const NOX::Abstract::MultiVector::DenseMatrix &v_p, NOX::Abstract::MultiVector &v) const
virtual void	fillA (NOX::Abstract::MultiVector &A) const
	Fill the combined A block as described above.
virtual void	fillB (NOX::Abstract::MultiVector &B) const
	Fill the combined B block as described above.
virtual void	fillC (NOX::Abstract::MultiVector::DenseMatrix &C) const
	Fill the combined C block as described above.
virtual void	resetIsValid ()
	Resets all isValid flags to false.
virtual void	setupViews ()
	Sets up multivector views.
void	setBifParam (double param)
	Set bifurcation parameter.
void	getInitialVectors (Teuchos::RCP< NOX::Abstract::Vector > &aVecPtr_real, Teuchos::RCP< NOX::Abstract::Vector > &aVecPtr_imag, Teuchos::RCP< NOX::Abstract::Vector > &bVecPtr_real, Teuchos::RCP< NOX::Abstract::Vector > &bVecPtr_imag, bool isSymmetric)
	Computes initial "a" and "b" vectors.

Additional Inherited Members
Public Types inherited from NOX::Abstract::Group
enum	ReturnType { Ok , NotDefined , BadDependency , NotConverged , Failed }
	The computation of, say, the Newton direction in computeNewton() may fail in many different ways, so we have included a variety of return codes to describe the failures. Of course, we also have a code for success. More...

Detailed Description

A group representing the minimally augemented Hopf equations.

The LOCA::Hopf::MinimallyAugmented::ExtendedGroup is a concrete implementation of the NOX::Abstract::Group, LOCA::MultiContinuation::AbstractGroup and LOCA::Extended::MultiAbstractGroup that defines the following extended set of equations that are regular at a generic Hopf:

$\‍[ G(z) = \left[ \begin{array}{c} F(x,p)\\ \sigma \end{array} \right] = 0 \‍]$

where $z = [x, p, \omega]\in\Re^{n+2}$ , $ x$ is the solution vector, $ p$ is the bifurcation parameter, $\omega$ is the Hopf frequency and $\sigma\in\Re$ is a measure of the singularity of $J+i\omega M$ and is defined via

$\‍[ \begin{bmatrix} J+i\omega M & a \\ b^H & 0 \end{bmatrix} \begin{bmatrix} v \\ \sigma_1 \end{bmatrix} = \begin{bmatrix} 0 \\ n \end{bmatrix}, \‍]$

$\‍[ \begin{bmatrix} J^T-i\omega M^T & b \\ a^H & 0 \end{bmatrix} \begin{bmatrix} w \\ \sigma_2 \end{bmatrix} = \begin{bmatrix} 0 \\ n \end{bmatrix}, \‍]$

$\‍[ \sigma = w^H J+i\omega M v/n \‍]$

for any vectors $ a$ and $ b$ in $\mathbb{C}^n$ . Using these relationships, it is easy to show

$\‍[ \begin{split} \sigma_x &= (w^H(J+i\omega M)v)_x/n = w^H(J+i\omega M)_x v/n \\ \sigma_p &= (w^H(J+i\omega M)v)_p/n = w^H(J+i\omega M)_p v/n \end{split} \‍]$

The group stores an underlying group of type LOCA::Hopf::MinimallyAugmented::AbstractGroup to represent the equations $ F(x,p) = 0$ and to manipulate the underlying complex matrix $C = J+i\omega M$ . This interface defines methods for computing the derivatives $(w^H C v)_x$ and $(w^H C v)_p$ . Since LOCA is not able to deal with complex vectors and matrices directly, the real-equivalent formulation is used for all complex calculations.

This class implements all of the NOX::Abstract::Group, LOCA::MultiContinuation::AbstractGroup, and LOCA::Extended::MultiAbstractGroup methods for this extended set of equations and therefore is a complete group which can be passed to most NOX solvers to locate a single pitchfork or to the LOCA::Stepper to compute a family of pitchforks in a second parameter.

The class is intialized via the hpfParams parameter list argument to the constructor. The parameters this class recognizes are:

"Bifurcation Parameter" – [string] (Must be supplied) - Name of the bifurcation parameter
"Initial Frequency" – [double] (Must be supplied) Initial guess for the Hopf frequency $\omega$ .
"Bordered Solver Method" – [string] (default "Bordering") Method for solving bordered systems of equations. See LOCA::BorderedSolver::Factory for a description.
"Symmetric Jacobian" – [bool] (default: false) - Flag indicating whether Jacobian matrix is symmetric, in which case we force and therefore the second tranpose solve for is unnecessary
"Initial Null Vector Compuation" – [string] (default: "User Provided") - Method to compute initial and vectors. Valid choices are:
- "User Provided" - Initial vectors are provided in the parameter list, in which case the following parameters are relevant:
  - "Initial Real A Vector" – [Teuchos::RCP<NOX::Abstract::Vector>] (Must be supplied) - Vector storing initial value for the real component of the vector
  - "Initial Imaginary A Vector" – [Teuchos::RCP<NOX::Abstract::Vector>] (Must be supplied) - Vector storing initial value for the imaginary component of the vector
  - "Initial Real B Vector" – [Teuchos::RCP<NOX::Abstract::Vector>] (Must be supplied for nonsymmetric Jacobians) - Vector storing initial value for the real component of the vector
  - "Initial Imaginary B Vector" – [Teuchos::RCP<NOX::Abstract::Vector>] (Must be supplied) - Vector storing initial value for the imaginary component of the vector
- "Solve df/dp" - Compute $a = J^{-T}df/dp$ and $b = J^{-1} df/dp$ where is the bifurcation parameter.
"Update Null Vectors Every Continuation Step" – [bool] (default: true) - Flag indicating whether to update and vectors via and every continuation step
"Update Null Vectors Every Nonlinear Iteration" – [bool] (default: false) - Flag indicating whether to update and vectors via and every nonlinear iteration

Constructor & Destructor Documentation

◆ ExtendedGroup() [1/2]

LOCA::Hopf::MinimallyAugmented::ExtendedGroup::ExtendedGroup	(	const Teuchos::RCP< LOCA::GlobalData > &	global_data,
		const Teuchos::RCP< LOCA::Parameter::SublistParser > &	topParams,
		const Teuchos::RCP< Teuchos::ParameterList > &	hpfParams,
		const Teuchos::RCP< LOCA::Hopf::MinimallyAugmented::AbstractGroup > &	grp )

Constructor.

Parameters

global_data	[in] Global data object
topParams	[in] Parsed top-level parameter list.
hpfParams	[in] Parameter list determining the bordered solver method.
grp	[in] Group representing .

References bifParamID, bordered_grp, borderedSolver, constraintsPtr, dfdpMultiVec, fBifMultiVec, ffMultiVec, fMultiVec, fVec, LOCA::ParameterVector::getIndex(), getInitialVectors(), getX(), globalData, gradientMultiVec, gradientVec, grpPtr, hopfParams, index_dfdp, index_f, isBordered, isValidF, isValidGradient, isValidJacobian, isValidNewton, newtonMultiVec, newtonVec, parsedParams, setupViews(), xMultiVec, and xVec.

Referenced by clone().

◆ ExtendedGroup() [2/2]

LOCA::Hopf::MinimallyAugmented::ExtendedGroup::ExtendedGroup	(	const ExtendedGroup &	source,
		NOX::CopyType	type = NOX::DeepCopy )

Copy constructor.

References LOCA::BorderedSystem::AbstractGroup::AbstractGroup(), bifParamID, bordered_grp, borderedSolver, clone(), constraintsPtr, dfdpMultiVec, fBifMultiVec, ffMultiVec, fMultiVec, fVec, globalData, gradientMultiVec, gradientVec, grpPtr, hopfParams, index_dfdp, index_f, isBordered, isValidF, isValidGradient, isValidJacobian, isValidNewton, newtonMultiVec, newtonVec, parsedParams, setupViews(), NOX::ShapeCopy, xMultiVec, and xVec.

Member Function Documentation

◆ applyJacobian()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobian	(	const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result ) const

virtual

Applies Jacobian for extended system.

Reimplemented from NOX::Abstract::Group.

References applyJacobianMultiVector(), NOX::Abstract::Vector::createMultiVector(), and NOX::DeepCopy.

Referenced by getNormNewtonSolveResidual().

◆ applyJacobianInverse()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobianInverse	(	Teuchos::ParameterList &	params,
		const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result ) const

virtual

Applies Jacobian inverse for extended system.

Reimplemented from NOX::Abstract::Group.

References applyJacobianInverseMultiVector(), NOX::Abstract::Vector::createMultiVector(), and NOX::DeepCopy.

◆ applyJacobianInverseMultiVector()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobianInverseMultiVector	(	Teuchos::ParameterList &	params,
		const NOX::Abstract::MultiVector &	input,
		NOX::Abstract::MultiVector &	result ) const

virtual

Applies Jacobian inverse for extended system.

Reimplemented from NOX::Abstract::Group.

References borderedSolver, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), globalData, and isJacobian().

Referenced by applyJacobianInverse(), and computeNewton().

◆ applyJacobianMultiVector()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobianMultiVector	(	const NOX::Abstract::MultiVector &	input,
		NOX::Abstract::MultiVector &	result ) const

virtual

Applies Jacobian for extended system.

Reimplemented from NOX::Abstract::Group.

References borderedSolver, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), globalData, and isJacobian().

Referenced by applyJacobian().

◆ applyJacobianTranspose()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobianTranspose	(	const NOX::Abstract::Vector &	input,
		NOX::Abstract::Vector &	result ) const

virtual

Jacobian transpose not defined for this system.

Reimplemented from NOX::Abstract::Group.

References applyJacobianTransposeMultiVector(), NOX::Abstract::Vector::createMultiVector(), and NOX::DeepCopy.

Referenced by computeGradient().

◆ applyJacobianTransposeMultiVector()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::applyJacobianTransposeMultiVector	(	const NOX::Abstract::MultiVector &	input,
		NOX::Abstract::MultiVector &	result ) const

virtual

Jacobian transpose not defined for this system.

Reimplemented from NOX::Abstract::Group.

References borderedSolver, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), globalData, and isJacobian().

Referenced by applyJacobianTranspose().

◆ clone()

Teuchos::RCP< NOX::Abstract::Group > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::clone ( NOX::CopyType type = NOX::DeepCopy ) const

virtual

Clone function.

Implements NOX::Abstract::Group.

References ExtendedGroup().

Referenced by ExtendedGroup().

◆ computeDfDpMulti()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::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 constraintsPtr, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), globalData, grpPtr, and NOX::Abstract::Group::Ok.

◆ computeF()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeF ( )

virtual

Compute extended continuation equations.

Implements NOX::Abstract::Group.

References constraintsPtr, fVec, globalData, grpPtr, isValidF, and NOX::Abstract::Group::Ok.

Referenced by computeGradient(), and computeNewton().

◆ computeGradient()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeGradient ( )

virtual

Gradient is not defined for this system.

Reimplemented from NOX::Abstract::Group.

References applyJacobianTranspose(), computeF(), computeJacobian(), fVec, globalData, gradientVec, isF(), isJacobian(), isValidGradient, and NOX::Abstract::Group::Ok.

◆ computeJacobian()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeJacobian ( )

virtual

Compute extended continuation jacobian.

Reimplemented from NOX::Abstract::Group.

References bifParamID, borderedSolver, constraintsPtr, dfdpMultiVec, fBifMultiVec, globalData, grpPtr, isValidF, isValidJacobian, and NOX::Abstract::Group::Ok.

Referenced by computeGradient(), and computeNewton().

◆ computeNewton()

NOX::Abstract::Group::ReturnType LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeNewton ( Teuchos::ParameterList & params )

virtual

Compute Newton direction for extended continuation system.

Reimplemented from NOX::Abstract::Group.

References applyJacobianInverseMultiVector(), computeF(), computeJacobian(), ffMultiVec, globalData, isF(), isJacobian(), isValidNewton, newtonMultiVec, and NOX::Abstract::Group::Ok.

◆ computeScaledDotProduct()

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeScaledDotProduct	(	const NOX::Abstract::Vector &	a,
		const NOX::Abstract::Vector &	b ) const

virtual

Compute a scaled dot product.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References LOCA::Extended::Vector::getScalar(), LOCA::MultiContinuation::ExtendedVector::getXVec(), and grpPtr.

◆ computeX()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::computeX	(	const NOX::Abstract::Group &	g,
		const NOX::Abstract::Vector &	d,
		double	step )

virtual

Compute and return solution vector, x, where this.x = grp.x + step * d.

Implements NOX::Abstract::Group.

References bifParamID, constraintsPtr, getX(), LOCA::MultiContinuation::ExtendedVector::getXVec(), grpPtr, resetIsValid(), LOCA::Extended::Vector::update(), and xVec.

◆ copy()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::copy ( const NOX::Abstract::Group & source )

virtual

Assignment operator.

Implements LOCA::MultiContinuation::AbstractGroup.

References bifParamID, borderedSolver, constraintsPtr, dfdpMultiVec, fMultiVec, globalData, gradientMultiVec, grpPtr, hopfParams, index_dfdp, index_f, isValidF, isValidGradient, isValidJacobian, isValidNewton, newtonMultiVec, parsedParams, setupViews(), and xMultiVec.

Referenced by operator=().

◆ extractParameterComponent()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::extractParameterComponent	(	bool	use_transpose,
		const NOX::Abstract::MultiVector &	v,
		NOX::Abstract::MultiVector::DenseMatrix &	v_p ) const

virtual

Given the vector v, extract the parameter components of all of the nested subvectors in v down to the solution component for the unbordered group.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), and isBordered.

◆ extractSolutionComponent()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::extractSolutionComponent	(	const NOX::Abstract::MultiVector &	v,
		NOX::Abstract::MultiVector &	v_x ) const

virtual

Given the vector v, extract the underlying solution component corresponding to the unbordered group.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), and isBordered.

◆ fillA()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fillA ( NOX::Abstract::MultiVector & A ) const

virtual

Fill the combined A block as described above.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, dfdpMultiVec, isBordered, and NOX::Abstract::MultiVector::subView().

◆ fillB()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fillB ( NOX::Abstract::MultiVector & B ) const

virtual

Fill the combined B block as described above.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, constraintsPtr, isBordered, and NOX::Abstract::MultiVector::subView().

◆ fillC()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fillC ( NOX::Abstract::MultiVector::DenseMatrix & C ) const

virtual

Fill the combined C block as described above.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, constraintsPtr, dfdpMultiVec, and isBordered.

◆ getBifParam()

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getBifParam ( ) const

Get bifurcation parameter.

References bifParamID, and grpPtr.

◆ getBorderedWidth()

int LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getBorderedWidth ( ) const

virtual

Return the total width of the bordered rows/columns.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, and isBordered.

◆ getF()

const NOX::Abstract::Vector & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getF ( ) const

virtual

Return extended residual.

Implements NOX::Abstract::Group.

References fVec.

◆ getFPtr()

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getFPtr ( ) const

virtual

Return RCP to extended residual.

Implements NOX::Abstract::Group.

References fVec.

◆ getGradient()

const NOX::Abstract::Vector & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getGradient ( ) const

virtual

Gradient is never valid.

Implements NOX::Abstract::Group.

References gradientVec.

◆ getGradientPtr()

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getGradientPtr ( ) const

virtual

Gradient is never valid.

Implements NOX::Abstract::Group.

References gradientVec.

◆ getInitialVectors()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getInitialVectors	(	Teuchos::RCP< NOX::Abstract::Vector > &	aVecPtr_real,
		Teuchos::RCP< NOX::Abstract::Vector > &	aVecPtr_imag,
		Teuchos::RCP< NOX::Abstract::Vector > &	bVecPtr_real,
		Teuchos::RCP< NOX::Abstract::Vector > &	bVecPtr_imag,
		bool	isSymmetric )

protected

Computes initial "a" and "b" vectors.

References globalData, and hopfParams.

Referenced by ExtendedGroup().

◆ getNewton()

const NOX::Abstract::Vector & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getNewton ( ) const

virtual

Return extended Newton direction.

Implements NOX::Abstract::Group.

References newtonVec.

◆ getNewtonPtr()

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getNewtonPtr ( ) const

virtual

Return RCP to extended Newton direction.

Implements NOX::Abstract::Group.

References newtonVec.

◆ getNormF()

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getNormF ( ) const

virtual

Return 2-norm of extended residual.

Implements NOX::Abstract::Group.

References fVec, and NOX::Abstract::Vector::norm().

◆ getNormNewtonSolveResidual()

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getNormNewtonSolveResidual ( ) const

virtual

Returns 2-norm of extended Newton solve residual.

References applyJacobian(), fVec, globalData, newtonVec, LOCA::Extended::Vector::norm(), and LOCA::Extended::Vector::update().

◆ getParam() [1/2]

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getParam ( int paramID ) const

virtual

Return copy of parameter indexed by (integer) paramID.

Implements LOCA::MultiContinuation::AbstractGroup.

References grpPtr.

◆ getParam() [2/2]

double LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getParam ( std::string paramID ) const

virtual

Return copy of parameter indexed by (std::string) paramID.

Implements LOCA::MultiContinuation::AbstractGroup.

References grpPtr.

◆ getParams()

const LOCA::ParameterVector & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getParams ( ) const

virtual

Return a const reference to the ParameterVector owned by the group.

Implements LOCA::MultiContinuation::AbstractGroup.

References grpPtr.

◆ getUnborderedGroup()

Teuchos::RCP< const NOX::Abstract::Group > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getUnborderedGroup ( ) const

virtual

Get bottom-level unbordered group.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, grpPtr, and isBordered.

◆ getUnderlyingGroup() [1/2]

Teuchos::RCP< LOCA::MultiContinuation::AbstractGroup > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getUnderlyingGroup ( )

virtual

Return underlying group.

Implements LOCA::Extended::MultiAbstractGroup.

References grpPtr.

◆ getUnderlyingGroup() [2/2]

Teuchos::RCP< const LOCA::MultiContinuation::AbstractGroup > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getUnderlyingGroup ( ) const

virtual

Return underlying group.

Implements LOCA::Extended::MultiAbstractGroup.

References grpPtr.

◆ getX()

const NOX::Abstract::Vector & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getX ( ) const

virtual

Return extended solution vector.

Implements NOX::Abstract::Group.

References xVec.

Referenced by computeX(), and ExtendedGroup().

◆ getXPtr()

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::MinimallyAugmented::ExtendedGroup::getXPtr ( ) const

virtual

Return RCP to extended solution vector.

Implements NOX::Abstract::Group.

References xVec.

◆ isCombinedAZero()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isCombinedAZero ( ) const

virtual

Indicates whether combined A block is zero.

Implements LOCA::BorderedSystem::AbstractGroup.

◆ isCombinedBZero()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isCombinedBZero ( ) const

virtual

Indicates whether combined B block is zero.

Implements LOCA::BorderedSystem::AbstractGroup.

◆ isCombinedCZero()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isCombinedCZero ( ) const

virtual

Indicates whether combined C block is zero.

Implements LOCA::BorderedSystem::AbstractGroup.

◆ isF()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isF ( ) const

virtual

Return true if extended residual is valid.

Implements NOX::Abstract::Group.

References isValidF.

Referenced by computeGradient(), and computeNewton().

◆ isGradient()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isGradient ( ) const

virtual

Always returns false.

Reimplemented from NOX::Abstract::Group.

References isValidGradient.

◆ isJacobian()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isJacobian ( ) const

virtual

Return true if the extended Jacobian is valid.

Reimplemented from NOX::Abstract::Group.

References isValidJacobian.

Referenced by applyJacobianInverseMultiVector(), applyJacobianMultiVector(), applyJacobianTransposeMultiVector(), computeGradient(), and computeNewton().

◆ isNewton()

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isNewton ( ) const

virtual

Return true if the extended Newton direction is valid.

Reimplemented from NOX::Abstract::Group.

References isValidNewton.

◆ loadNestedComponents()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::loadNestedComponents	(	const NOX::Abstract::MultiVector &	v_x,
		const NOX::Abstract::MultiVector::DenseMatrix &	v_p,
		NOX::Abstract::MultiVector &	v ) const

virtual

Given the solution component v_x and combined parameter components v_p, distribute these components through the nested sub-vectors in v.

Implements LOCA::BorderedSystem::AbstractGroup.

References bordered_grp, LOCA::Extended::MultiVector::getScalars(), LOCA::MultiContinuation::ExtendedMultiVector::getXMultiVec(), and isBordered.

◆ operator=()

NOX::Abstract::Group & LOCA::Hopf::MinimallyAugmented::ExtendedGroup::operator= ( const NOX::Abstract::Group & source )

virtual

Assignment operator.

Implements NOX::Abstract::Group.

References copy().

◆ postProcessContinuationStep()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::postProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus stepStatus )

virtual

Perform any postprocessing after a continuation step finishes.

The stepStatus argument indicates whether the step was successful.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References constraintsPtr, and grpPtr.

◆ preProcessContinuationStep()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::preProcessContinuationStep ( LOCA::Abstract::Iterator::StepStatus stepStatus )

virtual

Perform any preprocessing before a continuation step starts.

The stepStatus argument indicates whether the previous step was successful.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References constraintsPtr, and grpPtr.

◆ printSolution() [1/2]

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::printSolution ( const double conParam ) const

virtual

Function to print out solution and parameter after successful step.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References constraintsPtr, globalData, grpPtr, NOX::Utils::StepperDetails, and xVec.

◆ printSolution() [2/2]

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::printSolution	(	const NOX::Abstract::Vector &	x,
		const double	conParam ) const

virtual

Function to print out a vector and parameter after successful step.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References constraintsPtr, LOCA::Extended::Vector::getScalar(), LOCA::MultiContinuation::ExtendedVector::getXVec(), globalData, grpPtr, and NOX::Utils::StepperDetails.

◆ projectToDraw()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::projectToDraw	(	const NOX::Abstract::Vector &	x,
		double *	px ) const

virtual

Projects solution to a few scalars for multiparameter continuation.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References LOCA::Extended::Vector::getScalar(), LOCA::MultiContinuation::ExtendedVector::getXVec(), and grpPtr.

◆ projectToDrawDimension()

int LOCA::Hopf::MinimallyAugmented::ExtendedGroup::projectToDrawDimension ( ) const

virtual

Returns the dimension of the project to draw array.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References grpPtr.

◆ resetIsValid()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::resetIsValid ( )

protectedvirtual

Resets all isValid flags to false.

References isValidF, isValidGradient, isValidJacobian, and isValidNewton.

Referenced by computeX(), setBifParam(), setParam(), setParams(), setParamsMulti(), and setX().

◆ scaleVector()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::scaleVector ( NOX::Abstract::Vector & x ) const

virtual

Scales a vector using scaling vector.

Reimplemented from LOCA::MultiContinuation::AbstractGroup.

References LOCA::MultiContinuation::ExtendedVector::getXVec(), and grpPtr.

◆ setBifParam()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setBifParam ( double param )

protected

Set bifurcation parameter.

References bifParamID, constraintsPtr, grpPtr, resetIsValid(), and xVec.

◆ setParam() [1/2]

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParam	(	int	paramID,
		double	val )

virtual

Set parameter indexed by (integer) paramID.

Implements LOCA::MultiContinuation::AbstractGroup.

References bifParamID, constraintsPtr, grpPtr, resetIsValid(), and xVec.

Referenced by setParam().

◆ setParam() [2/2]

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParam	(	std::string	paramID,
		double	val )

virtual

Set parameter indexed by (std::string) paramID.

Implements LOCA::MultiContinuation::AbstractGroup.

References LOCA::ParameterVector::getIndex(), grpPtr, and setParam().

◆ setParams()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParams ( const ParameterVector & p )

virtual

Set the parameter vector in the group to p (pVector = p).

Implements LOCA::MultiContinuation::AbstractGroup.

References bifParamID, constraintsPtr, grpPtr, LOCA::ParameterVector::length(), resetIsValid(), and xVec.

◆ setParamsMulti()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setParamsMulti	(	const std::vector< int > &	paramIDs,
		const NOX::Abstract::MultiVector::DenseMatrix &	vals )

virtual

Set parameters indexed by (integer) paramIDs.

Implements LOCA::MultiContinuation::AbstractGroup.

References bifParamID, constraintsPtr, grpPtr, resetIsValid(), setParamsMulti(), and xVec.

Referenced by setParamsMulti().

◆ setupViews()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setupViews ( )

protectedvirtual

Sets up multivector views.

References dfdpMultiVec, fBifMultiVec, ffMultiVec, fMultiVec, fVec, gradientMultiVec, gradientVec, index_dfdp, index_f, newtonMultiVec, newtonVec, xMultiVec, and xVec.

Referenced by copy(), ExtendedGroup(), and ExtendedGroup().

◆ setX()

void LOCA::Hopf::MinimallyAugmented::ExtendedGroup::setX ( const NOX::Abstract::Vector & y )

virtual

Set the solution vector to y.

Implements NOX::Abstract::Group.

References bifParamID, constraintsPtr, LOCA::Extended::Vector::getScalar(), LOCA::MultiContinuation::ExtendedVector::getXVec(), grpPtr, resetIsValid(), and xVec.

Member Data Documentation

◆ bifParamID

int LOCA::Hopf::MinimallyAugmented::ExtendedGroup::bifParamID

protected

Stores the bifurcation parameter index.

Referenced by computeJacobian(), computeX(), copy(), ExtendedGroup(), ExtendedGroup(), getBifParam(), setBifParam(), setParam(), setParams(), setParamsMulti(), and setX().

◆ bordered_grp

Teuchos::RCP<LOCA::BorderedSystem::AbstractGroup> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::bordered_grp

protected

Pointer to base group as a bordered group.

Referenced by ExtendedGroup(), ExtendedGroup(), extractParameterComponent(), extractSolutionComponent(), fillA(), fillB(), fillC(), getBorderedWidth(), getUnborderedGroup(), and loadNestedComponents().

◆ borderedSolver

Teuchos::RCP<LOCA::BorderedSolver::AbstractStrategy> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::borderedSolver

protected

Stores bordered solver strategy.

Referenced by applyJacobianInverseMultiVector(), applyJacobianMultiVector(), applyJacobianTransposeMultiVector(), computeJacobian(), copy(), ExtendedGroup(), and ExtendedGroup().

◆ constraintsPtr

Teuchos::RCP<LOCA::Hopf::MinimallyAugmented::Constraint> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::constraintsPtr

protected

Pointer to constraint object.

Referenced by computeDfDpMulti(), computeF(), computeJacobian(), computeX(), copy(), ExtendedGroup(), ExtendedGroup(), fillB(), fillC(), postProcessContinuationStep(), preProcessContinuationStep(), printSolution(), printSolution(), setBifParam(), setParam(), setParams(), setParamsMulti(), and setX().

◆ dfdpMultiVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedMultiVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::dfdpMultiVec

protected

Stores view of df/dp columns of fMultiVec.

Referenced by computeJacobian(), copy(), ExtendedGroup(), ExtendedGroup(), fillA(), fillC(), and setupViews().

◆ fBifMultiVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedMultiVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fBifMultiVec

protected

Stores view of f and first column of df/dp.

Referenced by computeJacobian(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ ffMultiVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedMultiVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::ffMultiVec

protected

Stores view of first column of fMultiVec as a multivec.

Referenced by computeNewton(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ fMultiVec

LOCA::MultiContinuation::ExtendedMultiVector LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fMultiVec

protected

Stores the extended residual vector and df/dp.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ fVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::fVec

protected

Stores view of first column of fMultiVec.

Referenced by computeF(), computeGradient(), ExtendedGroup(), ExtendedGroup(), getF(), getFPtr(), getNormF(), getNormNewtonSolveResidual(), and setupViews().

◆ globalData

Teuchos::RCP<LOCA::GlobalData> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::globalData

protected

Pointer LOCA global data object.

Referenced by applyJacobianInverseMultiVector(), applyJacobianMultiVector(), applyJacobianTransposeMultiVector(), computeDfDpMulti(), computeF(), computeGradient(), computeJacobian(), computeNewton(), copy(), ExtendedGroup(), ExtendedGroup(), getInitialVectors(), getNormNewtonSolveResidual(), printSolution(), and printSolution().

◆ gradientMultiVec

LOCA::MultiContinuation::ExtendedMultiVector LOCA::Hopf::MinimallyAugmented::ExtendedGroup::gradientMultiVec

protected

Stores the extended gradient vector.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ gradientVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::gradientVec

protected

Stores view of first column of gradientMultiVec.

Referenced by computeGradient(), ExtendedGroup(), ExtendedGroup(), getGradient(), getGradientPtr(), and setupViews().

◆ grpPtr

Teuchos::RCP<LOCA::Hopf::MinimallyAugmented::AbstractGroup> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::grpPtr

protected

Pointer to base group that defines $ F$ .

Referenced by computeDfDpMulti(), computeF(), computeJacobian(), computeScaledDotProduct(), computeX(), copy(), ExtendedGroup(), ExtendedGroup(), getBifParam(), getParam(), getParam(), getParams(), getUnborderedGroup(), getUnderlyingGroup(), getUnderlyingGroup(), postProcessContinuationStep(), preProcessContinuationStep(), printSolution(), printSolution(), projectToDraw(), projectToDrawDimension(), scaleVector(), setBifParam(), setParam(), setParam(), setParams(), setParamsMulti(), and setX().

◆ hopfParams

Teuchos::RCP<Teuchos::ParameterList> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::hopfParams

protected

Hopf parameter list.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and getInitialVectors().

◆ index_dfdp

std::vector<int> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::index_dfdp

protected

Stores indices for getting df/dp part of fMultiVec.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ index_f

std::vector<int> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::index_f

protected

Stores indices for getting f part of fMultiVec.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ isBordered

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isBordered

protected

Flag that indicates whether underlying group is a bordered group.

Referenced by ExtendedGroup(), ExtendedGroup(), extractParameterComponent(), extractSolutionComponent(), fillA(), fillB(), fillC(), getBorderedWidth(), getUnborderedGroup(), and loadNestedComponents().

◆ isValidF

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isValidF

protected

Is residual vector valid.

Referenced by computeF(), computeJacobian(), copy(), ExtendedGroup(), ExtendedGroup(), isF(), and resetIsValid().

◆ isValidGradient

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isValidGradient

protected

Is Gradient vector valid.

Referenced by computeGradient(), copy(), ExtendedGroup(), ExtendedGroup(), isGradient(), and resetIsValid().

◆ isValidJacobian

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isValidJacobian

protected

Is Jacobian matrix valid.

Referenced by computeJacobian(), copy(), ExtendedGroup(), ExtendedGroup(), isJacobian(), and resetIsValid().

◆ isValidNewton

bool LOCA::Hopf::MinimallyAugmented::ExtendedGroup::isValidNewton

protected

Is Newton vector valid.

Referenced by computeNewton(), copy(), ExtendedGroup(), ExtendedGroup(), isNewton(), and resetIsValid().

◆ newtonMultiVec

LOCA::MultiContinuation::ExtendedMultiVector LOCA::Hopf::MinimallyAugmented::ExtendedGroup::newtonMultiVec

protected

Stores the extended Newton vector.

Referenced by computeNewton(), copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ newtonVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::newtonVec

protected

Stores view of first column of newtonMultiVec.

Referenced by ExtendedGroup(), ExtendedGroup(), getNewton(), getNewtonPtr(), getNormNewtonSolveResidual(), and setupViews().

◆ parsedParams

Teuchos::RCP<LOCA::Parameter::SublistParser> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::parsedParams

protected

Parsed top-level parameters.

Referenced by copy(), ExtendedGroup(), and ExtendedGroup().

◆ xMultiVec

LOCA::MultiContinuation::ExtendedMultiVector LOCA::Hopf::MinimallyAugmented::ExtendedGroup::xMultiVec

protected

Stores the extended solution vector.

Referenced by copy(), ExtendedGroup(), ExtendedGroup(), and setupViews().

◆ xVec

Teuchos::RCP<LOCA::MultiContinuation::ExtendedVector> LOCA::Hopf::MinimallyAugmented::ExtendedGroup::xVec

protected

Stores view of first column of xMultiVec.

Referenced by computeX(), ExtendedGroup(), ExtendedGroup(), getX(), getXPtr(), printSolution(), setBifParam(), setParam(), setParams(), setParamsMulti(), setupViews(), and setX().

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

LOCA_Hopf_MinimallyAugmented_ExtendedGroup.H
LOCA_Hopf_MinimallyAugmented_ExtendedGroup.C

Public Member Functions

Implementation of

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ExtendedGroup() [1/2]

◆ ExtendedGroup() [2/2]

Member Function Documentation

◆ applyJacobian()

◆ applyJacobianInverse()

◆ applyJacobianInverseMultiVector()

◆ applyJacobianMultiVector()

◆ applyJacobianTranspose()

◆ applyJacobianTransposeMultiVector()

◆ clone()

◆ computeDfDpMulti()

◆ computeF()

◆ computeGradient()

◆ computeJacobian()

◆ computeNewton()

◆ computeScaledDotProduct()

◆ computeX()

◆ copy()

◆ extractParameterComponent()

◆ extractSolutionComponent()

◆ fillA()

◆ fillB()

◆ fillC()

◆ getBifParam()

◆ getBorderedWidth()

◆ getF()

◆ getFPtr()

◆ getGradient()

◆ getGradientPtr()

◆ getInitialVectors()

◆ getNewton()

◆ getNewtonPtr()

◆ getNormF()

◆ getNormNewtonSolveResidual()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getParams()

◆ getUnborderedGroup()

◆ getUnderlyingGroup() [1/2]

◆ getUnderlyingGroup() [2/2]

◆ getX()

◆ getXPtr()

◆ isCombinedAZero()

◆ isCombinedBZero()

◆ isCombinedCZero()

◆ isF()

◆ isGradient()

◆ isJacobian()

◆ isNewton()

◆ loadNestedComponents()

◆ operator=()

◆ postProcessContinuationStep()

◆ preProcessContinuationStep()

◆ printSolution() [1/2]

◆ printSolution() [2/2]

◆ projectToDraw()

◆ projectToDrawDimension()

◆ resetIsValid()

◆ scaleVector()

◆ setBifParam()

◆ setParam() [1/2]

◆ setParam() [2/2]

◆ setParams()

◆ setParamsMulti()

◆ setupViews()

◆ setX()

Member Data Documentation

◆ bifParamID

◆ bordered_grp

◆ borderedSolver

◆ constraintsPtr

◆ dfdpMultiVec

◆ fBifMultiVec

◆ ffMultiVec

◆ fMultiVec