Class TWellBoundary

DescriptionHierarchyFieldsMethodsProperties

Unit

ScreenObjectUnit

Declaration

type TWellBoundary = class(TCustomInterpolatedBoundary)

Description

TWellBoundary represents a well in PHAST for one TScreenObject.

Hierarchy

Overview

Fields

Private FAllocateByPressureAndMobility: boolean;
Private FDescription: string;
Private FDiameter: double;
Private FIntervals: TWellIntervals;
Private FLandSurfaceDatum: double;
Private FWellElevationFormat: TWellElevationFormat;

Methods

Private procedure SetAllocateByPressureAndMobility(const Value: boolean);
Private procedure SetDescription(const Value: string);
Private procedure SetDiameter(const Value: double);
Private procedure SetIntervals(const Value: TWellIntervals);
Private procedure SetLandSurfaceDatum(const Value: double);
Private procedure SetWellElevationFormat(const Value: TWellElevationFormat);
Public procedure Assign(Source: TPersistent); override;
Public procedure Clear; override;
Public constructor Create(ScreenObject: TScreenObject; Model: TBaseModel);
Public destructor Destroy; override;
Public function IsBoundary: boolean;
Public procedure PartialAssign(Source: TPersistent);

Properties

Published property AllocateByPressureAndMobility: boolean read FAllocateByPressureAndMobility write SetAllocateByPressureAndMobility default True;
Published property Description: string read FDescription write SetDescription;
Published property Diameter: double read FDiameter write SetDiameter;
Published property Intervals: TWellIntervals read FIntervals write SetIntervals;
Published property LandSurfaceDatum: double read FLandSurfaceDatum write SetLandSurfaceDatum;
Published property WellElevationFormat: TWellElevationFormat read FWellElevationFormat write SetWellElevationFormat;
Published property InjectionOrPumpingRate: TRealPhastBoundaries read FBoundaryValue write SetBoundaryValue;

Description

Fields

Private FAllocateByPressureAndMobility: boolean;

See AllocateByPressureAndMobility.

Private FDescription: string;

See Description.

Private FDiameter: double;

FDiameter: double; See Diameter.

Private FIntervals: TWellIntervals;

FIntervals: TWellIntervals; See Intervals.

Private FLandSurfaceDatum: double;

FLandSurfaceDatum: double; See LandSurfaceDatum.

Private FWellElevationFormat: TWellElevationFormat;

FWellElevationFormat: TWellElevationFormat; See WellElevationFormat.

Methods

Private procedure SetAllocateByPressureAndMobility(const Value: boolean);

See AllocateByPressureAndMobility.

Private procedure SetDescription(const Value: string);

See Description.

Private procedure SetDiameter(const Value: double);

See Diameter.

Private procedure SetIntervals(const Value: TWellIntervals);

See Intervals.

Private procedure SetLandSurfaceDatum(const Value: double);

See LandSurfaceDatum.

Private procedure SetWellElevationFormat(const Value: TWellElevationFormat);

See WellElevationFormat.

Public procedure Assign(Source: TPersistent); override;

If Source is a TWellBoundary, Assign copies AllocateByPressureAndMobility, Description, Diameter, InjectionOrPumpingRate, Intervals, LandSurfaceDatum, Solution, and WellElevationFormat.

Public procedure Clear; override;

Clear clears InjectionOrPumpingRate and Solution.

Public constructor Create(ScreenObject: TScreenObject; Model: TBaseModel);

Create creates an instance of TWellBoundary.

Public destructor Destroy; override;

Destroy destroys the current instance of TWellBoundary. Do not call Destroy directly. Call Free instead.

Public function IsBoundary: boolean;

IsBoundary returns true if all the published properties have been set to values that indicate that a well boundary is present.

Public procedure PartialAssign(Source: TPersistent);

If Source is a TWellBoundary, PartialAssign copies Solution and InjectionOrPumpingRate but not AllocateByPressureAndMobility, Description, Diameter, Intervals, LandSurfaceDatum, and WellElevationFormat. PartialAssign is used in TUndoSetScreenObjectProperties.

Properties

Published property AllocateByPressureAndMobility: boolean read FAllocateByPressureAndMobility write SetAllocateByPressureAndMobility default True;

If AllocateByPressureAndMobility is True, PHAST will distribute the pumping amount among layers by taking into account the pressure and permeability in the layers in which the well has an open screen interval. If AllocateByPressureAndMobility is False, PHAST will not consider the pressure and permeability in the layers when distributing the pumping amount among layers.

Published property Description: string read FDescription write SetDescription;

Description is the name of the well.

Published property Diameter: double read FDiameter write SetDiameter;

Diameter is the diameter of the well.

Published property Intervals: TWellIntervals read FIntervals write SetIntervals;

Intervals defines the open well intervals. See WellElevationFormat and LandSurfaceDatum.

Published property LandSurfaceDatum: double read FLandSurfaceDatum write SetLandSurfaceDatum;

If WellElevationFormat = wefDepth, LandSurfaceDatum represents the datum from which the elevations (really depths) in Intervals are measured. If WellElevationFormat <> wefDepth. LandSurfaceDatum is ignored.

Published property WellElevationFormat: TWellElevationFormat read FWellElevationFormat write SetWellElevationFormat;

WellElevationFormat determines whether elevations in Intervals represent true elevations or depths below a datum. (see LandSurfaceDatum.)

Published property InjectionOrPumpingRate: TRealPhastBoundaries read FBoundaryValue write SetBoundaryValue;

InjectionOrPumpingRate is the rate at which water is pumped into or out of the porous medium. A positive InjectionOrPumpingRate means flow out of the porous medium.

Generated by PasDoc 0.12.1 on 2013-05-13 15:42:01