PyTrilinos.EpetraExt.OutArgs Class Reference

Inheritance diagram for PyTrilinos.EpetraExt.OutArgs:

Collaboration diagram for PyTrilinos.EpetraExt.OutArgs:

List of all members.

Public Member Functions
def	__init__
Static Public Attributes
dictionary	props
dictionary	defaults

---

Detailed Description

OutArgs proxy class

This is a 'Property' class restricted to specific attributes that are
type-checked. These properties are:

description          - string description of associated ModelEvaluation
g                    - (int, tuple_of_Evaluation): VARIABLE G support.  If
                       an int, the solver should allocate an array of the
                       given number of Evaluations.  If 0, g is not
                       supported.  If a tuple_of_Evaluation, the solver
                       should use the user-provided data.  (default 0)
f                    - (bool, Evaluation): VARIABLE F support.  If True, the
                       solver should allocate the Evaluation.  If False, f
                       is not supported.  If an Evaluation, the solver
                       should use the user-supplied data.  (default False)
W                    - (bool, Epetra.Operator): VARIABLE W support.  If True, the
                       solver should allocate the operator.  If False, W
                       is not supported.  If an operator, the solver
                       should use the user-supplied data.  (default False)
W_properties         - DerivativeProperties: derivative properties for
                       VARIABLE W.  (default None)
DfDp                 - (int, tuple_of_Derivative): VARIABLE DFDP support.  If
                       an int, the solver should allocate an array of the
                       given number of Derivatives.  If 0, DfDp is not
                       supported.  If a tuple_of_Derivative, the solver
                       should use the user-provided data.  (default 0)
DfDp_properties      - tuple_of_DerivativeProperties: derivative properties
                       for VARIABLE DFDP.  (default None)
DgDx                 - (int, tuple_of_Derivative): VARIABLE DGDX support.  If
                       an int, the solver should allocate an array of the
                       given number of Derivatives.  If 0, DgDx is not
                       supported.  If a tuple_of_Derivative, the solver
                       should use the user-provided data.  (default 0)
DgDx_properties      - tuple_of_DerivativeProperties: derivative properties
                       for VARIABLE DGDX.  (default None)
DgDx_dot             - (int, tuple_of_Derivative): VARIABLE DGDX_DOT support.
                       If an int, the solver should allocate an array of the
                       given number of Derivatives.  If 0, DgDx_dot is not
                       supported.  If a tuple_of_Derivative, the solver
                       should use the user-provided data.  (default 0)
DgDx_dot_properties  - tuple_of_DerivativeProperties: derivative properties
                       for VARIABLE DGDX_DOT.  (default None)
DgDp                 - (int, tuple_of_Derivative): VARIABLE DGDP support.  If
                       an int, the solver should allocate an array of the
                       given number of Derivatives.  If 0, DgDp is not
                       supported.  If a tuple_of_Derivative, the solver
                       should use the user-provided data.  (default 0)
DgDp_properties      - tuple_of_DerivativeProperties: derivative properties
                       for VARIABLE DGDP.  (default None)

---

Member Data Documentation

dictionary PyTrilinos::EpetraExt.OutArgs::defaults [static]

Initial value:

{'description' : 'WARNING!  THIS OUTARGS OBJECT IS UNINITALIZED!',
                'g'           : 0,
                'f'           : False,
                'W'           : False,
                'DfDp'        : 0,
                'DgDx'        : 0,
                'DgDx_dot'    : 0,
                'DgDp'        : 0
                }

dictionary PyTrilinos::EpetraExt.OutArgs::props [static]

Initial value:

{'description'         : str,
             'g'                   : (int, tuple_of_Evaluation),
             'f'                   : (bool, Evaluation),
             'W'                   : (bool, Epetra.Operator),
             'W_properties'        : DerivativeProperties,
             #'f_poly'              : Teuchos.Polynomial,
             'DfDp'                : (int, tuple_of_Derivative),
             'DfDp_properties'     : tuple_of_DerivativeProperties,
             'DgDx'                : (int, tuple_of_Derivative),
             'DgDx_properties'     : tuple_of_DerivativeProperties,
             'DgDx_dot'            : (int, tuple_of_Derivative),
             'DgDx_dot_properties' : tuple_of_DerivativeProperties,
             'DgDp'                : (int, tuple_of_Derivative),
             'DgDp_properties'     : tuple_of_DerivativeProperties
             }

---

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

• EpetraExt.py