LOCA::Hopf::MooreSpence::FiniteDifferenceGroup Class Reference

Concrete class that provides concrete implementations of the derivative computation methods of the LOCA::Hopf::MooreSpence::AbstractGroup using first-order finite differencing. More...

#include <LOCA_Hopf_MooreSpence_FiniteDifferenceGroup.H>

Inheritance diagram for LOCA::Hopf::MooreSpence::FiniteDifferenceGroup:

[legend]
Collaboration diagram for LOCA::Hopf::MooreSpence::FiniteDifferenceGroup:
[legend]
List of all members.

Public Member Functions

 FiniteDifferenceGroup ()
 Constructor.
 FiniteDifferenceGroup (const FiniteDifferenceGroup &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
virtual ~FiniteDifferenceGroup ()
 Destructor.
virtual NOX::Abstract::Group::ReturnType computeDCeDp (const vector< int > &paramIDs, const NOX::Abstract::Vector &yVector, const NOX::Abstract::Vector &zVector, double w, NOX::Abstract::MultiVector &result_real, NOX::Abstract::MultiVector &result_imag, bool isValid)
 Computes the derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial p}$ where $p$ is the parameter indexed by paramIDs.
virtual NOX::Abstract::Group::ReturnType computeDCeDxa (const NOX::Abstract::Vector &yVector, const NOX::Abstract::Vector &zVector, double w, const NOX::Abstract::MultiVector &aVector, NOX::Abstract::MultiVector &result_real, NOX::Abstract::MultiVector &result_imag)
 Computes the directional derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial x} a$ for the given direction $a$.
virtual NOX::Abstract::Group::ReturnType computeDCeDxa (const NOX::Abstract::Vector &yVector, const NOX::Abstract::Vector &zVector, double w, const NOX::Abstract::MultiVector &aVector, const NOX::Abstract::Vector &Ce_real, const NOX::Abstract::Vector &Ce_imag, NOX::Abstract::MultiVector &result_real, NOX::Abstract::MultiVector &result_imag)
 Computes the directional derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial x} a$ for the given direction $a$. The arguments Ce_real and Ce_imag hold the real and imaginary components of $(J+i\omega B)(y+iz)$.

Detailed Description

Concrete class that provides concrete implementations of the derivative computation methods of the LOCA::Hopf::MooreSpence::AbstractGroup using first-order finite differencing.

The finite-differencing calculations are actually implemented by the LOCA::DerivUtils class, and a custom DerivUtils object can be passed through the constructor of this class. However, in the future the calculations encapsulated in the DerivUtils class may be incorporated directly into this class and other finite-differencing child classes.


Member Function Documentation

NOX::Abstract::Group::ReturnType LOCA::Hopf::MooreSpence::FiniteDifferenceGroup::computeDCeDp const vector< int > &  paramIDs,
const NOX::Abstract::Vector yVector,
const NOX::Abstract::Vector zVector,
double  w,
NOX::Abstract::MultiVector result_real,
NOX::Abstract::MultiVector result_imag,
bool  isValid
[virtual]
 

Computes the derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial p}$ where $p$ is the parameter indexed by paramIDs.

The calculation is implemented by calling the corresponding LOCA::DerivUtils::computeDCeDp() method of the passed LOCA::DerivUtils object.

Implements LOCA::Hopf::MooreSpence::AbstractGroup.

NOX::Abstract::Group::ReturnType LOCA::Hopf::MooreSpence::FiniteDifferenceGroup::computeDCeDxa const NOX::Abstract::Vector yVector,
const NOX::Abstract::Vector zVector,
double  w,
const NOX::Abstract::MultiVector aVector,
const NOX::Abstract::Vector Ce_real,
const NOX::Abstract::Vector Ce_imag,
NOX::Abstract::MultiVector result_real,
NOX::Abstract::MultiVector result_imag
[virtual]
 

Computes the directional derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial x} a$ for the given direction $a$. The arguments Ce_real and Ce_imag hold the real and imaginary components of $(J+i\omega B)(y+iz)$.

The calculation is implemented by calling the corresponding LOCA::DerivUtils::computeDCeDxa() method of the passed LOCA::DerivUtils object.

Implements LOCA::Hopf::MooreSpence::AbstractGroup.

NOX::Abstract::Group::ReturnType LOCA::Hopf::MooreSpence::FiniteDifferenceGroup::computeDCeDxa const NOX::Abstract::Vector yVector,
const NOX::Abstract::Vector zVector,
double  w,
const NOX::Abstract::MultiVector aVector,
NOX::Abstract::MultiVector result_real,
NOX::Abstract::MultiVector result_imag
[virtual]
 

Computes the directional derivative $\frac{\partial (J+i\omega B)(y+iz)}{\partial x} a$ for the given direction $a$.

The calculation is implemented by calling the corresponding LOCA::DerivUtils::computeDCeDxa() method of the passed LOCA::DerivUtils object.

Implements LOCA::Hopf::MooreSpence::AbstractGroup.


The documentation for this class was generated from the following files:
Generated on Thu Sep 18 12:38:32 2008 for NOX by doxygen 1.3.9.1