CppAD::cg::DaeIndexReduction< Base > Class Template Reference

Inheritance diagram for CppAD::cg::DaeIndexReduction< Base >:

Collaboration diagram for CppAD::cg::DaeIndexReduction< Base >:

Public Member Functions
	DaeIndexReduction (ADFun< CG< Base > > &fun)
ADFun< CG< Base > > &	getOriginalModel () const
virtual std::unique_ptr< ADFun< CG< Base > > >	reduceIndex (std::vector< DaeVarInfo > &newVarInfo, std::vector< DaeEquationInfo > &equationInfo)=0
std::ostream &	log () const
void	setLog (std::ostream &out)
void	setVerbosity (Verbosity verbosity)
Verbosity	getVerbosity () const

Protected Attributes
ADFun< CG< Base > > *const	fun_
Verbosity	verbosity_
std::ostream *	log_

Detailed Description

template<class Base>
class CppAD::cg::DaeIndexReduction< Base >

Base class for algorithms that perform automatic index reduction of implicit DAEs.

Definition at line 31 of file dae_index_reduction.hpp.

Constructor & Destructor Documentation

DaeIndexReduction()

template<class Base >

CppAD::cg::DaeIndexReduction< Base >::DaeIndexReduction ( ADFun< CG< Base > > &  fun )

inline

Creates a new algorithm for index reduction of DAE systems.

Parameters

fun	The original model (potentially high index)

Definition at line 44 of file dae_index_reduction.hpp.

Member Function Documentation

getOriginalModel()

template<class Base >

ADFun<CG<Base> >& CppAD::cg::DaeIndexReduction< Base >::getOriginalModel ( ) const

inline

Provides the original model with a representation of an implicit DAE (potentially high index).

Definition at line 55 of file dae_index_reduction.hpp.

reduceIndex()

template<class Base >

virtual std::unique_ptr<ADFun<CG<Base> > > CppAD::cg::DaeIndexReduction< Base >::reduceIndex ( std::vector< DaeVarInfo > &  newVarInfo, std::vector< DaeEquationInfo > &  equationInfo  )

pure virtual

Performs the DAE index reduction and creates a new reduced index model.

Parameters

newVarInfo	Variable related information of the reduced index model
equationInfo	Equation related information of the reduced index model

Returns

the reduced index model (null if there was no need for index reduction)

Implemented in CppAD::cg::DummyDerivatives< Base >, CppAD::cg::SoaresSecchi< Base >, and CppAD::cg::Pantelides< Base >.

Referenced by CppAD::cg::DaeIndexReduction< Base >::getOriginalModel(), and CppAD::cg::DummyDerivatives< Base >::reduceIndex().

Member Data Documentation

fun_

template<class Base >

ADFun<CG<Base> >* const CppAD::cg::DaeIndexReduction< Base >::fun_

protected

The original model representing an implicit DAE system

Definition at line 36 of file dae_index_reduction.hpp.

Referenced by CppAD::cg::DaeIndexReduction< Base >::getOriginalModel().

---

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

• include/cppad/cg/dae_index_reduction/dae_index_reduction.hpp