00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042 #ifndef NOX_BELOS_GROUP_H
00043 #define NOX_BELOS_GROUP_H
00044
00045 #include "NOX_Abstract_Group.H"
00046 #include "NOX_Utils.H"
00047 #include "Teuchos_RCP.hpp"
00048
00049 namespace NOX {
00050
00052 namespace Belos {
00053
00055
00066 class Group : public NOX::Abstract::Group {
00067
00068 public:
00069
00071 Group(const Teuchos::RCP<NOX::Abstract::Group>& g,
00072 NOX::Parameter::List& printParams);
00073
00075 Group(const Group& source, NOX::CopyType type = NOX::DeepCopy);
00076
00078 virtual ~Group();
00079
00081 virtual Group& operator=(const Group& source);
00082
00087
00089 virtual NOX::Abstract::Group&
00090 operator=(const NOX::Abstract::Group& source);
00091
00093 virtual Teuchos::RCP<NOX::Abstract::Group>
00094 clone(NOX::CopyType type = NOX::DeepCopy) const;
00095
00097 virtual void setX(const NOX::Abstract::Vector& y);
00098
00100 virtual void computeX(const NOX::Abstract::Group& g,
00101 const NOX::Abstract::Vector& d,
00102 double step);
00103
00105 virtual NOX::Abstract::Group::ReturnType computeF();
00106
00108 virtual NOX::Abstract::Group::ReturnType computeJacobian();
00109
00111 virtual NOX::Abstract::Group::ReturnType computeGradient();
00112
00114 virtual NOX::Abstract::Group::ReturnType
00115 computeNewton(NOX::Parameter::List& params);
00116
00118 virtual NOX::Abstract::Group::ReturnType
00119 applyJacobian(const NOX::Abstract::Vector& input,
00120 NOX::Abstract::Vector& result) const;
00121
00123 virtual NOX::Abstract::Group::ReturnType
00124 applyJacobianTranspose(const NOX::Abstract::Vector& input,
00125 NOX::Abstract::Vector& result) const;
00126
00128 virtual NOX::Abstract::Group::ReturnType
00129 applyJacobianInverse(NOX::Parameter::List& params,
00130 const NOX::Abstract::Vector& input,
00131 NOX::Abstract::Vector& result) const;
00132
00134 virtual NOX::Abstract::Group::ReturnType
00135 applyRightPreconditioning(bool useTranspose,
00136 NOX::Parameter::List& params,
00137 const NOX::Abstract::Vector& input,
00138 NOX::Abstract::Vector& result) const;
00139
00141 virtual NOX::Abstract::Group::ReturnType
00142 applyJacobianMultiVector(const NOX::Abstract::MultiVector& input,
00143 NOX::Abstract::MultiVector& result) const;
00144
00146 virtual NOX::Abstract::Group::ReturnType
00147 applyJacobianTransposeMultiVector(
00148 const NOX::Abstract::MultiVector& input,
00149 NOX::Abstract::MultiVector& result) const;
00150
00152 virtual NOX::Abstract::Group::ReturnType
00153 applyJacobianInverseMultiVector(
00154 NOX::Parameter::List& params,
00155 const NOX::Abstract::MultiVector& input,
00156 NOX::Abstract::MultiVector& result) const;
00157
00159 virtual NOX::Abstract::Group::ReturnType
00160 applyRightPreconditioningMultiVector(
00161 bool useTranspose,
00162 NOX::Parameter::List& params,
00163 const NOX::Abstract::MultiVector& input,
00164 NOX::Abstract::MultiVector& result) const;
00165
00167 virtual bool isF() const;
00168
00170 virtual bool isJacobian() const;
00171
00173 virtual bool isGradient() const;
00174
00176 virtual bool isNewton() const;
00177
00179 virtual const NOX::Abstract::Vector& getX() const;
00180
00182 virtual const NOX::Abstract::Vector& getF() const;
00183
00185 virtual double getNormF() const;
00186
00188 virtual const NOX::Abstract::Vector& getGradient() const;
00189
00191 virtual const NOX::Abstract::Vector& getNewton() const;
00192
00194 virtual double getNormNewtonSolveResidual() const;
00195
00197
00198 protected:
00199
00201 void resetIsValid();
00202
00203 protected:
00204
00206 Teuchos::RCP<NOX::Abstract::Group> grpPtr;
00207
00209 Teuchos::RCP<NOX::Abstract::Vector> newtonVecPtr;
00210
00212 bool isValidNewton;
00213
00215 NOX::Utils utils;
00216
00218 int myPID;
00219
00220 };
00221 }
00222 }
00223
00224 #endif