/// <summary>
/// Returns the proportional modal damping data assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing linear modal history analysis case that has proportional damping.</param>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void GetDampingProportional(string name,
out eDampingTypeProportional dampingType,
out double massProportionalDampingCoefficient,
out double stiffnessProportionalDampingCoefficient,
out double periodOrFrequencyPt1,
out double periodOrFrequencyPt2,
out double dampingPt1,
out double dampingPt2)
{
massProportionalDampingCoefficient = -1;
stiffnessProportionalDampingCoefficient = -1;
periodOrFrequencyPt1 = -1;
periodOrFrequencyPt2 = -1;
dampingPt1 = -1;
dampingPt2 = -1;
int csiDampingType = 0;
_callCode = _sapModel.LoadCases.DirHistNonlinear.GetDampProportional(name, ref csiDampingType, ref massProportionalDampingCoefficient, ref stiffnessProportionalDampingCoefficient,
ref periodOrFrequencyPt1, ref periodOrFrequencyPt2, ref dampingPt1, ref dampingPt2);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
dampingType = (eDampingTypeProportional)csiDampingType;
}
/// <summary>
/// Sets proportional modal damping data for the specified load case.
/// </summary>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public abstract void SetDampingPropertional(
eDampingTypeProportional dampingType,
double massProportionalDampingCoefficient,
double stiffnessProportionalDampingCoefficient,
double periodOrFrequencyPt1,
double periodOrFrequencyPt2,
double dampingPt1,
double dampingPt);
public void GetDampingProportional(string name,
ref eDampingTypeProportional dampingType,
ref double massProportionalDampingCoefficient,
ref double stiffnessProportionalDampingCoefficient,
ref double periodOrFrequencyPt1,
ref double periodOrFrequencyPt2,
ref double dampingPt1,
ref double dampingPt2)
{
}
/// <summary>
/// Sets proportional modal damping data for the specified load case.
/// </summary>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
protected void setDampingProportional(
eDampingTypeProportional dampingType,
double massProportionalDampingCoefficient,
double stiffnessProportionalDampingCoefficient,
double periodOrFrequencyPt1,
double periodOrFrequencyPt2,
double dampingPt1,
double dampingPt2)
{
}
/// <summary>
/// Sets proportional modal damping data for the specified load case.
/// </summary>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetDampingProportional(
eDampingTypeProportional dampingType,
double massProportionalDampingCoefficient,
double stiffnessProportionalDampingCoefficient,
double periodOrFrequencyPt1,
double periodOrFrequencyPt2,
double dampingPt1,
double dampingPt2)
{
// TODO: SAP2000 - SetDampingProportional
}
/// <summary>
/// Sets proportional modal damping data for the specified load case.
/// </summary>
/// <param name="name">The name of an existing linear modal history analysis case that has proportional damping.</param>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"><see cref="CSiApiBase.API_DEFAULT_ERROR_CODE" /></exception>
public void SetDampingProportional(string name,
eDampingTypeProportional dampingType,
double massProportionalDampingCoefficient,
double stiffnessProportionalDampingCoefficient,
double periodOrFrequencyPt1,
double periodOrFrequencyPt2,
double dampingPt1,
double dampingPt2)
{
_callCode = _sapModel.LoadCases.DirHistNonlinear.SetDampProportional(name, (int)dampingType, massProportionalDampingCoefficient, stiffnessProportionalDampingCoefficient,
periodOrFrequencyPt1, periodOrFrequencyPt2, dampingPt1, dampingPt2);
if (throwCurrentApiException(_callCode))
{
throw new CSiException(API_DEFAULT_ERROR_CODE);
}
}
/// <summary>
/// This function sets proportional modal damping data for the specified load case.
/// </summary>
/// <param name="name">The name of an existing linear modal history analysis case that has proportional damping.</param>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"></exception>
public void SetDampingProportional(string name,
eDampingTypeProportional dampingType,
double massProportionalDampingCoefficient,
double stiffnessProportionalDampingCoefficient,
double periodOrFrequencyPt1,
double periodOrFrequencyPt2,
double dampingPt1,
double dampingPt2)
{
_callCode = _sapModel.LoadCases.ResponseSpectrum.SetDampProportional(name, (int)dampingType, massProportionalDampingCoefficient, stiffnessProportionalDampingCoefficient,
periodOrFrequencyPt1, periodOrFrequencyPt2, dampingPt1, dampingPt2);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
}
/// <summary>
/// This function retrieves the proportional modal damping data assigned to the specified load case.
/// </summary>
/// <param name="name">The name of an existing linear modal history analysis case that has proportional damping.</param>
/// <param name="dampingType">The proportional modal damping type.</param>
/// <param name="massProportionalDampingCoefficient">The mass proportional damping coefficient.</param>
/// <param name="stiffnessProportionalDampingCoefficient">The stiffness proportional damping coefficient.</param>
/// <param name="periodOrFrequencyPt1">The period or frequency for point 1, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="periodOrFrequencyPt2">The period or frequency for point 2, depending on the value of <paramref name="dampingType" />.
/// [s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> and [cyc/s] for <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByFrequency" />.
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt1">The damping for point 1 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <param name="dampingPt2">The damping for point 2 (0 <= <paramref name="dampingPt1" /> < 1).
/// This item applies only when <paramref name="dampingType" /> = <see cref="eDampingTypeProportional.ProportionalByPeriod" /> or <see cref="eDampingTypeProportional.ProportionalByFrequency" />.</param>
/// <exception cref="CSiException"></exception>
public void GetDampingProportional(string name,
ref eDampingTypeProportional dampingType,
ref double massProportionalDampingCoefficient,
ref double stiffnessProportionalDampingCoefficient,
ref double periodOrFrequencyPt1,
ref double periodOrFrequencyPt2,
ref double dampingPt1,
ref double dampingPt2)
{
int csiDampingType = 0;
_callCode = _sapModel.LoadCases.ResponseSpectrum.GetDampProportional(name, ref csiDampingType, ref massProportionalDampingCoefficient, ref stiffnessProportionalDampingCoefficient,
ref periodOrFrequencyPt1, ref periodOrFrequencyPt2, ref dampingPt1, ref dampingPt2);
if (throwCurrentApiException(_callCode))
{
throw new CSiException();
}
dampingType = (eDampingTypeProportional)csiDampingType;
}
