Thyra
Version of the Day
|
Concrete Adapter subclass that takes an EpetraExt::ModelEvaluator
object and wraps it as a Thyra::ModelEvaluator
object.
More...
#include <Thyra_EpetraModelEvaluator.hpp>
Related Functions | |
(Note that these are not member functions.) | |
RCP< EpetraModelEvaluator > | epetraModelEvaluator (const RCP< const EpetraExt::ModelEvaluator > &epetraModel, const RCP< LinearOpWithSolveFactoryBase< double > > &W_factory) |
ModelEvaluatorBase::EDerivativeMultiVectorOrientation | convert (const EpetraExt::ModelEvaluator::EDerivativeMultiVectorOrientation &mvOrientation) |
EpetraExt::ModelEvaluator::EDerivativeMultiVectorOrientation | convert (const ModelEvaluatorBase::EDerivativeMultiVectorOrientation &mvOrientation) |
ModelEvaluatorBase::DerivativeProperties | convert (const EpetraExt::ModelEvaluator::DerivativeProperties &derivativeProperties) |
ModelEvaluatorBase::DerivativeSupport | convert (const EpetraExt::ModelEvaluator::DerivativeSupport &derivativeSupport) |
EpetraExt::ModelEvaluator::Derivative | convert (const ModelEvaluatorBase::Derivative< double > &derivative, const RCP< const Epetra_Map > &fnc_map, const RCP< const Epetra_Map > &var_map) |
Related Functions inherited from Thyra::ModelEvaluatorBase | |
std::string | toString (ModelEvaluatorBase::EInArgsMembers) |
std::string | toString (ModelEvaluatorBase::EOutArgsMembers) |
std::string | toString (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
ModelEvaluatorBase::EDerivativeMultiVectorOrientation | getOtherDerivativeMultiVectorOrientation (ModelEvaluatorBase::EDerivativeMultiVectorOrientation orientation) |
Constructors/initializers/accessors/utilities. | |
EpetraModelEvaluator () | |
EpetraModelEvaluator (const RCP< const EpetraExt::ModelEvaluator > &epetraModel, const RCP< LinearOpWithSolveFactoryBase< double > > &W_factory) | |
void | initialize (const RCP< const EpetraExt::ModelEvaluator > &epetraModel, const RCP< LinearOpWithSolveFactoryBase< double > > &W_factory) |
RCP< const EpetraExt::ModelEvaluator > | getEpetraModel () const |
void | setNominalValues (const ModelEvaluatorBase::InArgs< double > &nominalValues) |
Set the nominal values. More... | |
void | setStateVariableScalingVec (const RCP< const Epetra_Vector > &stateVariableScalingVec) |
Set the state variable scaling vector s_x (see above). More... | |
RCP< const Epetra_Vector > | getStateVariableInvScalingVec () const |
Get the state variable scaling vector s_x (see above). More... | |
RCP< const Epetra_Vector > | getStateVariableScalingVec () const |
Get the inverse state variable scaling vector inv_s_x (see above). More... | |
void | setStateFunctionScalingVec (const RCP< const Epetra_Vector > &stateFunctionScalingVec) |
Set the state function scaling vector s_f (see above). More... | |
RCP< const Epetra_Vector > | getStateFunctionScalingVec () const |
Get the state function scaling vector s_f (see above). More... | |
void | uninitialize (RCP< const EpetraExt::ModelEvaluator > *epetraModel=NULL, RCP< LinearOpWithSolveFactoryBase< double > > *W_factory=NULL) |
const ModelEvaluatorBase::InArgs < double > & | getFinalPoint () const |
bool | finalPointWasSolved () const |
Public functions overridden from Teuchos::Describable. | |
std::string | description () const |
Overridden from ParameterListAcceptor | |
void | setParameterList (RCP< Teuchos::ParameterList > const ¶mList) |
RCP< Teuchos::ParameterList > | getNonconstParameterList () |
RCP< Teuchos::ParameterList > | unsetParameterList () |
RCP< const Teuchos::ParameterList > | getParameterList () const |
RCP< const Teuchos::ParameterList > | getValidParameters () const |
Public functions overridden from ModelEvaulator. | |
int | Np () const |
int | Ng () const |
RCP< const VectorSpaceBase < double > > | get_x_space () const |
RCP< const VectorSpaceBase < double > > | get_f_space () const |
RCP< const VectorSpaceBase < double > > | get_p_space (int l) const |
RCP< const Teuchos::Array < std::string > > | get_p_names (int l) const |
RCP< const VectorSpaceBase < double > > | get_g_space (int j) const |
Teuchos::ArrayView< const std::string > | get_g_names (int j) const |
ModelEvaluatorBase::InArgs < double > | getNominalValues () const |
ModelEvaluatorBase::InArgs < double > | getLowerBounds () const |
ModelEvaluatorBase::InArgs < double > | getUpperBounds () const |
RCP< LinearOpBase< double > > | create_W_op () const |
RCP< PreconditionerBase< double > > | create_W_prec () const |
Returns null currently. More... | |
RCP< const LinearOpWithSolveFactoryBase < double > > | get_W_factory () const |
ModelEvaluatorBase::InArgs < double > | createInArgs () const |
void | reportFinalPoint (const ModelEvaluatorBase::InArgs< double > &finalPoint, const bool wasSolved) |
Concrete Adapter subclass that takes an EpetraExt::ModelEvaluator
object and wraps it as a Thyra::ModelEvaluator
object.
This class takes care of the basic details of wrapping and unwrapping Epetra from Thyra objects. This class is highly configurable and will be maintained and modified in the future as the basic link between the Epetra world and the Thyra world for nonlinear models and nonlinear algorithms.
This class can handle scaling of the state function f(...) and of the state variables x and all of the affected derivatives.
The scaling for the state function can be set manually using setStateFunctionScalingVec()
or can be computed automatically using the parameter "State Function Scaling"
(see documentation output from this->getValidParameters()->print(...)
) in the input parameter list set by setParameterList()
. Reguardless of how the state function scaling is computed, it will compute a positive vector s_f
that defines a diagonal matrix S_f = diag(s_f)
that transforms the state function:
f(...) = S_f * f_orig(...)
where f_orig(...)
is the original state function as computed by the underlying EpetraExt::ModelEvaluator
object and f(...)
is the state function as computed by evalModel()
.
The scaling for the state variables must be set manually using Thyra::setStateVariableScalingVec()
. The vector that is set s_x>/tt> defines a diagonal scaling matrix
S_x = diag(s_x)
that transforms the variables as:
x = S_x * x_orig
where
x_orig
is the original unscaled state variable vector as defined by the underlying EpetraExt::ModelEvaluator
object and x
is the scaled state varaible vector as returned from getNominalValues()
and as accepted by evalModel()
. Note that when the scaled variables x
are passed into evalModel
that they are unscaled as:
x_orig = inv(S_x) * x
where
inv(S_x)
is the inverse of the diagonals of S_x
which is stored as a vector inv_s_x
.
Note how these scalings affect the state function:
f(x,...) = S_f * f_orig( inv(S_x)*x...)
which as the state/state Jacobian:
W = d(f)/d(x) = S_f * d(f_orig)/d(x_orig) * inv(S_x)
Currently, this class does not handle scalings of the parameters
p(l)
or of the auxilary response functions g(j)(...)
.
The state varaible and state function scaling gives the following scaled quantities:
f = S_f * f_orig W = S_f * W_orig * inv(S_x) DfDp(l) = S_f * DfDp_orig(l) g(j) = g_orig(j) DgDx_dot(j) = DgDx_dot_orig(j) * inv(S_x) DgDx(j) = DgDx_orig(j) * inv(S_x) DgDp(j,l) = DgDp_orig(j,l)
Since the scaling is done explicitly, the client never even sees the orginal scaling and the linear solver (and contained preconditioner) are computed from the scaled W shown above.
ToDo: Describe how scaling affects the Hessian-vector products an how you just need to scale the Lagrange mutipliers as:
u^T * f(...) = u^T * (S_f * f_orig(...)) = u_f^T * f_orig(...)
where
u_f = S_f * u
.
ToDo: Finish documentation!
Definition at line 175 of file Thyra_EpetraModelEvaluator.hpp.
Thyra::EpetraModelEvaluator::EpetraModelEvaluator | ( | ) |
Definition at line 123 of file Thyra_EpetraModelEvaluator.cpp.
Thyra::EpetraModelEvaluator::EpetraModelEvaluator | ( | const RCP< const EpetraExt::ModelEvaluator > & | epetraModel, |
const RCP< LinearOpWithSolveFactoryBase< double > > & | W_factory | ||
) |
Definition at line 129 of file Thyra_EpetraModelEvaluator.cpp.
void Thyra::EpetraModelEvaluator::initialize | ( | const RCP< const EpetraExt::ModelEvaluator > & | epetraModel, |
const RCP< LinearOpWithSolveFactoryBase< double > > & | W_factory | ||
) |
Definition at line 140 of file Thyra_EpetraModelEvaluator.cpp.
RCP< const EpetraExt::ModelEvaluator > Thyra::EpetraModelEvaluator::getEpetraModel | ( | ) | const |
Definition at line 197 of file Thyra_EpetraModelEvaluator.cpp.
void Thyra::EpetraModelEvaluator::setNominalValues | ( | const ModelEvaluatorBase::InArgs< double > & | nominalValues | ) |
Set the nominal values.
Warning, if scaling is being used, these must be according to the scaled values, not the original unscaled values.
Definition at line 203 of file Thyra_EpetraModelEvaluator.cpp.
void Thyra::EpetraModelEvaluator::setStateVariableScalingVec | ( | const RCP< const Epetra_Vector > & | stateVariableScalingVec | ) |
Set the state variable scaling vector s_x
(see above).
This function must be called after intialize()
or the constructur in order to set the scaling vector correctly!
ToDo: Move this into an external strategy class object!
Definition at line 212 of file Thyra_EpetraModelEvaluator.cpp.
RCP< const Epetra_Vector > Thyra::EpetraModelEvaluator::getStateVariableInvScalingVec | ( | ) | const |
Get the state variable scaling vector s_x
(see above).
Definition at line 234 of file Thyra_EpetraModelEvaluator.cpp.
RCP< const Epetra_Vector > Thyra::EpetraModelEvaluator::getStateVariableScalingVec | ( | ) | const |
Get the inverse state variable scaling vector inv_s_x
(see above).
Definition at line 227 of file Thyra_EpetraModelEvaluator.cpp.
void Thyra::EpetraModelEvaluator::setStateFunctionScalingVec | ( | const RCP< const Epetra_Vector > & | stateFunctionScalingVec | ) |
Set the state function scaling vector s_f
(see above).
Definition at line 241 of file Thyra_EpetraModelEvaluator.cpp.
RCP< const Epetra_Vector > Thyra::EpetraModelEvaluator::getStateFunctionScalingVec | ( | ) | const |
Get the state function scaling vector s_f
(see above).
Definition at line 250 of file Thyra_EpetraModelEvaluator.cpp.
void Thyra::EpetraModelEvaluator::uninitialize | ( | RCP< const EpetraExt::ModelEvaluator > * | epetraModel = NULL , |
RCP< LinearOpWithSolveFactoryBase< double > > * | W_factory = NULL |
||
) |
Definition at line 256 of file Thyra_EpetraModelEvaluator.cpp.
const ModelEvaluatorBase::InArgs< double > & Thyra::EpetraModelEvaluator::getFinalPoint | ( | ) | const |
Definition at line 273 of file Thyra_EpetraModelEvaluator.cpp.
bool Thyra::EpetraModelEvaluator::finalPointWasSolved | ( | ) | const |
Definition at line 279 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Reimplemented from Teuchos::Describable.
Definition at line 288 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Teuchos::ParameterListAcceptor.
Definition at line 310 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Teuchos::ParameterListAcceptor.
Definition at line 331 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Teuchos::ParameterListAcceptor.
Definition at line 338 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Reimplemented from Teuchos::ParameterListAcceptor.
Definition at line 347 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Reimplemented from Teuchos::ParameterListAcceptor.
Definition at line 354 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 403 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 409 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 416 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 423 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 430 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 440 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 450 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 458 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 468 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 476 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 484 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 492 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Returns null currently.
Implements Thyra::ModelEvaluator< double >.
Definition at line 499 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
.
Implements Thyra::ModelEvaluator< double >.
Definition at line 506 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 512 of file Thyra_EpetraModelEvaluator.cpp.
|
virtual |
Implements Thyra::ModelEvaluator< double >.
Definition at line 520 of file Thyra_EpetraModelEvaluator.cpp.
|
related |
|
related |
|
related |
|
related |
|
related |
|
related |