ArpsDeclineCurveFittingModel Class

Spotfire 15.0 API Reference

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

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.Visuals.FittingModelsFittingModel
        Spotfire.Dxp.Application.Visuals.FittingModelsArpsDeclineCurveFittingModel

Namespace: Spotfire.Dxp.Application.Visuals.FittingModels
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 71.0.22122.5390 (71.0.22122.5390)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(71, 0)]
public sealed class ArpsDeclineCurveFittingModel : FittingModel

The ArpsDeclineCurveFittingModel type exposes the following members.

Properties

	Name	Description
	ActiveForecastEndMode	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.
	BParameter	Gets the CurveFitParameter for the decline exponent b.
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DiParameter	Gets the CurveFitParameter for the initial nominal decline rate Di.
	DLim	Gets the value for the decline limit from the preprocessor expression. Can be null if the expression is invalid.
	DLimExpression	Gets or sets the preprocessor expression for the decline limit. The model switches from hyperbolic to exponential decline after reaching this limiting value.
	Enabled	Gets or sets a value indicating whether this FittingModel is enabled. (Inherited from FittingModel.)
	FittedCurve	Gets the fitted curve.
	ForecastCurve	Gets the forecast curve.
	ForecastTime	Gets the value for the forecast time preprocessor expression. Can be null if the expression is invalid.
	ForecastTimeExpression	Gets or sets the preprocessor expression for the forecast time value.
	IndividualFittingModes	The visualization features to calculate curves for. Features may be combined, which will result in one curve per combination. (Inherited from FittingModel.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	LimitToMarking	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. (Inherited from FittingModel.)
	ManualUpdate	Gets or sets a value indicating whether to use manual updates. (Inherited from FittingModel.)
	QEcl	Gets the value for the economic limit of production from the preprocessor expression. Can be null if the expression is invalid.
	QEclExpression	Gets or sets the preprocessor expression for the economic limit of production used to determine the end of the forecast.
	QiParameter	Gets the CurveFitParameter for the initial production rate qi.
	StartAtLastBreak	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.
	TimeUnit	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.
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	TransitionPoint	Gets the transition point. The point shown when the decline reaches the decline limit and the curve transitions from hyperbolic to exponential decline.
	TypeId	Gets the type identifier for this fitting model. The type identifiers for the built-in fitting models are defined in FittingModelTypeIdentifiers. (Inherited from FittingModel.)

Top

Methods

	Name	Description
	ForEachNodeInSubTreeTNode	Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node. (Inherited from DocumentNode.)
	GetResultsDataSource	Gets the current results as a data source. (Inherited from FittingModel.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Forces an update of this fitting model. Only allowed if ManualUpdate is set to true. (Inherited from FittingModel.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Version Information

Supported in: 15.0

Reference

Spotfire.Dxp.Application.Visuals.FittingModels Namespace