Tag: Solver

Simulation Thrid party solver connection.

Tree

Mandatory Attributes

Name Description Type Allowed Values
analysis Type of analysis. String
name Name of the object. String
physics Type of physics. String
version Version of the object. Int32

Optional Attributes

Name Description Type Default Value Allowed Values
BeginGroup Indicates whether the load object will have a separator before it when shown in the context menu. Boolean False True, False
caption Caption of the object. String
class Class name of the controller of the object. String
ContextGroup Indicates which group the load will be shown in the context menu. String
contextual Indicates whether the object has to be displayed in the contextual menu. Boolean True True, False
evaluateFunctionLoads Name of the toolbox. Boolean True True, False
icon Icon for the object. String
LazyActivateSelectProperties Determines when onActivate callback is called for the properties. Boolean False True, False
localize Indicates whether the caption and value string need to be localized by the application. Boolean False True, False
toolbox Name of the toolbox. String

Callbacks

Name Description
CanAdd(IDataModelObject, String) Callback that is invoked to determine whether the object can be added.
CanDuplicate(IUserObject, IDataModelObject) Callback that is invoked to determine if the object can be duplicated.
CanRemove(IUserObject) Callback that is invoked to determine if the object can be removed.
GetReader(IUserSolver) Callback that is invoked to get the reader class name and associated options.
GetSteps(IUserSolver) Callback that is invoked to get the list of time steps (or frequencies) that were computed during the solve and are available for the post-processing.
IsAnalysisValid(IUserSolver, Boolean) Callback that is invoked to determine whether the analysis is valid.
IsValid(IUserObject) Callback that is invoked to determine if the object is valid.
OnAdd(IUserObject) Callback that is invoked when the object is newly added.
OnBeforeSolve(IUserSolver) Callback that is invoked before the solve process.
OnCheckResults(IUserSolver) Callback that is invoked before any post-processing evaluation.
OnClearData(IUserObject) Callback that is invoked when object data are cleared.
OnDuplicate(IUserObject) Callback that is invoked when the object is duplicated.
OnHide(IUserObject) Callback that is invoked when the object is hidden.
OnInit(IUserObject) Callback that is invoked when the object is initialized.
OnMigrate(IUserObject, IUserObject) Callback that is invoked when the object version has been changed.
OnRemove(IUserObject) Callback that is invoked when the object is removed.
OnShow(IUserObject) Callback that is invoked when the object is shown.
OnSolve(IUserSolver, Func<Int32, String, Boolean>) Callback that is invoked when the solve process is run.
OnSuppress(IUserObject) Callback that is invoked when the object is suppressed.
OnUnsuppress(IUserObject) Callback that is invoked when the object is unsuppressed.
OnWriteInputFile(IUserSolver, String) Callback that is invoked to write the solver input file.