IDianaDAESO Class Reference

#include <IDianaDAESO.hpp>

Inheritance diagram for IDianaDAESO:

List of all members.

Public Member Functions
virtual	~IDianaDAESO ()
virtual DIANA_DAESO_CLONERET *	clone ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
virtual void	SaveState (const Common::Types::CapeString &filename)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual void	LoadState (const Common::Types::CapeString &filename)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual void	LoadStateDiva (const Common::Types::CapeString &states, const Common::Types::CapeString &params, const Common::Types::CapeString &mapfile=Common::Types::CapeString())=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument)
virtual Common::Collection::ICapeCollection *	GetStateVariables ()=0 throw (Common::Error::ECapeUnknown)
virtual Common::Collection::ICapeCollection *	GetRealParameters ()=0 throw (Common::Error::ECapeUnknown)
virtual void	SetAllRealParameters (const Common::Types::CapeArrayDouble &varValues)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual void	SetRealParameters (const Common::Types::CapeArrayLong &varIndices, const Common::Types::CapeArrayDouble &varValues)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual const Common::Types::CapeArrayDouble &	GetAllRealParameters ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder)
virtual Common::Types::CapeArrayDouble	GetRealParameters (const Common::Types::CapeArrayLong &varIndices)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds)
virtual const Diana::DianaSparseArray &	GetHighOrderJacobian (Common::Types::CapeLong nXOrder, Common::Types::CapeLong nDOrder, Common::Types::CapeLong nPOrder)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
virtual CapeArrayDouble	GetAbsoluteError () const =0 throw (Common::Error::ECapeUnknown)
virtual const Common::Types::CapeArrayDouble &	GetAllPhiValues ()=0 throw (Common::Error::ECapeUnknown)
virtual Common::Types::CapeDouble	GetPhiValue (CapeLong index)=0 throw (Common::Error::ECapeUnknown)
virtual Diana::IDianaPetriNet *	GetPetriNet ()=0 throw (Common::Error::ECapeUnknown)
virtual void	BeforeStep (Diana::IDianaNumericDAESolver *solver)=0 throw (Common::Error::ECapeUnknown)
virtual void	AfterStep (Diana::IDianaNumericDAESolver *solver)=0 throw (Common::Error::ECapeUnknown)
virtual const DianaSparseArray &	GetAllParJacobianValues (const Common::Types::CapeArrayLong &parIndices)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
virtual const DianaSparseArray &	GetAllParJacobianValues (const Common::Types::CapeArrayLong *const parIndices=NULL)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeNoImpl)
Friends
std::ostream &	operator<< (std::ostream &out_file, const IDianaDAESO &eso)

---

Detailed Description

Diana extension of the CapeOpen ICapeNumericDAESO interface.

---

Constructor & Destructor Documentation

virtual ~IDianaDAESO

(

)

[inline, virtual]

Virtual default destructor.

---

Member Function Documentation

virtual void AfterStep

(

Diana::IDianaNumericDAESolver *

solver

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Method is called by solver after every step of integration. It should check Petri net for possible transition and make switch if it takes place.

Implemented in DianaDAESO.

virtual void BeforeStep

(

Diana::IDianaNumericDAESolver *

solver

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Method is called by solver before every step of integration. Implementation should save state variables, derivatives, phi-functions and time of previous step before the next step of integration is taken. Used in hybrid models

Implemented in DianaDAESO.

virtual DIANA_DAESO_CLONERET* clone

(

)

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

cloning operation, returns a freshly allocated ESO, owned by the caller

Reimplemented from ICapeIdentification.

Implemented in DianaDAESO.

virtual const Common::Types::CapeArrayDouble& GetAllPhiValues

(

)

throw (Common::Error::ECapeUnknown) [pure virtual]

All PhiFunctions of the model

Implemented in DianaDAESO.

virtual const Common::Types::CapeArrayDouble& GetAllRealParameters

(

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual]

Gets the value of all real parameters.

Implemented in DianaDAESO.

virtual Diana::IDianaPetriNet* GetPetriNet

(

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Returns Petri net for hybrid model.

Implemented in DianaDAESO.

virtual Common::Types::CapeDouble GetPhiValue

(

CapeLong

index

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Returns value of phi-function by its index.

Implemented in DianaDAESO.

virtual Common::Collection::ICapeCollection* GetRealParameters

(

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Returns a collection with a real parameters of the model, generated by promot. Order of the real parameters in the collection is the same as result of function GetAllRealParameters, which returns a vector instead of collection.

Implemented in DianaDAESO.

Referenced by DianaContinuation::DianaContinuation().

virtual Common::Types::CapeArrayDouble GetRealParameters

(

const Common::Types::CapeArrayLong &

varIndices

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Gets the value of a subset of the real parameters.

Parameters:

varIndices

the indices of the parameters we wish to get.

Implemented in DianaDAESO.

virtual Common::Collection::ICapeCollection* GetStateVariables

(

)

throw (Common::Error::ECapeUnknown) [pure virtual]

Returns a collection with a state variables of the model. Order of the state variables in the collection is the same as result of function GetAllVariables, which returns a vector instead of collection.

Implemented in DianaDAESO.

virtual void SetAllRealParameters

(

const Common::Types::CapeArrayDouble &

varValues

)

throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Sets the value of all real parameters of this ESO.

Parameters:

varValues

the values of all the parameters we wish to set

Implemented in DianaDAESO.

virtual void SetRealParameters	(	const Common::Types::CapeArrayLong &	varIndices,
		const Common::Types::CapeArrayDouble &	varValues
	)		throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeOutOfBounds) [pure virtual]

Sets the value of some parameters.

Parameters:

varIndices	the indices of the parameters we wish to set
varValues	the values of all the parameters we wish to set

Implemented in DianaDAESO.

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	out_file,
		const IDianaDAESO &	eso
	)		[friend]

ostream output operator for the IDianaDAESO class.

---

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

• IDianaDAESO.hpp