Action
    Preparing search index...

    Class ArpsDeclineCurveFittingModel

    A model for Arps Decline Curve fitting and forecasting. Usually applied to oil-and-gas production rate (Y) vs time (X) data.

    2.5

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    ActiveForecastEndMode BParameter Context DiParameter DLim DLimExpression Enabled FittedCurve ForecastCurve ForecastTime ForecastTimeExpression IndividualFittingModes IsAttached LimitToMarking ManualUpdate QEcl QEclExpression QiParameter StartAtLastBreak TimeUnit Transactions TransitionPoint TypeId ForEachNodeInSubTree GetResultsDataSource Update

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1 | null

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get ActiveForecastEndMode(): ForecastEndMode

      Gets or sets the forecast end mode. Determines how the end of the forecast is controlled, either by an economic limit or a specified forecast length.

      Returns ForecastEndMode

      2.5

    • set ActiveForecastEndMode(value: ForecastEndMode): void

      Parameters

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DLim(): number | null

      Gets the value for the decline limit from the preprocessor expression. Can be null if the expression is invalid.

      Returns number | null

      2.5

    • get DLimExpression(): string

      Gets or sets the preprocessor expression for the decline limit.

      The model switches from hyperbolic to exponential decline after reaching this limiting value.

      Returns string

      2.5

    • set DLimExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get Enabled(): boolean

      Gets or sets a value indicating whether this Spotfire.Dxp.Application.Visuals.FittingModels.FittingModel is enabled.

      Returns boolean

      2.0

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ForecastTime(): number | null

      Gets the value for the forecast time preprocessor expression. Can be null if the expression is invalid.

      Returns number | null

      2.5

    • get ForecastTimeExpression(): string

      Gets or sets the preprocessor expression for the forecast time value.

      Returns string

      2.5

    • set ForecastTimeExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LimitToMarking(): boolean

      Gets or sets a value indicating whether the fitting model should only include marked data when fitting. When true the active marking from the owning visual will limit the data used to perform the curve fit. Note that for some fitting model that don't use the visualization data, this property has no effect.

      Returns boolean

      2.5

    • set LimitToMarking(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ManualUpdate(): boolean

      Gets or sets a value indicating whether to use manual updates.

      Returns boolean

      2.0

    • set ManualUpdate(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get QEcl(): number | null

      Gets the value for the economic limit of production from the preprocessor expression. Can be null if the expression is invalid.

      Returns number | null

      2.5

    • get QEclExpression(): string

      Gets or sets the preprocessor expression for the economic limit of production used to determine the end of the forecast.

      Returns string

      2.5

    • set QEclExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get StartAtLastBreak(): boolean

      Gets or sets a value indicating whether the fit starts at the last break in production. A break is a time when the production rate is reported as zero.

      Returns boolean

      2.5

    • set StartAtLastBreak(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get TimeUnit(): ArpsTimeUnit

      Gets or sets the time unit. Used to convert datetime to a suitable scaled time value for fitting the model. Only applicable if the X axis expression results in an DateTime.

      Returns ArpsTimeUnit

      2.5

    • set TimeUnit(value: ArpsTimeUnit): void

      Parameters

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • get TransitionPoint(): ReferencePoint

      Gets the transition point. The point shown when the decline reaches the decline limit and the curve transitions from hyperbolic to exponential decline.

      Returns ReferencePoint

      2.5

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability