SeismicProjectSettings#

class SeismicUndrainedMethod(*values)#

Bases: Enum

EFFECTIVE_STRESS = 1#
DUNCAN_WRIGHT_WONG_3STAGE = 2#
ARMY_CRP_ENG_2STAGE = 3#
class SeismicInterpolationMethod(*values)#

Bases: Enum

DUNCAN_WRIGHT_WONG = 1#
VANDENBERGE_WRIGHT = 2#
class AdvancedSeismicMethod(*values)#

Bases: Enum

KC = 1#
NEWMARK = 2#
class NewmarkScalingOption(*values)#

Bases: Enum

NONE = 1#
FACTOR = 2#
class NewmarkSlopeDisplacementOption(*values)#

Bases: Enum

DOWNSLOPE_ONLY = 1#
DOWNSLOPE_UPSLOPE = 2#
class NewmarkAccelerationOption(*values)#

Bases: Enum

POSITIVE_ACCELERATIONS = 1#
NEGATIVE_ACCELERATIONS = 2#
AVERAGE_ACCELERATIONS = 3#
MAXIMUM_ACCELERATIONS = 4#
ALL_ACCELERATIONS = 5#
class NewmarkAnalysisType(*values)#

Bases: Enum

RIGID = 0#
COUPLED = 1#
DECOUPLED = 2#
ALL = 3#
class NewmarkAnalysisCoupledDecoupledSoilModel(*values)#

Bases: Enum

LINEAR_ELASTIC = 1#
EQUIVALENT_LINEAR = 2#
class SeismicRecordPoint(time: float, acceleration: float)#

Bases: object

class NewmarkAnalysisSettings(parent: SeismicProjectSettings)#

Bases: object

Newmark analysis settings sub-property. Used when advanced_seismic_method is SL_ADVANCED_SEISMIC_NEWMARK.

getShearWaveVelocityAbove() → float#

Get the shear wave velocity above (m/s or ft/s per units).

setShearWaveVelocityAbove(velocity: float)#

Set the shear wave velocity above.

getShearWaveVelocityBelow() → float#

Get the shear wave velocity below.

setShearWaveVelocityBelow(velocity: float)#

Set the shear wave velocity below.

getSeismicRecord() → List[SeismicRecordPoint]#

Get the seismic record as list of (time, acceleration) pairs in seconds and g.

setSeismicRecord(record: List[SeismicRecordPoint])#

Set the seismic record from list of (time, acceleration) pairs.

getScaleFactor() → float#

Get the scale factor for the seismic record.

setScaleFactor(factor: float)#

Set the scale factor for the seismic record.

getDampingRatio() → float#

Get the damping ratio (percent, e.g. 5 = 5%).

setDampingRatio(ratio: float)#

Set the damping ratio (percent).

getReferenceStrain() → float#

Get the reference strain.

setReferenceStrain(strain: float)#

Set the reference strain.

getScalingOption() → NewmarkScalingOption#

Get the scaling option.

setScalingOption(option: NewmarkScalingOption)#

Set the scaling option.

getSlopeDisplacementOption() → NewmarkSlopeDisplacementOption#

Get the slope displacement option (downslope only vs downslope and upslope).

setSlopeDisplacementOption(option: NewmarkSlopeDisplacementOption)#

Set the slope displacement option.

getAccelerationOption() → NewmarkAccelerationOption#

Get the acceleration option (positive, negative, average, maximum, or all).

setAccelerationOption(option: NewmarkAccelerationOption)#

Set the acceleration option.

getAnalysisType() → NewmarkAnalysisType#

Get the analysis type (rigid, coupled, decoupled, or all).

setAnalysisType(analysis_type: NewmarkAnalysisType)#

Set the analysis type.

getSoilModel() → NewmarkAnalysisCoupledDecoupledSoilModel#

Get whether to use linear elastic model (vs equivalent linear).

setSoilModel(soil_model: NewmarkAnalysisCoupledDecoupledSoilModel)#

Set whether to use linear elastic model.

class SeismicProjectSettings(model_id: str, client: Client)#

Bases: object

Examples: Code Snippet: Seismic Example

Seismic project settings for the model.

getUseStagedPseudoStaticStrength() → bool#

Get whether staged pseudostatic strength is enabled.

setUseStagedPseudoStaticStrength(use: bool)#

Set whether staged pseudostatic strength is enabled.

getSeismicUndrainedMethod() → SeismicUndrainedMethod#

Get the seismic undrained method (Effective Stress, Duncan-Wright-Wong, etc.).

setSeismicUndrainedMethod(method: SeismicUndrainedMethod)#

Set the seismic undrained method.

getSeismicInterpolationMethod() → SeismicInterpolationMethod#

Get the seismic interpolation method (for Duncan-Wright-Wong 3-stage).

setSeismicInterpolationMethod(method: SeismicInterpolationMethod)#

Set the seismic interpolation method.

getUseAdvancedSeismicAnalysis() → bool#

Get whether advanced seismic analysis (Kc or Newmark) is enabled.

setUseAdvancedSeismicAnalysis(use: bool)#

Set whether advanced seismic analysis is enabled.

getAdvancedSeismicMethod() → AdvancedSeismicMethod#

Get the advanced seismic method (Kc or Newmark).

setAdvancedSeismicMethod(method: AdvancedSeismicMethod)#

Set the advanced seismic method.

getTargetFactorOfSafety() → float#

Get the target factor of safety (when using Kc method).

setTargetFactorOfSafety(fs: float)#

Set the target factor of safety.