Scenario
Solving Scenario
Constructors
- Scenario(name )
 - Scenario(name ,pilots ,adaptive ,parametricDistribution ,HVFilename ,HVFormula )
 
Fields Summary
- Field
 - Description
 - adaptive
 - Adaptive solver management
 - computationTime
 - CPU computation time
 - computedStepNumber
 - Computed steps number
 - HVFilename
 - HVFormula
 - Formula
 - name
 - Solving scenario name
 - parametricDistribution
 - Enumeration
 - pilots
 - saveTime
 - solveTime
 
Methods Summary
- Method
 - Description
 - addPilot
 - Add a parameter pilot
 - clone
 - Clone the scenario with a new name
 - closeSessionMultiPhysics
 - Close a multi-physics session
 - continueToSolve
 - Continue to solve a scenario
 - deleteAllResults
 - Delete all results of a scenario
 - deleteResults
 - Delete results of a scenario
 - iterateOnOneStep
 - Iterate on one step of a scenario
 - openSessionMultiPhysics
 - Open a multi physic session (existing scenario)
 - partialStorage
 - Partial storage
 - removePilot
 - Supprimer un paramètre piloté
 - setInvisiblePositions
 - Modify visibility of positions associated to free mechanical set pilot
 - setVisiblePositions
 - Modify visibility of positions associated to free mechanical set pilot
 - solve
 - Solve
 
Fields Details
- adaptive
 - adaptive : Adaptive solver management - [0..1] AdaptiveSolverManager
 - computationTime
 - computationTime : CPU computation time - [1..1] Double
 - computedStepNumber
 - computedStepNumber : Computed steps number - [1..1] Integer
 - HVFilename
 - HVFilename : HyperView - [0..1] String
 - HVFormula
 - HVFormula : Formula - [0..N] Physic Formula <String>
 - name
 - name : Solving scenario name - [1..1] String
 - parametricDistribution
 - 
                  
parametricDistribution - [0..1] Enumeration
Potential values :
- no
 - yes
 
 - pilots
 - pilots : Evolution pilots - [0..N] EvolutionPilot
 - saveTime
 - saveTime : Temps de sauvegarde pdt la résolution - [1..1] Double
 - solveTime
 - solveTime : Temps de résolution hors sauvegarde pdt la résolution - [1..1] Double
 
Method Details
- addPilot
 - 
                  
- 
                        
Syntax
addPilot(pilot)
 - 
                        
Parameters
- pilot : Le pilote associé à un paramètre - [1..1] EvolutionPilot
 
 - 
                        
Returns
No return value
 
 - 
                        
 - clone
 - 
                  
- 
                        
Syntax
result = clone(name)
 - 
                        
Parameters
- name : New scenario name - [1..1] String
 
 - 
                        
Returns
- clone Enumeration : Cloned scenario instance - [1..1] Scenario
 
 
 - 
                        
 - closeSessionMultiPhysics
 - 
                  
- 
                        
Syntax
closeSessionMultiPhysics()
 - 
                        
Parameters
No parameter
 - 
                        
Returns
No return value
 
 - 
                        
 - continueToSolve
 - 
                  
- 
                        
Syntax
continueToSolve(projectName, option, parameterSet, distributed)
 - 
                        
Parameters
- projectName : Name of the project to save during solving process - [1..1] String
 - option : Option 'IterateOnNonConvergentSteps', 'DoNotIterateOnNonConvergentSteps' or 'IterateOnOneStep' - [0..1] String
 - parameterSet : Step (example : 'Param1=0.3','Param2=1.7') - [0..N] String
 - distributed : Distributed number - [0..1] Integer
 
 - 
                        
Returns
No return value
 
 - 
                        
 - deleteAllResults
 - 
                  
- 
                        
Syntax
deleteAllResults()
 - 
                        
Parameters
No parameter
 - 
                        
Returns
No return value
 
 - 
                        
 - deleteResults
 - 
                  
- 
                        
Syntax
deleteResults(parameterSet)
 - 
                        
Parameters
- parameterSet : Parameter Values - [0..N] String
 
 - 
                        
Returns
No return value
 
 - 
                        
 - iterateOnOneStep
 - 
                  
- 
                        
Syntax
iterateOnOneStep(projectName, parameterSet)
 - 
                        
Parameters
- projectName : Name of the project to save during solving process - [1..1] String
 - parameterSet : Step (example : 'Param1=0.3','Param2=1.7') - [0..N] String
 
 - 
                        
Returns
No return value
 
 - 
                        
 - openSessionMultiPhysics
 - 
                  
- 
                        
Syntax
openSessionMultiPhysics(projectName)
 - 
                        
Parameters
- projectName : Name of the project - [1..1] String
 
 - 
                        
Returns
No return value
 
 - 
                        
 - partialStorage
 - 
                  
- 
                        
Syntax
partialStorage()
 - 
                        
Parameters
No parameter
 - 
                        
Returns
No return value
 
 - 
                        
 - removePilot
 - 
                  
- 
                        
Syntax
removePilot(parameter)
 - 
                        
Parameters
- parameter : Name of the piloted parameter - [1..1] VariationParameter
 
 - 
                        
Returns
No return value
 
 - 
                        
 - setInvisiblePositions
 - 
                  
- 
                        
Syntax
setInvisiblePositions()
 - 
                        
Parameters
No parameter
 - 
                        
Returns
No return value
 
 - 
                        
 - setVisiblePositions
 - 
                  
- 
                        
Syntax
setVisiblePositions()
 - 
                        
Parameters
No parameter
 - 
                        
Returns
No return value
 
 - 
                        
 - solve
 - 
                  
- 
                        
Syntax
solve(projectName)
 - 
                        
Parameters
- projectName : Name of the project to save during solving process - [1..1] String
 
 - 
                        
Returns
No return value
 
 -