MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | List of all members
NLPInterfacePack::ExampleBasisSystem Class Reference

Subclass of BasisSystem for example NLP. More...

#include <NLPInterfacePack_ExampleBasisSystem.hpp>

Inheritance diagram for NLPInterfacePack::ExampleBasisSystem:
Inheritance graph
[legend]

Public Member Functions

 ExampleBasisSystem (const VectorSpace::space_ptr_t &space_x, const Range1D &var_dep, const Range1D &var_indep)
 Calls this->initialize() More...
 
void initialize (const VectorSpace::space_ptr_t &space_x, const Range1D &var_dep, const Range1D &var_indep)
 Initialize given the vector space for the dependent and independent variables. More...
 
- Public Member Functions inherited from AbstractLinAlgPack::BasisSystemComposite
 BasisSystemComposite ()
 
 BasisSystemComposite (const VectorSpace::space_ptr_t &space_x, const VectorSpace::space_ptr_t &space_c, const mat_nonsing_fcty_ptr_t &factory_C, const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S)
 Calls this->initialize() in a way that is consistant with above helper functions. More...
 
 BasisSystemComposite (const VectorSpace::space_ptr_t &space_x, const Range1D &var_dep, const Range1D &var_indep, const VectorSpace::space_ptr_t &space_c, const mat_nonsing_fcty_ptr_t &factory_C, const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S, const mat_fcty_ptr_t &factory_D=Teuchos::null)
 Calls this->initialize() More...
 
void initialize (const VectorSpace::space_ptr_t &space_x, const Range1D &var_dep, const Range1D &var_indep, const VectorSpace::space_ptr_t &space_c, const mat_nonsing_fcty_ptr_t &factory_C, const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S, const mat_fcty_ptr_t &factory_D=Teuchos::null)
 Initialize. More...
 
virtual void set_uninitialized ()
 Set uninitialized. More...
 
const VectorSpace::space_ptr_tspace_x () const
 
const VectorSpace::space_ptr_tspace_c () const
 
virtual void update_D (const MatrixOpNonsing &C, const MatrixOp &N, MatrixOp *D, EMatRelations mat_rel) const
 Overridden by subclasses to update D if a specialized implementation is needed. More...
 
const mat_nonsing_fcty_ptr_t factory_C () const
 
const mat_fcty_ptr_t factory_D () const
 
Range1D var_dep () const
 
Range1D var_indep () const
 
void update_basis (const MatrixOp &Gc, MatrixOpNonsing *C, MatrixOp *D, MatrixOp *GcUP, EMatRelations mat_rel, std::ostream *out) const
 
- Public Member Functions inherited from AbstractLinAlgPack::BasisSystem
 BasisSystem (const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S)
 Required constructor (calls initialize()). More...
 
virtual void initialize (const mat_sym_fcty_ptr_t &factory_transDtD, const mat_sym_nonsing_fcty_ptr_t &factory_S)
 Initialize the factory objects for the special matrices for D'*D and S = I + D'*D. More...
 
virtual ~BasisSystem ()
 
virtual const mat_fcty_ptr_t factory_GcUP () const
 Return a matrix factory object for auxiliary sensitivity matrix GcUP = Gc(var_indep,equ_undecomp)' + Gc(var_dep,equ_undecomp)'*D. More...
 
virtual const mat_sym_fcty_ptr_t factory_transDtD () const
 Returns a matrix factory for the result of J = D'*D More...
 
virtual const
mat_sym_nonsing_fcty_ptr_t 
factory_S () const
 Returns a matrix factory for the result of S = I + D'*D More...
 
virtual Range1D equ_decomp () const
 Range of decomposed general equality constraints. More...
 
virtual Range1D equ_undecomp () const
 Range of undecomposed general equality constriants. More...
 

Private Member Functions

 ExampleBasisSystem ()
 

Overridden from BasisSystemComposite

void update_D (const MatrixOpNonsing &C, const MatrixOp &N, MatrixOp *D, EMatRelations mat_rel) const
 

Detailed Description

Subclass of BasisSystem for example NLP.

ToDo: Finish documentation!

Definition at line 54 of file NLPInterfacePack_ExampleBasisSystem.hpp.

Constructor & Destructor Documentation

NLPInterfacePack::ExampleBasisSystem::ExampleBasisSystem ( const VectorSpace::space_ptr_t &  space_x,
const Range1D &  var_dep,
const Range1D &  var_indep 
)

Calls this->initialize()

Definition at line 52 of file NLPInterfacePack_ExampleBasisSystem.cpp.

NLPInterfacePack::ExampleBasisSystem::ExampleBasisSystem ( )
private

Member Function Documentation

void NLPInterfacePack::ExampleBasisSystem::initialize ( const VectorSpace::space_ptr_t &  space_x,
const Range1D &  var_dep,
const Range1D &  var_indep 
)

Initialize given the vector space for the dependent and independent variables.

Parameters
space_x[in]
var_dep[in]
var_indep[in]

ToDo: Finish documentation!

Definition at line 73 of file NLPInterfacePack_ExampleBasisSystem.cpp.

void NLPInterfacePack::ExampleBasisSystem::update_D ( const MatrixOpNonsing &  C,
const MatrixOp &  N,
MatrixOp *  D,
EMatRelations  mat_rel 
) const

Definition at line 96 of file NLPInterfacePack_ExampleBasisSystem.cpp.


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