AnalysisSettings

ModalAnalysisSettings

Modal analysis settings high level function

Kind: global class

new ModalAnalysisSettings(no, solverMethod, beyondFrequency, maximalFrequency, comment, params)

Creates modal analysis settings high level function

Returns: Object ModalAnalysisSettings

Param	Type	Description
no	Number	unique ID of modal analysis settings
solverMethod	String	solver method()
beyondFrequency	String	Setting of eigenvectors beyond frequency
maximalFrequency	String	Setting of eigenvectors maximal frequency
comment	String	Comment, empty by default
params	Object	Modal analysis settings parameters, empty by default

Example

// returns 2
globalNS.method1(5, 10);

modalAnalysisSettings.UserDefinedNumberOfModes(no, name, numberOfModes, solverMethod, typeOfMassMatrix, massConversion, actingMasses, comment, params) ⇒

Creates modal analysis settings

Kind: instance method of ModalAnalysisSettings
Returns: Object ModalAnalysisSettings

Param	Type
no	int
name	string
numberOfModes	int
solverMethod	string
typeOfMassMatrix	string
massConversion	string
actingMasses	array
comment	string
params	dictionary

modalAnalysisSettings.AutomaticNumberOfModesToReachEffMass(no, name, effectiveModalMassFactor, solverMethod, typeOfMassMatrix, massConversion, actingMasses, comment, params) ⇒

Kind: instance method of ModalAnalysisSettings
Returns: Object ModalAnalysisSettings

Param	Type
no	*
name	*
effectiveModalMassFactor	*
solverMethod	*
typeOfMassMatrix	*
massConversion	*
actingMasses	*
comment	*
params	*

modalAnalysisSettings.AutomaticNumberOfModesToReachMaxFreq(no, name, maxNaturalFrequency, solverMethod, typeOfMassMatrix, massConversion, actingMasses, comment, params) ⇒

Kind: instance method of ModalAnalysisSettings
Returns: Object ModalAnalysisSettings

Param	Type
no	*
name	*
maxNaturalFrequency	*
solverMethod	*
typeOfMassMatrix	*
massConversion	*
actingMasses	*
comment	*
params	*

SpectralAnalysisSettings

Class for setting up the spectral analysis settings.

Kind: global class
@returns: Object SpectralAnalysisSettings

new SpectralAnalysisSettings(no, name, combinationRulePeriodic, combinationRuleDirectional, scaledSumDirectionalComponentValue, useEquivalentLinearCombination, signedResultsUsingDominantMode, saveResultsOfAllSelectedModes, comment, params)

Constructor creates basic spectral analysis settings

Param	Type
no	*
name	*
combinationRulePeriodic	*
combinationRuleDirectional	*
scaledSumDirectionalComponentValue	*
useEquivalentLinearCombination	*
signedResultsUsingDominantMode	*
saveResultsOfAllSelectedModes	*
comment	*
params	*

spectralAnalysisSettings.SetDampingRuleForCQC(dampingRule, dampingConstantForEachMode)

Kind: instance method of SpectralAnalysisSettings

Param	Type
dampingRule	*
dampingConstantForEachMode	*

spectralAnalysisSettings.IncludeMissingMasses(ruleForMasses, zeroPeriodicAccelerationType, userDefinedValue)

Kind: instance method of SpectralAnalysisSettings

Param	Type
ruleForMasses	*
zeroPeriodicAccelerationType	*
userDefinedValue	*

spectralAnalysisSettings.GetNo() ⇒

Kind: instance method of SpectralAnalysisSettings
Returns: No

StabilityAnalysisSettings

StabilityAnalysisSettings is a class that represents a stability analysis settings.

Kind: global class

new StabilityAnalysisSettings(no, isEigenvalueSolver, isIncremental, eigenvalueMethod, numberOfLowestEigenvalues, comment, params)

Constructor creates a new object of type StabilityAnalysisSettings

Returns: object Stability Analysis Settings

Param	Type
no	*
isEigenvalueSolver	*
isIncremental	*
eigenvalueMethod	*
numberOfLowestEigenvalues	*
comment	*
params	*

StaticAnalysisSettings

Kind: global class

new StaticAnalysisSettings(no, analysisType, equationSolver, nonlinearMethod, comment, params)

Creates static analysis settings high level function

Returns: Static Analysis object

Param	Type	Description
no	Integer	unique ID of SAS
analysisType	String	Analysis setting type ("GEOMETRICALLY_LINEAR", "SECOND_ORDER_P_DELTA", "LARGE_DEFORMATIONS")
equationSolver	String	Equation solver ("METHOD_OF_EQUATION_SYSTEM_DIRECT", "METHOD_OF_EQUATION_SYSTEM_ITERATIVE")
nonlinearMethod	String	Nonlinear method ("NEWTON_RAPHSON", "NEWTON_RAPHSON_COMBINED_WITH_PICARD", "PICARD", "NEWTON_RAPHSON_WITH_POSTCRITICAL_ANALYSIS", "NEWTON_RAPHSON_WITH_CONSTANT_STIFFNESS", "DYNAMIC_RELAXATION" )
comment	String	Comment, empty by default
params	Object	Static analysis settings parameters, empty by default

staticAnalysisSettings.GetNo() ⇒

Kind: instance method of StaticAnalysisSettings
Returns: Number of Static analysis setting

staticAnalysisSettings.GetStaticAnalysisSettings() ⇒

Kind: instance method of StaticAnalysisSettings
Returns: Static analysis settings object

staticAnalysisSettings.GeometricallyLinear(no, name, equationSolver, plateBendingTheory, activeMass, modifyLoading, comment, params) ⇒

Kind: instance method of StaticAnalysisSettings
Returns: Object Static Analysis Settings

Param	Type
no	*
name	*
equationSolver	*
plateBendingTheory	*
activeMass	*
modifyLoading	*
comment	*
params	*

staticAnalysisSettings.SecondOrder(no, name, equationSolver, nonlinearMethod, maxNumberOfIterations, numberOfLoadIncrements, plateBendingTheory, activeMass, modifyLoading, comment, params) ⇒

Kind: instance method of StaticAnalysisSettings
Returns: Object Static Analysis Settings

Param	Type
no	*
name	*
equationSolver	*
nonlinearMethod	*
maxNumberOfIterations	*
numberOfLoadIncrements	*
plateBendingTheory	*
activeMass	*
modifyLoading	*
comment	*
params	*

staticAnalysisSettings.LargeDeformations(no, name, equationSolver, nonlinearMethod, maxNumberOfIterations, numberOfLoadIncrements, percentageOfIterations, plateBendingTheory, activeMass, modifyLoading, comment, params) ⇒

Kind: instance method of StaticAnalysisSettings
Returns: Object Static Analysis Settings

Param	Type
no	*
name	*
equationSolver	*
nonlinearMethod	*
maxNumberOfIterations	*
numberOfLoadIncrements	*
percentageOfIterations	*
plateBendingTheory	*
activeMass	*
modifyLoading	*
comment	*
params	*

WindSimulationSettings

Class creates WindSimulationSettings object

Kind: global class

new WindSimulationSettings(no, name, density, kinematicViscosity, consider_turbulence, turbulenceModel, memberLoadDistribution, comment, params)

Basic constuctor

Returns: Object WindSimulationSettings

Param	Type
no	*
name	*
density	*
kinematicViscosity	*
consider_turbulence	*
turbulenceModel	*
memberLoadDistribution	*
comment	*
params	*