Results

ResultsObject:

getNodeTable()

Gets a list of node IDs in the order in which they are returned by list methods.

Returns:: List of node IDs
Return type:: int

getElementTable(CommonArgEntityType)

Gets a list of element IDs for a given entity type in the order in which they are returned by list methods.

Parameters:: CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
Returns:: List of element IDs
Return type:: int

getSolidSectionTable()

Gets a list of solid section IDs for a given entity type in the order in which they are returned by list methods.

Returns:: List of solid section IDs
Return type:: int

getSolidSectionIPTable()

Gets a list of solid section IP IDs for a given entity type in the order in which they are returned by list methods.

Returns:: List of solid section IP IDs
Return type:: int

hasEndResults(CommonArgResultType, CommonArgEntityType)

Check if a result exists.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

True if the result exists, false otherwise

Return type:

bool

eraseEndResults(CommonArgResultType, CommonArgEntityType)

Erase a result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

True if the result exists, false otherwise

Return type:

bool

getEndResults(CommonArgResultType, CommonArgEntityType)

Gets a list of end results.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

List of end results

Return type:

Double

hasSolidSectionResults(CommonArgResultType)

Check if a solid section result exists.

Parameters:: CommonArgResultType (str) – Result type
Returns:: True if the result exists, false otherwise
Return type:: bool

eraseSolidSectionResults(CommonArgResultType)

Erase a solid section result.

Parameters:: CommonArgResultType (str) – Result type
Returns:: True if the result exists, false otherwise
Return type:: bool

getSolidSectionResults(CommonArgResultType)

Gets a list of solid section results.

Parameters:: CommonArgResultType (str) – Result type
Returns:: List of solid section results
Return type:: Double

hasNodeResults(CommonArgResultType)

Check if a node result exists.

Parameters:: CommonArgResultType (str) – Result type
Returns:: True if the result exists, false otherwise
Return type:: bool

eraseNodeResults(CommonArgResultType)

Erase a node result.

Parameters:: CommonArgResultType (str) – Result type
Returns:: True if the result exists, false otherwise
Return type:: bool

getNodeResults(CommonArgResultType)

Gets a list of nodes results.

Parameters:: CommonArgResultType (str) – Result type
Returns:: List of nodes results
Return type:: Double

addNodeResult(CommonArgResultType, CommonArgUnit, CommonArgNewResults)

Defines new user nodal result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

setNodeResult(CommonArgResultType, CommonArgUnit, CommonArgNewResults)

Changes values of an existing node result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

hasElementResults(CommonArgResultType, CommonArgEntityType)

Check if a element result exists.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

True if the result exists, false otherwise

Return type:

bool

eraseElementResults(CommonArgResultType, CommonArgEntityType)

Erase a element result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

True if the result exists, false otherwise

Return type:

bool

getElementResults(CommonArgResultType, CommonArgEntityType)

Gets a list of elements results.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }

Returns:

Gets a list of elements results

Return type:

Double

addElementResult(CommonArgResultType, CommonArgEntityType, CommonArgUnit, CommonArgNewResults)

Defines new user element result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

setElementResult(CommonArgResultType, CommonArgEntityType, CommonArgUnit, CommonArgNewResults)

Changes values of an existing element result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

getSolidSectionResult(CommonArgOutResult, CommonArgResultType, getSolidSectionResultArgNumber)

Gets the i-solid section result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
getSolidSectionResultArgNumber (int) – The solid section number

getSolidSectionResult_Return(CommonArgResultType, getSolidSectionResultArgNumber)

Gets the i-solid section result.

Parameters:

CommonArgResultType (str) – Result type
getSolidSectionResultArgNumber (int) – The solid section number

Returns:

Out result value

Return type:

Double

getSolidSectionIPResult(CommonArgOutResult, CommonArgResultType, getSolidSectionResultArgNumber, getSolidSectionResultArgIPNumber)

Gets the i-solid section integration point result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
getSolidSectionResultArgNumber (int) – The solid section number
getSolidSectionResultArgIPNumber (int) – Integration point of solid section

getSolidSectionIPResult_Return(CommonArgResultType, getSolidSectionResultArgNumber, getSolidSectionResultArgIPNumber)

Gets the i-solid section integration point result.

Parameters:

CommonArgResultType (str) – Result type
getSolidSectionResultArgNumber (int) – The solid section number
getSolidSectionResultArgIPNumber (int) – Integration point of solid section

Returns:

Out result value

Return type:

Double

getEndResult(CommonArgOutResult, CommonArgResultType, getEndResultArgElementNumber, getEndResultArgExtremeNumber)

Gets the i-end result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number

getEndResult_Return(CommonArgResultType, getEndResultArgElementNumber, getEndResultArgExtremeNumber)

Gets the i-end result.

Parameters:

CommonArgResultType (str) – Result type
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number

Returns:

Out result value

Return type:

Double

getMaxEndResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getFilterSENamesArg)

Gets the maximum end result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

getMinEndResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getFilterSENamesArg)

Gets the minimum end result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

addEndResult(CommonArgResultType, CommonArgEntityType, CommonArgUnit, CommonArgNewResults)

Defines new user end result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

setEndResult(CommonArgResultType, CommonArgEntityType, CommonArgUnit, CommonArgNewResults)

Changes values of an existing end result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewResults (List) – New list of Doubles with results

setEndResultOnElement(CommonArgResultType, CommonArgEntityType, CommonArgElementID, CommonArgEndID, CommonArgUnit, CommonArgNewValue)

Changes values of an existing end result in the selected element.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgElementID (str) – Element ID
CommonArgEndID (int) – End ID
CommonArgUnit (int) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNewValue (Double) – New result value

setElementResultOnElement(CommonArgResultType, CommonArgEntityType, CommonArgUnit, CommonArgElementID, CommonArgEndID, CommonArgIPID, CommonArgNewValue)

Changes values of an existing element result in the selected element.

Parameters:

CommonArgResultType (str) – Result type
CommonArgEntityType (str) – Type of entity { Truss, Beam, Shell, Solid }
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgElementID (int) – Element ID
CommonArgEndID (int) – End ID
CommonArgIPID (int) – Integration point ID
CommonArgNewValue (Double) – New result value

setNodeResultOnNode(CommonArgResultType, CommonArgUnit, CommonArgNodeID, CommonArgNewValue)

Changes values of an existing node result in the selected node.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgNodeID (int) – Node ID
CommonArgNewValue (Double) – New result value

getEndResult_UserUnit(CommonArgOutResult, CommonArgResultType, CommonArgUnit, getEndResultArgElementNumber, getEndResultArgExtremeNumber)

Gets the i-end result in the specified unit.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number

getEndResult_UserUnit_Return(CommonArgResultType, CommonArgUnit, getEndResultArgElementNumber, getEndResultArgExtremeNumber)

Gets the i-end result in the specified unit.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number

Returns:

Out result value

Return type:

Double

getNodeResult(CommonArgOutResult, CommonArgResultType, getNodeResultArgNodeNumber)

Gets the i-node result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
getNodeResultArgNodeNumber (int) – Node number

getNodeResult_UserUnit(CommonArgOutResult, CommonArgResultType, CommonArgUnit, getNodeResultArgNodeNumber)

Gets the i-node result in the specified unit.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getNodeResultArgNodeNumber (int) – Node number

getNodeResult_Return(CommonArgResultType, getNodeResultArgNodeNumber)

Gets the i-node result.

Parameters:

CommonArgResultType (str) – Result type
getNodeResultArgNodeNumber (int) – Node number

Returns:

Out result value

Return type:

Double

getNodeResult_UserUnit_Return(CommonArgResultType, CommonArgUnit, getNodeResultArgNodeNumber)

Gets the i-node result in the specified unit.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getNodeResultArgNodeNumber (int) – Node number

Returns:

Out result value

Return type:

Double

getMaxNodeResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, CommonArgOutNodeNumber, getFilterSENamesArg)

Gets the maximum node result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
CommonArgOutNodeNumber (int) – Out node number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

getMinNodeResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, CommonArgOutNodeNumber, getFilterSENamesArg)

Gets the minimum node result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
CommonArgOutNodeNumber (int) – Out node number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

getElementResult(CommonArgOutResult, CommonArgResultType, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getElementResultArgIP)

Gets the i-element result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getElementResultArgIP (int) – Integration point id

getElementResult_UserUnit(CommonArgOutResult, CommonArgResultType, CommonArgUnit, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getElementResultArgIP)

Gets the i-element result in the specified unit.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getElementResultArgIP (int) – Integration point id

getElementResult_Return(CommonArgResultType, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getElementResultArgIP)

Gets the i-element result.

Parameters:

CommonArgResultType (str) – Result type
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getElementResultArgIP (int) – Integration point id

Returns:

Out result value

Return type:

Double

getElementResult_UserUnit_Return(CommonArgResultType, CommonArgUnit, getEndResultArgElementNumber, getEndResultArgExtremeNumber, getElementResultArgIP)

Gets the i-element result in the specified unit.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
getEndResultArgElementNumber (int) – The element number
getEndResultArgExtremeNumber (int) – End number
getElementResultArgIP (int) – Integration point id

Returns:

Out result value

Return type:

Double

getMaxElementResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, CommonArgOutElementNumber, CommonArgOutEndNumber, CommonArgOutIPNumber, getFilterSENamesArg)

Gets the maximum element result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
CommonArgOutElementNumber (int) – Out element number
CommonArgOutEndNumber (int) – Out end number
CommonArgOutIPNumber (int) – Out integration point number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

getMinElementResult(CommonArgResultType, CommonArgUnit, CommonArgOutResult, CommonArgOutElementNumber, CommonArgOutEndNumber, CommonArgOutIPNumber, getFilterSENamesArg)

Gets the minimum element result.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit
CommonArgOutResult (Double) – Out result value
CommonArgOutElementNumber (int) – Out element number
CommonArgOutEndNumber (int) – Out end number
CommonArgOutIPNumber (int) – Out integration point number
getFilterSENamesArg (str) – List of names of the structural elements to which to apply a filter. Leave the list empty to apply to the entire model

getHeaderResult(CommonArgOutResult, CommonArgResultType)

Gets the header result.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type

getHeaderResult_UserUnit(CommonArgOutResult, CommonArgResultType, CommonArgUnit)

Gets the header result in the specified unit.

Parameters:

CommonArgOutResult (Double) – Out result value
CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit

getHeaderResult_Return(CommonArgResultType)

Gets the header result.

Parameters:: CommonArgResultType (str) – Result type
Returns:: Out result value
Return type:: Double

getHeaderResult_UserUnit_Return(CommonArgResultType, CommonArgUnit)

Gets the header result in the specified unit.

Parameters:

CommonArgResultType (str) – Result type
CommonArgUnit (str) – Result unit, if result unit is not indicated the result will have the document unit

Returns:

Out result value

Return type:

Double

Combinations:

addCombination(CombName)

Add Combination to the model by giving the name.

Parameters:: CombName (str) – Name of the combination

getCombination(): Get a list of combinations to the model.

createCombination(CombPath)

Create and save a new results combinations.

Parameters:: CombPath (str) – Path with name and extension .rcf of de combination file

saveUserCombination(UserPath)

Save user combination.

Parameters:: UserPath (str) – Path with name and extension .uccf of de user combination file

loadUserCombination(UserPath)

Load an existing user combination.

Parameters:: UserPath (str) – Path with name and extension .uccf of de user combination file

removeCombination(CombName)

Remove a combination from a user combination.

Parameters:: CombName (str) – Name of the combination

updateLoadedResults(): Remove a combination from a user combination.

LoadedResults

Loaded Files.

Type:: List

Combination

Combination.

Type:: List

DerivedResults:

createDerivedResults(ResPath)

Create and save new derived results.

Parameters:: ResPath (str) – Path with name and extension .rcf of the result file

addFiles(SynName, ResPath)

Add files to the model by giving the name and the path.

Parameters:

SynName (str) – Name of the new results files
ResPath (str) – Path with name and extension .rcf of the result file

ModifiedFiles

Modified files.

Type:: List

HistoryResults:

createVariable()

Create a new variable to show for the history results.

Returns:: Index of the created variable inside the list
Return type:: int

copyVariable(Row)

Create a new variable copying the one with the given index.

Parameters:: Row (int) – Row or variable index to use

deleteVariable(Row)

Erase a variable given its index, all index are invalidated because the order can change.

Parameters:: Row (int) – Row or variable index to use

setSolidSection(Row, NewValue)

Modify the solid section Id of a variable.

Parameters:

Row (int) – Row or variable index to use
NewValue (int) – New value to assign

setNode(Row, NewValue)

Modify the node of a variable.

Parameters:

Row (int) – Row or variable index to use
NewValue (int) – New value to assign

setElement(Row, NewValue)

Modify the element of a variable.

Parameters:

Row (int) – Row or variable index to use
NewValue (int) – New value to assign

setEnd(Row, NewValue)

Modify the end of a variable.

Parameters:

Row (int) – Row or variable index to use
NewValue (int) – New value to assign

setIP(Row, NewValue)

Modify a variable IP.

Parameters:

Row (int) – Row or variable index to use
NewValue (int) – New value to assign

setIPMaximum(Row)

Set to choose maximum IP result from every element.

Parameters:: Row (int) – Row or variable index to use

setIPMinimum(Row)

Set to choose minimum IP result from every element.

Parameters:: Row (int) – Row or variable index to use

setName(Row, NewValue)

Modify the name of a variable.

Parameters:

Row (int) – Row or variable index to use
NewValue (str) – New value to assign

setResultUnit(Row, Unit)

Change the type of unit of a variable.

Parameters:

Row (int) – Row or variable index to use
Unit (str) – Unit to use

getNode(Row)

Get the node of a variable.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: int

getElement(Row)

Get the element of a variable.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: int

getEnd(Row)

Get the end of a variable.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: int

getIP(Row)

Get a variable IP.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: int

getName(Row)

Get the name of a variable.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: str

getIsXAxis(Row)

Get if a variable is the X-Axis for the plot.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: bool

getResultType(ResultFile)

Get the type of result.

Parameters:: ResultFile (int) – Result file to add
Returns:
Return type:: Enumerate

getResult(Row)

Get the name of result.

Parameters:: Row (int) – Row or variable index to use
Returns:
Return type:: Enumerate

clearAll(): Clear result files and variables from this object.

orderResultsByTInc(): Order results by time increment.

chooseResult(Result, ResultEntityType)

Result:: Loaded result

Constraints: User interface, Results loaded

Parameters:

Result (str) – Specific type of result (see list of enumerated results).
ResultEntityType (str) – Result entity type to resolve possible ambiguities {Nodal,Truss,Beam,Shell,Solid}.

chooseResultsFile(FileName)

File:: Loaded results file

Constraints: User interface

Parameters:: FileName (Path) – File name of the results file (rcf or crcf extensions).

chooseResultType(ResultType)

Result type:: Type of available results

Constraints: User interface, Results loaded

Parameters:: Enumerate – { DisplacementsAndRotations, Reactions, Contacts, VelocitiesAndAccelerations, Stresses, Strain, ForcesAndMoments, Others } ResultType: Result type.

chooseResultUnits(ResultUnits)

Units: Unit for results

Constraints: User interface, Results loaded

Parameters:: ResultUnits (str) – Result units.

getResults(FileName)

Create a Results object to store results info that can be retrieve from the object

Parameters:: FileName (str) – File name of the results file (rcf or crcf extensions).
Return type:: Results object

loadResultsFile(FileName)

Adds a results file to the results loader

Constraints: User interface

Parameters:: FileName (Path) – File name of the results file (rcf or crcf extensions).

openResultsFile(FileName)

Load file: Load a results file

Constraints: User interface

Parameters:: FileName (Path) – File name of the results file (rcf or crcf extensions).

setResult(ResultType, Result)

Modify result combo boxes of the user interface

Constraints: User interface, Results loaded

Parameters:

ResultType (str) – Result type.
Result (str) – Specific type of result (see list of enumerated results).

setResult(ResultType, Result, ResultUnits)

Modify result combo boxes of the user interface

Constraints: User interface, Results loaded

Parameters:

ResultType (str) – Result type.
Result (str) – Specific type of result (see list of enumerated results).
ResultUnits (str) – Result units.

setResult(ResultType, Result, ResultEntityType, ResultUnits)

Modify result combo boxes of the user interface

Constraints: User interface, Results loaded

Parameters:

ResultType (str) – Result type.
Result (str) – Specific type of result (see list of enumerated results).
ResultEntityType (str) – Result entity type to resolve possible ambiguities {Nodal,Truss,Beam,Shell,Solid}.
ResultUnits (str) – Result units.