#include <CapeModel.hpp>
Public Member Functions | |
| virtual Common::Types::CapeLong | SetVariablesIndex (Common::Types::CapeArrayLong varIndices)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds, Common::Error::ECapeNoImpl) |
| virtual void | SetActiveESO (Eso::ICapeNumericESO *theActiveESO)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeSolvingError, Common::Error::ECapeBadInvOrder) |
| virtual Eso::ICapeNumericESO * | GetActiveESO ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) |
| virtual void | SetCommonESO (Eso::ICapeNumericESO *anESO)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) |
| virtual Eso::ICapeNumericESO * | GetCommonESO ()=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl) |
| virtual ICapeNumericExternalEventInfo * | AddExternalEvent (ICapeNumericEvent *anEvent)=0 throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl) |
Friends | |
| std::ostream & | operator<< (std::ostream &out_file, const ICapeNumericModel &model) |
Detailed Description
The Model object embodies the general mathematical description of a physical system.
Member Function Documentation
| virtual ICapeNumericExternalEventInfo* AddExternalEvent | ( | ICapeNumericEvent * | anEvent | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl) [pure virtual] |
Adds an Event to the list of the already defined External Events for this Model.
- Parameters:
-
anEvent the event to be added to the list
Implemented in DianaContinuousModel.
| virtual Eso::ICapeNumericESO* GetActiveESO | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder) [pure virtual] |
Gets the global active ESO which is the current one.
Implemented in DianaContinuousModel.
Referenced by DianaContinuation::DianaContinuation().
| virtual Eso::ICapeNumericESO* GetCommonESO | ( | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeBadInvOrder, Common::Error::ECapeNoImpl) [pure virtual] |
Gets the common or specific ESO of this particular model.
Implemented in DianaContinuousModel.
| virtual void SetActiveESO | ( | Eso::ICapeNumericESO * | theActiveESO | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeSolvingError, Common::Error::ECapeBadInvOrder) [pure virtual] |
Sets the global ESO which is the current one depending of all the active states in the STN and all the common or specific ESOs. This needs to be done for the top level Model only. Currently not implemented.
Implemented in DianaContinuousModel.
| virtual void SetCommonESO | ( | Eso::ICapeNumericESO * | anESO | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeNoImpl) [pure virtual] |
Assigns the common or specific ESO to this particular model. Currently not implemented.
Implemented in DianaContinuousModel.
| virtual Common::Types::CapeLong SetVariablesIndex | ( | Common::Types::CapeArrayLong | varIndices | ) | throw (Common::Error::ECapeUnknown, Common::Error::ECapeInvalidArgument, Common::Error::ECapeOutOfBounds, Common::Error::ECapeNoImpl) [pure virtual] |
Sets the general indices of the variables in this Model to establish the mapping between the list of variable in the ESO and the list of the Physical Variables. This is one way (a choice) for establishing the mapping, another way would be to reference the Physical Variables object in the Model directly.
- Parameters:
-
varIndices the set of general indices for all the variables
Implemented in DianaContinuousModel.
Friends And Related Function Documentation
| std::ostream& operator<< | ( | std::ostream & | out_file, |
| const ICapeNumericModel & | model | ||
| ) | [friend] |
ostream output operator for the ICapeNumericModel class.
The documentation for this class was generated from the following file:
