DiffitESO Class Reference

#include <DiffitModel.hpp>

Inheritance diagram for DiffitESO:

List of all members.

Public Member Functions
	DiffitESO (const Common::Types::CapeString &_name, const Common::Types::CapeString &_description, Common::Types::CapeLong _nVars, Common::Types::CapeLong _nEqns, Common::Types::CapeLong _nRealParams)
	DiffitESO (const DiffitESO &org)
virtual	~DiffitESO ()
void	Initialize () throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder)
const Diana::DianaSparseArray &	GetAllDiffJacobianValues () throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Protected Member Functions
virtual DianaDAESO *	createClone (const DianaDAESO &org)
virtual void	calculateResiduals ()
Protected Attributes
CapeBoolean	bInitialized
CapeBoolean	bSymbolicJacobian

---

Detailed Description

Special ESO for legacy diffit models

---

Constructor & Destructor Documentation

DiffitESO	(	const Common::Types::CapeString &	_name,
		const Common::Types::CapeString &	_description,
		Common::Types::CapeLong	_nVars,
		Common::Types::CapeLong	_nEqns,
		Common::Types::CapeLong	_nRealParams
	)

Constructor. Allocates memory for internal arrays.

DiffitESO

(

const DiffitESO &

org

)

copy ctor

virtual ~DiffitESO

(

)

[virtual]

Destructor. Frees memory.

---

Member Function Documentation

virtual void calculateResiduals

(

)

[protected, virtual]

calculateResiduals updates array pResidualsVector with a values of the

.

Implements DianaDAESO.

Reimplemented in DiffitModel.

virtual DianaDAESO* createClone

(

const DianaDAESO &

original

)

[protected, virtual]

This Method is subclass-dependent. It should internally call the subclass-copy-constructor and return a freshly allocated clone without values. The values for all variables are filled in the clone() method.

Reimplemented from DianaDAESO.

const Diana::DianaSparseArray& GetAllDiffJacobianValues

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl) [virtual]

Since the model is an ODE, the DiffJacobian is a negated Unity

Reimplemented from DianaDAESO.

void Initialize

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeFailedInitialisation, Common::Error::ECapeOutOfResources, Common::Error::ECapeLicenceError, Common::Error::ECapeBadInvOrder) [virtual]

The environment will order the component to get initialized through this method. Any initialisation that could fail must be placed here. Initialize is guaranteed to be the first method called by the client (except low level methods such as class constructors or initialization persistence methods). Initialize has to be called once when the component is instantiated in a particular flowsheet. When the initialization fails, before signalling an error, the component must free all the resources that were allocated before the failure occurred. When the environment receives this error, it may not use the component anymore. The method terminate of the current interface must not either be called. Hence, the environment may only release the component through the middleware native mechanisms.

Reimplemented from DianaDAESO.

Reimplemented in DiffitModel.

---

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

• DiffitModel.hpp