PyTrilinos::Teuchos::ParameterListAcceptor Class Reference

Inheritance diagram for PyTrilinos::Teuchos::ParameterListAcceptor:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Teuchos::ParameterListAcceptor:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def setParameterList
def getNonconstParameterList
def __init__
def setParameterList
def getNonconstParameterList


Detailed Description

Base class objects that can accept a parameter list.

ToDo: Finish Documentation!

C++ includes: Teuchos_ParameterListAcceptor.hpp 

Member Function Documentation

def PyTrilinos::Teuchos::ParameterListAcceptor::getNonconstParameterList (   self,
  args 
)

getNonconstParameterList(self) -> Teuchos::RCP<(Teuchos::ParameterList)>

virtual
RCP<ParameterList>
Teuchos::ParameterListAcceptor::getNonconstParameterList()=0

Get the parameter list that was set using  setParameterList(). 

Reimplemented in PyTrilinos::Amesos::BaseSolver, and PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Teuchos::ParameterListAcceptor::getNonconstParameterList (   self,
  args 
)

getNonconstParameterList(self) -> Teuchos::RCP<(Teuchos::ParameterList)>

virtual
RCP<ParameterList>
Teuchos::ParameterListAcceptor::getNonconstParameterList()=0

Get the parameter list that was set using  setParameterList(). 

Reimplemented in PyTrilinos::Amesos::BaseSolver, and PyTrilinos::Amesos::BaseSolver.

def PyTrilinos::Teuchos::ParameterListAcceptor::setParameterList (   self,
  args 
)

setParameterList(self, Teuchos::RCP<(Teuchos::ParameterList)> paramList)

virtual void
Teuchos::ParameterListAcceptor::setParameterList(RCP< ParameterList >
const &paramList)=0

Set parameters from a parameter list and return with default values.

Parameters:
-----------

paramList:  [in] On input contains the parameters set by the client.
Note that *paramList may have parameters set to their default values
added while the list is being parsed either right away or later.

Preconditions:  paramList.get() != NULL

Postconditions:  this-> getParameterList(). get() == paramList.get()

This is parameter list is "remembered" by *this object until it is
unset using  unsetParameterList().

Note: When this parameter list is passed in it is assumed that the
client has finished setting all of the values that they want to set so
that the list is completely ready to read (and be validated) by *this
object. If the client is to change this parameter list by adding new
options or changing the value of current options, the behavior of
*this object is undefined. This is because, the object may read the
options from *paramList right away or may wait to read some options
until a later time. There should be no expectation that if an option
is changed by the client that this will automatically be recognized by
*this object. To change even one parameter, this function must be
called again, with the entire sublist. 

Reimplemented in PyTrilinos::Amesos::BaseSolver, PyTrilinos::Amesos::Lapack, PyTrilinos::Amesos::BaseSolver, and PyTrilinos::Amesos::Lapack.

def PyTrilinos::Teuchos::ParameterListAcceptor::setParameterList (   self,
  args 
)

setParameterList(self, Teuchos::RCP<(Teuchos::ParameterList)> paramList)

virtual void
Teuchos::ParameterListAcceptor::setParameterList(RCP< ParameterList >
const &paramList)=0

Set parameters from a parameter list and return with default values.

Parameters:
-----------

paramList:  [in] On input contains the parameters set by the client.
Note that *paramList may have parameters set to their default values
added while the list is being parsed either right away or later.

Preconditions:  paramList.get() != NULL

Postconditions:  this-> getParameterList(). get() == paramList.get()

This is parameter list is "remembered" by *this object until it is
unset using  unsetParameterList().

Note: When this parameter list is passed in it is assumed that the
client has finished setting all of the values that they want to set so
that the list is completely ready to read (and be validated) by *this
object. If the client is to change this parameter list by adding new
options or changing the value of current options, the behavior of
*this object is undefined. This is because, the object may read the
options from *paramList right away or may wait to read some options
until a later time. There should be no expectation that if an option
is changed by the client that this will automatically be recognized by
*this object. To change even one parameter, this function must be
called again, with the entire sublist. 

Reimplemented in PyTrilinos::Amesos::BaseSolver, PyTrilinos::Amesos::Lapack, PyTrilinos::Amesos::BaseSolver, and PyTrilinos::Amesos::Lapack.


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

Generated on Thu Dec 17 11:00:23 2009 for PyTrilinos by  doxygen 1.5.9