public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eCtType_IBC_2006 CtType,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_IBC_2006 siteClass,
double omega,
double R,
double I,
double Ss,
double S1,
double Fa,
double Fv,
double Cd,
eSeismicCoefficient_IBC_2006 seismicCoefficientSource,
double latitude,
double longitude,
string zipCode,
double TL)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eCtType_NBCC_2005 CtType,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_NBCC_2005 siteClass,
double Ro,
double I,
double PGA,
double S02,
double S05,
double S1,
double S2,
double S5,
double S10,
double F02,
double F05,
double F1,
double F2,
double F5,
double F10,
double Mv,
double Rd)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eC1Type_NTC_2008 C1Type,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_Eurocode_8_2004 soilType,
double PGA,
eParameters_NTC_2008 parameterOptions,
double latitude,
double longitude,
eIsland_NTC_2008 island,
eLimitState_NTC_2008 limitState,
eUsageClass_NTC_2008 usageClass,
double nominalLife,
double F0,
double Tcs,
eSpectrumType_NTC_2008 spectrumType,
eTopography_NTC_2008 topography,
double hRatio,
double damping,
double q,
double lambda)
{
}
/// <summary>
/// This function assigns auto seismic loading parameters for the NZS 1170 2004 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="R">The return period factor, R.</param>
/// <param name="Z">The hazard factor, Z.</param>
/// <param name="distanceToSeismicSource">Distance to the fault in km, used to calculate the near fault factor.</param>
/// <param name="Sp">The structural performance factor, Sp.</param>
/// <param name="Mu">The structural ductility factor, u.</param>
/// <exception cref="CSiException"></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_NZS_1170_2004 siteClass,
double R,
double Z,
double distanceToSeismicSource,
double Sp,
double Mu)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetNZS11702004(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)siteClass,
Z,
R,
distanceToSeismicSource,
Sp,
Mu);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// This function assigns auto seismic loading parameters for the 1994 UBC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="I">The importance factor.</param>
/// <param name="ZOption">The method of input for the seismic zone factor.</param>
/// <param name="Z">The seismic zone factor, Z.
/// If <paramref name="ZOption" /> = <see cref="eSource.PerCode" />, this item should be one of the following: 0.075, 0.15, 0.20, 0.30, 0.40.</param>
/// <param name="S">This is 1, 1.2, 1.5 or 2, indicating the site coefficient.</param>
/// <param name="RW">The numerical coefficient, Rw.</param>
/// <exception cref="CSiException"></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
ref double I,
eSource ZOption,
double Z,
double S,
double RW)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetUBC94(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)ZOption,
Z,
S,
I,
RW);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref eCtType_NBCC_2005 CtType,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_NBCC_2005 siteClass,
ref double Ro,
ref double I,
ref double PGA,
ref double S02,
ref double S05,
ref double S1,
ref double S2,
ref double S5,
ref double S10,
ref double F02,
ref double F05,
ref double F1,
ref double F2,
ref double F5,
ref double F10,
ref double Mv,
ref double Rd)
{
}
/// <summary>
/// This function assigns auto seismic loading parameters for the 2002 IS1893 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor. [L].
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="I">The importance factor.</param>
/// <param name="ZOption">The method of input for the seismic zone factor.</param>
/// <param name="Z">The seismic zone factor, Z.
/// If <paramnamef name="ZOption" /> = <see cref="eSource.PerCode" />, this item should be one of the following: 0.10, 0.16, 0.24, 0.36.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_IS_1893_2002 soilType,
double R,
double I,
eSource ZOption,
double Z)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetIS1893_2002(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)ZOption,
Z,
(int)soilType,
I,
R);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// Assigns auto seismic loading parameters for the 1996 BOCA code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="Aa">The effective peak acceleration coefficient.</param>
/// <param name="Av">The effective peak velocity-related coefficient.</param>
/// <param name="S">This is 1, 1.2, 1.5 or 2, indicating the site coefficient.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
double R,
double Aa,
double Av,
double S)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetBOCA96(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
R,
Aa,
Av,
S);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// Returns auto seismic loading parameters for the 2010 NBCC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="CtType">The structure type.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="Ro">The overstrength modifier.</param>
/// <param name="I">The importance factor.</param>
/// <param name="PGA">The peak ground acceleration.</param>
/// <param name="S02">The spectral acceleration at a 0.2 second period.</param>
/// <param name="S05">The spectral acceleration at a 0.5 second period.</param>
/// <param name="S1">The spectral acceleration at a 1 second period.</param>
/// <param name="S2">The spectral acceleration at a 2 second period.</param>
/// <param name="S4">The spectral acceleration at a 4 second period.</param>
/// <param name="Fa">The site coefficient Fa.</param>
/// <param name="Fv">The site coefficient Fv.</param>
/// <param name="Mv">The higher mode factor.</param>
/// <param name="Rd">The ductility modifier.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref eCtType_NBCC_2005 CtType,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_NBCC_2005 siteClass,
ref double Ro,
ref double I,
ref double PGA,
ref double S02,
ref double S05,
ref double S1,
ref double S2,
ref double S4,
ref double Fa,
ref double Fv,
ref double Mv,
ref double Rd)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiCtType = 0;
int csiSiteClass = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetNBCC2010(name,
ref csiLoadDirection,
ref eccentricity,
ref csiCtType,
ref csiPeriodOption,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref PGA,
ref S02,
ref S05,
ref S1,
ref S2,
ref S4,
ref csiSiteClass,
ref Fa,
ref Fv,
ref I,
ref Mv,
ref Rd,
ref Ro);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
CtType = (eCtType_NBCC_2005)csiCtType;
siteClass = (eSiteClass_NBCC_2005)csiSiteClass;
}
/// <summary>
/// This function assigns auto seismic loading parameters for the AS 1170 2007 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor. [L].
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="kp">The probability factor, kp.</param>
/// <param name="Z">The hazard factor, Z.</param>
/// <param name="Sp">The structural performance factor, Sp.</param>
/// <param name="Mu">The structural ductility factor, u.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_AS_1170_2007 siteClass,
double kp,
double Z,
double Sp,
double Mu)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetAS11702007(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)siteClass,
kp,
Z,
Sp,
Mu);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// Assigns auto seismic loading parameters for the Chinese 2010 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="alphaMax">The maximum influence factor.</param>
/// <param name="seismicIntensity">The seismic intensity.</param>
/// <param name="damping">The damping ratio.</param>
/// <param name="Tg">The characteristic ground period. [s].</param>
/// <param name="periodTimeDiscount">The period time discount factor.</param>
/// <param name="enhancementFactor">The enhancement factor.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
double alphaMax,
eSeismicIntensity_Chinese_2010 seismicIntensity,
double damping,
double Tg,
double periodTimeDiscount,
double enhancementFactor)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetChinese2010(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
alphaMax,
(int)seismicIntensity,
damping,
Tg,
periodTimeDiscount,
enhancementFactor);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function assigns auto seismic loading parameters for the 2015 NBCC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="CtType">The structure type.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="Ro">The overstrength modifier.</param>
/// <param name="I">The importance factor.</param>
/// <param name="PGA">The peak ground acceleration.</param>
/// <param name="S02">The spectral acceleration at a 0.2 second period.</param>
/// <param name="S05">The spectral acceleration at a 0.5 second period.</param>
/// <param name="S1">The spectral acceleration at a 1 second period.</param>
/// <param name="S2">The spectral acceleration at a 2 second period.</param>
/// <param name="S5">The spectral acceleration at a 5 second period.</param>
/// <param name="S10">The spectral acceleration at a 10 second period.</param>
/// <param name="F02">The site coefficient at a 0.2 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="F05">The site coefficient at a 0.5 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="F1">The site coefficient at a 1 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="F2">The site coefficient at a 2 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="F5">The site coefficient at a 5 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="F10">The site coefficient at a 10 second period.
/// This only applies when <paramnamef name="siteClass" /> = <see cref="eSiteClass_NBCC_2005.F" />.</param>
/// <param name="Mv">The higher mode factor.</param>
/// <param name="Rd">The ductility modifier.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eCtType_NBCC_2005 CtType,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_NBCC_2005 siteClass,
double Ro,
double I,
double PGA,
double S02,
double S05,
double S1,
double S2,
double S5,
double S10,
double F02,
double F05,
double F1,
double F2,
double F5,
double F10,
double Mv,
double Rd)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetNBCC2015(name,
(int)loadDirection,
eccentricity,
(int)CtType,
(int)periodOption,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
PGA,
S02,
S05,
S1,
S2,
S5,
S10,
(int)siteClass,
F02,
F05,
F1,
F2,
F5,
F10,
I,
Mv,
Rd,
Ro);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// Returns auto seismic loading parameters for the Eurocode 8 2004 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.</param>
/// <param name="ag">The design ground acceleration, ag. [g].</param>
/// <param name="country">The country for which the Nationally Determined Parameters (NDPs) are specified.</param>
/// <param name="spectrumType">Type of spectrum.</param>
/// <param name="S">The soil factor, S.</param>
/// <param name="Tb">The lower limit of period of the constant spectral acceleration branch, Tb.</param>
/// <param name="Tc">The upper limit of period of the constant spectral acceleration branch, Tc.</param>
/// <param name="Td">The period defining the start of the constant displacement range, Td.</param>
/// <param name="beta">The lower bound factor, Beta.</param>
/// <param name="q">The behavior factor, q.</param>
/// <param name="lambda">The correction factor, Lambda.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double Ct,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_Eurocode_8_2004 soilType,
ref double ag,
ref eParameters_Eurocode_8_2004 country,
ref eSpectrumType_Eurocode_8_2004 spectrumType,
ref double S,
ref double Tb,
ref double Tc,
ref double Td,
ref double beta,
ref double q,
ref double lambda)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiSoilType = 0;
int csiCountry = 0;
int csiSpectrumType = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetEurocode82004_1(name,
ref csiLoadDirection,
ref eccentricity,
ref csiPeriodOption,
ref Ct,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref csiCountry,
ref csiSpectrumType,
ref csiSoilType,
ref ag,
ref S,
ref Tb,
ref Tc,
ref Td,
ref beta,
ref q,
ref lambda);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
soilType = (eSiteClass_Eurocode_8_2004)csiSoilType;
country = (eParameters_Eurocode_8_2004)csiCountry;
spectrumType = (eSpectrumType_Eurocode_8_2004)csiSpectrumType;
}
/// <summary>
/// Assigns auto seismic loading parameters for the NTC 2008 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="C1Type">Type of the c1.
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" />.</param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.</param>
/// <param name="PGA">The peak ground acceleration, ag/g.</param>
/// <param name="parameterOptions">The option for defining the parameters.</param>
/// <param name="latitude">The latitude for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="parameterOptions" /> = <see cref="eParameters_NTC_2008.ByLatLong" /></param>
/// <param name="longitude">The longitude for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="parameterOptions" /> = <see cref="eParameters_NTC_2008.ByLatLong" /></param>
/// <param name="island">The island for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="parameterOptions" /> = <see cref="eParameters_NTC_2008.ByIsland" /></param>
/// <param name="limitState">The limit state.</param>
/// <param name="usageClass">The usage class.</param>
/// <param name="nominalLife">The nominal life to be considered.</param>
/// <param name="F0">The magnitude factor, F0.</param>
/// <param name="Tcs">The reference period, Tc* [s].</param>
/// <param name="spectrumType">The type of spectrum to consider.</param>
/// <param name="topography">The topography type.</param>
/// <param name="hRatio">The ratio for the site altitude at the base of the hill to the height of the hill..</param>
/// <param name="damping">The damping, in percent.
/// This only applies when <paramnamef name="spectrumType" /> = <see cref="eSpectrumType_NTC_2008.ElasticHorizontal" /> or <see cref="eSpectrumType_NTC_2008.ElasticVertical" />.</param>
/// <param name="q">The behavior correction factor, q.
/// This only applies when <paramnamef name="spectrumType" /> = <see cref="eSpectrumType_NTC_2008.DesignHorizontal" /> or <see cref="eSpectrumType_NTC_2008.DesignVertical" />.</param>
/// <param name="lambda">The correction factor, Lambda.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eC1Type_NTC_2008 C1Type,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_Eurocode_8_2004 soilType,
double PGA,
eParameters_NTC_2008 parameterOptions,
double latitude,
double longitude,
eIsland_NTC_2008 island,
eLimitState_NTC_2008 limitState,
eUsageClass_NTC_2008 usageClass,
double nominalLife,
double F0,
double Tcs,
eSpectrumType_NTC_2008 spectrumType,
eTopography_NTC_2008 topography,
double hRatio,
double damping,
double q,
double lambda)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetNTC2008(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
(int)C1Type,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)parameterOptions,
latitude,
longitude,
(int)island,
(int)limitState,
(int)usageClass,
nominalLife,
PGA,
F0,
Tcs,
(int)spectrumType,
(int)soilType,
(int)topography,
hRatio,
q,
damping,
lambda);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function retrieves auto seismic loading parameters for the 2003 IBC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor. [L]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="omega">The system overstrength factor.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="Ss">The response acceleration for short periods, (g).</param>
/// <param name="S1">The response acceleration for a one second period, (g).</param>
/// <param name="seismicCoefficientSource">The seismic coefficient source.</param>
/// <param name="Fa">The site coefficient Fa.</param>
/// <param name="Fv">The site coefficient Fv.</param>
/// <param name="Cd">The deflection amplification factor.</param>
/// <param name="Sg">The sg.</param>
/// <exception cref="CSiException"></exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double Ct,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_IBC_2003 siteClass,
ref double omega,
ref double R,
ref double Ss,
ref double S1,
ref eSource seismicCoefficientSource,
ref double Fa,
ref double Fv,
ref double Cd,
ref eSeismicGroup_IBC_2003 Sg)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiSiteClass = 0;
int csiSeismicCoefficientSource = 0;
int csiSeismicGroup = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetIBC2003(name,
ref csiLoadDirection,
ref eccentricity,
ref csiPeriodOption,
ref Ct,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref csiSeismicGroup,
ref csiSeismicCoefficientSource,
ref csiSiteClass,
ref Ss,
ref S1,
ref Fa,
ref Fv,
ref R,
ref omega,
ref Cd);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
siteClass = (eSiteClass_IBC_2003)csiSiteClass;
seismicCoefficientSource = (eSource)csiSeismicCoefficientSource;
Sg = (eSeismicGroup_IBC_2003)csiSeismicGroup;
}
/// <summary>
/// This function retrieves auto seismic loading parameters for the 1995 NBCC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="CtType">The structure type.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="R">The force modification factor.</param>
/// <param name="I">The importance factor.</param>
/// <param name="Ds">The dimension of the lateral load resisting system in the direction of the applied forces. [L].
/// This only applies when <paramref name="CtType" /> = <see cref="eCtType_NBCC_1995.Other" />.</param>
/// <param name="Za">The acceleration related zone, Za.</param>
/// <param name="Zv">The velocity related zone, Zv.</param>
/// <param name="ZvRatioSource">How the zonal velocity ratio, V, is specified.</param>
/// <param name="ZvRatio">The zonal velocity ratio, V.</param>
/// <param name="F">The foundation factor.</param>
/// <exception cref="CSiException"></exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref eCtType_NBCC_1995 CtType,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref double R,
ref double I,
ref double Ds,
ref eZa_NBCC_1995 Za,
ref eZv_NBCC_1995 Zv,
ref eSource ZvRatioSource,
ref double ZvRatio,
ref double F)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiCtType = 0;
int csiZa = 0;
int csiZv = 0;
int csiZvRatioSource = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetNBCC95(name,
ref csiLoadDirection,
ref eccentricity,
ref csiCtType,
ref Ds,
ref csiPeriodOption,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref csiZa,
ref csiZv,
ref csiZvRatioSource,
ref ZvRatio,
ref I,
ref F,
ref R);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
CtType = (eCtType_NBCC_1995)csiCtType;
Za = (eZa_NBCC_1995)csiZa;
Zv = (eZv_NBCC_1995)csiZv;
ZvRatioSource = (eSource)csiZvRatioSource;
}
/// <summary>
/// This function retrieves auto seismic loading parameters for the 1997 NEHRP code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.
/// This only applies when <paramref name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" />.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="Ss">The response acceleration for short periods, (g).</param>
/// <param name="S1">The response acceleration for a one second period, (g).</param>
/// <param name="Fa">The site coefficient Fa.</param>
/// <param name="Fv">The site coefficient Fv.</param>
/// <param name="seismicCoefficientSource">The seismic coefficient source.</param>
/// <param name="Sg">The seismic group.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double Ct,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_NEHRP_1997 siteClass,
ref double R,
ref double Ss,
ref double S1,
ref double Fa,
ref double Fv,
ref eSource seismicCoefficientSource,
ref eSeismicGroup_NEHRP_1997 Sg)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiSiteClass = 0;
int csiSeismicCoefficientSource = 0;
int csiSg = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetNEHRP97(name,
ref csiLoadDirection,
ref eccentricity,
ref csiPeriodOption,
ref Ct,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref csiSg,
ref csiSeismicCoefficientSource,
ref csiSiteClass,
ref Ss,
ref S1,
ref Fa,
ref Fv,
ref R);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
siteClass = (eSiteClass_NEHRP_1997)csiSiteClass;
seismicCoefficientSource = (eSource)csiSeismicCoefficientSource;
Sg = (eSeismicGroup_NEHRP_1997)csiSg;
}
/// <summary>
/// Assigns auto seismic loading parameters for the 2009 IBC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="CtType">The values of Ct and x.
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="omega">The system overstrength factor.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="I">The importance factor.</param>
/// <param name="Ss">The response acceleration for short periods, (g).</param>
/// <param name="S1">The response acceleration for a one second period, (g).</param>
/// <param name="Fa">The site coefficient Fa.</param>
/// <param name="Fv">The site coefficient Fv.</param>
/// <param name="Cd">The deflection amplification factor.</param>
/// <param name="seismicCoefficientSource">The seismic coefficient source.</param>
/// <param name="latitude">The latitude for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSeismicCoefficient_IBC_2006.SsAndS1FromUSGSLatLong" /> or <see cref="eSeismicCoefficient_IBC_2006.SsAndS1FromUSGSZipCode" />.</param>
/// <param name="longitude">The longitude for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSeismicCoefficient_IBC_2006.SsAndS1FromUSGSLatLong" /> or <see cref="eSeismicCoefficient_IBC_2006.SsAndS1FromUSGSZipCode" />.</param>
/// <param name="zipCode">The zip code for which the seismic coefficients are obtained.
/// This only applies when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSeismicCoefficient_IBC_2006.SsAndS1FromUSGSZipCode" />.</param>
/// <param name="TL">The long-period transition period. [s].</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eCtType_IBC_2006 CtType,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_IBC_2006 siteClass,
double omega,
double R,
double I,
double Ss,
double S1,
double Fa,
double Fv,
double Cd,
eSeismicCoefficient_IBC_2006 seismicCoefficientSource,
double latitude,
double longitude,
string zipCode,
double TL)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetIBC2009(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
(int)CtType,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
R,
omega,
Cd,
I,
(int)seismicCoefficientSource,
latitude,
longitude,
zipCode,
Ss,
S1,
TL,
(int)siteClass,
Fa,
Fv);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
double R,
double Aa,
double Av,
double S)
{
}
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double Ct,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref double R,
ref double Aa,
ref double Av,
ref double S)
{
}
/// <summary>
/// This function assigns auto seismic loading parameters for the 1997 UBC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" /></param>
/// <param name="R">The overstrength factor.</param>
/// <param name="I">The importance factor.</param>
/// <param name="Z">This is 0.075, 0.15, 0.2, 0.3 or 0.4, indicating the seismic zone factor.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" /></param>
/// <param name="seismicCoefficientSource">The seismic coefficient source.</param>
/// <param name="Ca">The seismic coefficient, Ca.</param>
/// <param name="Cv">The seismic coefficient, Cv.</param>
/// <param name="nearSourceSource">Indicates the source of the near source factor coefficients Na and Nv.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" /> and <paramnamef name="Z" /> = 0.4.</param>
/// <param name="seismicSourceType">Type of the seismic source.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" /> and <paramnamef name="Z" /> = 0.4 and <paramnamef name="nearSourceSource" /> = <see cref="eSource.PerCode" />.</param>
/// <param name="distanceToSeismicSource">This is the distance to the seismic source in kilometers.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.PerCode" /> and <paramnamef name="Z" /> = 0.4 and <paramnamef name="nearSourceSource" /> = <see cref="eSource.PerCode" />.</param>
/// <param name="Na">The near source factor coefficient, Na.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.UserDefined" />.</param>
/// <param name="Nv">The near source factor coefficient, Nv.
/// This item is applicable only when <paramnamef name="seismicCoefficientSource" /> = <see cref="eSource.UserDefined" />.</param>
/// <exception cref="CSiException"></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_UBC_97 soilType,
double R,
double I,
double Z,
eSource seismicCoefficientSource,
double Ca,
double Cv,
eSource nearSourceSource,
eSourceType_UBC_97 seismicSourceType,
double distanceToSeismicSource,
double Na,
double Nv)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetUBC97(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)seismicCoefficientSource,
(int)soilType,
Z,
Ca,
Cv,
(int)nearSourceSource,
(int)seismicSourceType,
distanceToSeismicSource,
Na,
Nv,
I,
R);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_NZS_1170_2004 siteClass,
ref double R,
ref double Z,
ref double distanceToSeismicSource,
ref double Sp,
ref double Mu)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
double alphaMax,
eSeismicIntensity_Chinese_2010 seismicIntensity,
double damping,
double Tg,
double periodTimeDiscount,
double enhancementFactor)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_IS_1893_2002 soilType,
double R,
double I,
eSource ZOption,
double Z)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_AS_1170_2007 siteClass,
double kp,
double Z,
double Sp,
double Mu)
{
}
/// <summary>
/// Assigns auto seismic loading parameters for the Eurocode 8 2004 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor.
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.</param>
/// <param name="ag">The design ground acceleration, ag. [g].</param>
/// <param name="country">The country for which the Nationally Determined Parameters (NDPs) are specified.</param>
/// <param name="spectrumType">Type of spectrum.</param>
/// <param name="S">The soil factor, S.</param>
/// <param name="Tb">The lower limit of period of the constant spectral acceleration branch, Tb.</param>
/// <param name="Tc">The upper limit of period of the constant spectral acceleration branch, Tc.</param>
/// <param name="Td">The period defining the start of the constant displacement range, Td.</param>
/// <param name="beta">The lower bound factor, Beta.</param>
/// <param name="q">The behavior factor, q.</param>
/// <param name="lambda">The correction factor, Lambda.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_Eurocode_8_2004 soilType,
double ag,
eParameters_Eurocode_8_2004 country,
eSpectrumType_Eurocode_8_2004 spectrumType,
double S,
double Tb,
double Tc,
double Td,
double beta,
double q,
double lambda)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetEurocode82004_1(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)country,
(int)spectrumType,
(int)soilType,
ag,
S,
Tb,
Tc,
Td,
beta,
q,
lambda);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function assigns auto seismic loading parameters for the 2003 IBC code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor. [L]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramnamef name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramnamef name="userSpecifiedHeights" /> = True.</param>
/// <param name="siteClass">The site class.</param>
/// <param name="omega">The system overstrength factor.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="Ss">The response acceleration for short periods, (g).</param>
/// <param name="S1">The response acceleration for a one second period, (g).</param>
/// <param name="seismicCoefficientSource">The seismic coefficient source.</param>
/// <param name="Fa">The site coefficient Fa.</param>
/// <param name="Fv">The site coefficient Fv.</param>
/// <param name="Cd">The deflection amplification factor.</param>
/// <param name="Sg">The sg.</param>
/// <exception cref="CSiException"></exception>
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_IBC_2003 siteClass,
double omega,
double R,
double Ss,
double S1,
eSource seismicCoefficientSource,
double Fa,
double Fv,
double Cd,
eSeismicGroup_IBC_2003 Sg)
{
_callCode = _sapModel.LoadPatterns.AutoSeismic.SetIBC2003(name,
(int)loadDirection,
eccentricity,
(int)periodOption,
Ct,
userSpecifiedPeriod,
userSpecifiedHeights,
coordinateTopZ,
coordinateBottomZ,
(int)Sg,
(int)seismicCoefficientSource,
(int)siteClass,
Ss,
S1,
Fa,
Fv,
R,
omega,
Cd);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// This function retrieves auto seismic loading parameters for the 2002 IS1893 code.
/// </summary>
/// <param name="name">The name of an existing Quake-type load pattern with a corresponding auto seismic load assignment.</param>
/// <param name="loadDirection">The seismic load direction.</param>
/// <param name="eccentricity">The eccentricity ratio that applies to all diaphragms.</param>
/// <param name="periodOption">The time period option.</param>
/// <param name="Ct">The code-specified Ct factor. [L].
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.Approximate" /> or <see cref="eTimePeriodOption.ProgramCalculated" />.</param>
/// <param name="userSpecifiedPeriod">The user specified time period. [s]
/// This only applies when <paramref name="periodOption" /> = <see cref="eTimePeriodOption.UserDefined" /></param>
/// <param name="userSpecifiedHeights">True: Top and bottom elevations of the seismic load are user specified.
/// Else, the program determines the elevations.</param>
/// <param name="coordinateTopZ">Global Z-coordinate at the highest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="coordinateBottomZ">Global Z-coordinate at the lowest level where auto seismic loads are applied. [L].
/// This only applies when <paramref name="userSpecifiedHeights" /> = True.</param>
/// <param name="soilType">Type of the soil.</param>
/// <param name="R">The response modification factor.</param>
/// <param name="I">The importance factor.</param>
/// <param name="ZOption">The method of input for the seismic zone factor.</param>
/// <param name="Z">The seismic zone factor, Z.
/// If <paramref name="ZOption" /> = <see cref="eSource.PerCode" />, this item should be one of the following: 0.10, 0.16, 0.24, 0.36.</param>
/// <exception cref="CSiException">API_DEFAULT_ERROR_CODE</exception>
public void GetLoad(string name,
ref eSeismicLoadDirection loadDirection,
ref double eccentricity,
ref eTimePeriodOption periodOption,
ref double Ct,
ref double userSpecifiedPeriod,
ref bool userSpecifiedHeights,
ref double coordinateTopZ,
ref double coordinateBottomZ,
ref eSiteClass_IS_1893_2002 soilType,
ref double R,
ref double I,
ref eSource ZOption,
ref double Z)
{
int csiLoadDirection = 0;
int csiPeriodOption = 0;
int csiSoilType = 0;
int csiSeismicZoneOption = 0;
_callCode = _sapModel.LoadPatterns.AutoSeismic.GetIS1893_2002(name,
ref csiLoadDirection,
ref eccentricity,
ref csiPeriodOption,
ref Ct,
ref userSpecifiedPeriod,
ref userSpecifiedHeights,
ref coordinateTopZ,
ref coordinateBottomZ,
ref csiSeismicZoneOption,
ref Z,
ref csiSoilType,
ref I,
ref R);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
loadDirection = (eSeismicLoadDirection)csiLoadDirection;
periodOption = (eTimePeriodOption)csiPeriodOption;
soilType = (eSiteClass_IS_1893_2002)csiSoilType;
ZOption = (eSource)csiSeismicZoneOption;
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
eCtType_NBCC_1995 CtType,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
double R,
double I,
double Ds,
eZa_NBCC_1995 Za,
eZv_NBCC_1995 Zv,
eSource ZvRatioSource,
double ZvRatio,
double F)
{
}
public void SetLoad(string name,
eSeismicLoadDirection loadDirection,
double eccentricity,
eTimePeriodOption periodOption,
double Ct,
double userSpecifiedPeriod,
bool userSpecifiedHeights,
double coordinateTopZ,
double coordinateBottomZ,
eSiteClass_NEHRP_1997 siteClass,
double R,
double Ss,
double S1,
double Fa,
double Fv,
eSource seismicCoefficientSource,
eSeismicGroup_NEHRP_1997 Sg)
{
}
