BuildingTcl -- addAnalysisModel: Difference between revisions

Latest revision as of 01:08, 29 December 2009

Commands

addAnalysisModelData AnalysisModelLabel $AnalysisModelLabel

addAnalysisModelData AnalysisTypeLabel $AnalysisTypeLabel

addAnalysisModelData $RequiredArgument1Label $RequiredArgument1Value

addAnalysisModelData $RequiredArgument2Label $RequiredArgument2Value

…

…

addAnalysisModel

Different AnalysisTypes have different input arguments:

Arguments

$AnalysisModelLabel: Unique Analysis Label for reference

$AnalysisTypeLabel: Specifies which AnalysisType is being used.

$RequiredArgument1Label $RequiredArgument1Value ...: Labels and corresponding values for AnalysisType-specific required argument.

$InputArgument1Label $InputArgument1Value …: Labels and corresponding values for AnalysisType-specific Input Arguments (Optional)

Notes

The addAnalysisModel command must be placed at the end of each Analysis-data definition, as it takes all data defined since the last addAnalysisModel command and define the Analysis.
The addAnalysisModel command is optional because the default AnalysisModels available are sufficient.

Options

Default AnalysisModels

BuildingTcl comes with a set of pre-loaded Default AnalysisModels. This library of AnalysisModels should be sufficient in defining a model.

The following AnalysisModels are available:

DefaultDisplacementHistory: AnalysisModelType: DisplacementHistory
DefaultTimeHistory: AnalysisModelType: TimeHistory
DefaultLoadControl: AnalysisModelType: LoadControl

Examples

BuildingTcl -- addLoad

Return to BuildingTcl Command Language Manual

@@ Line 3: / Line 3: @@
 ==Commands ==
-:addAnalysisData AnalysisLabel $AnalysisLabel
+:addAnalysisModelData AnalysisModelLabel $AnalysisModelLabel
-:addAnalysisData AnalysisModelLabel $AnalysisModelLabel
+:addAnalysisModelData AnalysisTypeLabel $AnalysisTypeLabel
-:addAnalysisData $RequiredArgument1Label $RequiredArgument1Value
+:addAnalysisModelData $RequiredArgument1Label $RequiredArgument1Value
-:addAnalysisData $RequiredArgument2Label $RequiredArgument2Value
+:addAnalysisModelData $RequiredArgument2Label $RequiredArgument2Value
 :…
-:<addAnalysisData $InputArgument1Label $InputArgument1Value>
+:<addAnalysisModelData $InputArgument1Label $InputArgument1Value>
-:<addAnalysisData $InputArgument2Label $InputArgument2Value>
+:<addAnalysisModelData $InputArgument2Label $InputArgument2Value>
 :…
-:'''addAnalysis'''
+:'''addAnalysisModel'''
+Different AnalysisTypes have different input arguments:
+:*[[BuildingTcl -- addAnalysisModel: AnalysisTypeLabel LoadControl]]
+:*[[BuildingTcl -- addAnalysisModel: AnalysisTypeLabel DisplacementHistory]]
+:*[[BuildingTcl -- addAnalysisModel: AnalysisTypeLabel TimeHistory]]
 ==Arguments ==
-*'''$AnalysisLabel''':	Unique Analysis Label for reference
+;$AnalysisModelLabel :	Unique Analysis Label for reference
-*'''$AnalysisModelLabel''':	Specifies which AnalysisModel is being used.
+;$AnalysisTypeLabel :	Specifies which AnalysisType is being used.
-*'''$RequiredArgument1Label $RequiredArgument1Value ...''' :Labels and corresponding values for AnalysisModel-specific required argument.
+;$RequiredArgument1Label $RequiredArgument1Value ... :Labels and corresponding values for AnalysisType-specific required argument.
-*'''$InputArgument1Label $InputArgument1Value …''' :	Labels and corresponding values for AnalysisModel-specific Input Arguments (Optional)
+;$InputArgument1Label $InputArgument1Value … :	Labels and corresponding values for AnalysisType-specific Input Arguments (Optional)
 ==Notes ==
-The addAnalysis command must be placed at the end of each Analysis-data definition, as it takes all data defined since the last addAnalysis command and define the Analysis.
+#The addAnalysisModel command must be placed at the end of each Analysis-data definition, as it takes all data defined since the last addAnalysisModel command and define the Analysis.
+#The addAnalysisModel command is optional because the default AnalysisModels available are sufficient.
+==Options ==
+==Default AnalysisModels==
+BuildingTcl comes with a set of pre-loaded Default AnalysisModels. This library of AnalysisModels should be sufficient in defining a model.
+The following AnalysisModels are available:
+;DefaultDisplacementHistory
+:AnalysisModelType: DisplacementHistory
+;DefaultTimeHistory
+:AnalysisModelType: TimeHistory
+;DefaultLoadControl
+:AnalysisModelType: LoadControl
-==Options ==
-* [[BuildingTcl -- AnalysisModelLabel]]
+== Examples ==
+*[[BuildingTcl -- addAnalysisModel Examples -- Gravity Analyses]]
+*[[BuildingTcl -- addAnalysisModel Examples -- Static Displacement-Controlled Pushover Analyses]]
+*[[BuildingTcl -- addAnalysisModel Examples -- Dynamic Time-History Analyses]]