Class TCustomMF_BoundColl

DescriptionHierarchyFieldsMethodsProperties

Unit

ModflowBoundaryUnit

Declaration

type TCustomMF_BoundColl = class(TCustomNonSpatialBoundColl)

Description

TCustomMF_BoundColl represents MODFLOW boundaries for a series of time intervals. Descendants define one or more TModflowTimeLists which must be stored in FTimeListLink in the same order as the order used to access the corresponding TCustomBoundaryItem.BoundaryFormulas.

Hierarchy

Overview

Fields

Private FParamName: string;
Private FBoundaries: TBoundaryModelLinkList;
Private FTimeListLink: TTimeListModelLinkList;

Methods

Private function GetBoundaries(const Index: integer; AModel: TBaseModel): TCustomBoundaryStorage;
Private function GetParamName: string;
Private procedure SetParamName(Value: string);
Private function GetParam: TModflowTransientListParameter;
Private procedure SetParam(const Value: TModflowTransientListParameter);
Private function GetBoundaryCount(AModel: TBaseModel): integer;
Protected function GetTimeListLinkClass: TTimeListsModelLinkClass; virtual; abstract;
Protected procedure TestIfObservationsPresent(var EndOfLastStressPeriod: Double; var StartOfFirstStressPeriod: Double; var ObservationsPresent: Boolean); virtual;
Protected function GetTimeList(Index: integer; AModel: TBaseModel): TModflowTimeList; virtual;
Protected procedure AddBoundary(Value: TCustomBoundaryStorage);
Protected procedure AddSpecificBoundary(AModel: TBaseModel); virtual; abstract;
Protected procedure AddTimeList(List: TModflowTimeList; AModel: TBaseModel);
Protected procedure SetBoundaryCapacity(Value: integer; AModel: TBaseModel);
Protected procedure SetBoundaryStartAndEndTime(BoundaryCount: Integer; Item: TCustomModflowBoundaryItem; ItemIndex: Integer; AModel: TBaseModel); virtual;
Protected procedure ClearTimeLists(AModel: TBaseModel);
Public procedure RemoveModelLink(AModel: TBaseModel);
Public procedure ClearBoundaries(AModel: TBaseModel);
Public procedure Assign(Source: TPersistent); override;
Public constructor Create(Boundary: TModflowBoundary; Model: TBaseModel; ScreenObject: TObject); override;
Public destructor Destroy; override;
Public function IsSame(AnOrderedCollection: TOrderedCollection): boolean; override;
Public function TimeListCount(AModel: TBaseModel): integer; virtual;
Public function DataSetUsed(DataArray: TDataArray; AModel: TBaseModel): boolean; virtual;
Public function GetBoundaryByStartTime(StartTime: double; AModel: TBaseModel): TCustomBoundaryStorage;
Public function GetItemByStartTime(StartTime: Double): TCustomModflowBoundaryItem;

Properties

Protected property TimeListLink: TTimeListModelLinkList read FTimeListLink;
Public property Boundaries[constIndex:integer;AModel:TBaseModel]: TCustomBoundaryStorage read GetBoundaries;
Public property BoundaryCount[AModel:TBaseModel]: integer read GetBoundaryCount;
Public property Param: TModflowTransientListParameter read GetParam write SetParam;
Public property TimeLists[Index:integer;AModel:TBaseModel]: TModflowTimeList read GetTimeList;
Published property ParamName: string read GetParamName write SetParamName;

Description

Fields

Private FParamName: string;

See ParamName.

Private FBoundaries: TBoundaryModelLinkList;

FBoundaries stores instances of TCustomBoundaryStorage.

See also
AddBoundary
AddBoundary adds a TCustomBoundaryStorage to those owned by TCustomMF_BoundColl
ClearBoundaries
ClearBoundaries frees all the TCustomBoundaryStorage owned by TCustomMF_BoundColl.
GetBoundaries
See Boundaries.
Boundaries
Boundaries provides access to TCustomBoundaryStorage for different time periods.
SetBoundaryCapacity
SetBoundaryCapacity is the TModflowBoundary that owns TCustomMF_BoundColl.
Private FTimeListLink: TTimeListModelLinkList;

FTimeListLink provides access to a series of TTimeListsModelLinks. Each of them stores a series of TModflowTimeLists associated with a particular model. They must be in the same order as the order used to access the corresponding TCustomBoundaryItem.BoundaryFormulas.

See also
AddTimeList
AddTimeList adds a TModflowTimeList to those that can be accessed through TimeLists.
GetTimeList
See TimeLists.
TimeLists
TimeLists provides access to the TModflowTimeLists defined in descendants.

Methods

Private function GetBoundaries(const Index: integer; AModel: TBaseModel): TCustomBoundaryStorage;

See Boundaries.

Private function GetParamName: string;

See ParamName.

Private procedure SetParamName(Value: string);

See ParamName.

Private function GetParam: TModflowTransientListParameter;

See Param.

Private procedure SetParam(const Value: TModflowTransientListParameter);

See Param.

Private function GetBoundaryCount(AModel: TBaseModel): integer;
 
Protected function GetTimeListLinkClass: TTimeListsModelLinkClass; virtual; abstract;
 
Protected procedure TestIfObservationsPresent(var EndOfLastStressPeriod: Double; var StartOfFirstStressPeriod: Double; var ObservationsPresent: Boolean); virtual;
 
Protected function GetTimeList(Index: integer; AModel: TBaseModel): TModflowTimeList; virtual;

See TimeLists.

Protected procedure AddBoundary(Value: TCustomBoundaryStorage);

AddBoundary adds a TCustomBoundaryStorage to those owned by TCustomMF_BoundColl

See also
SetBoundaryCapacity
SetBoundaryCapacity is the TModflowBoundary that owns TCustomMF_BoundColl.
Protected procedure AddSpecificBoundary(AModel: TBaseModel); virtual; abstract;
 
Protected procedure AddTimeList(List: TModflowTimeList; AModel: TBaseModel);

AddTimeList adds a TModflowTimeList to those that can be accessed through TimeLists. The order in which TModflowTimeLists are added must correspond to the order in which the corresponding TCustomBoundaryItem.BoundaryFormulas are accessed.

Protected procedure SetBoundaryCapacity(Value: integer; AModel: TBaseModel);

SetBoundaryCapacity is the TModflowBoundary that owns TCustomMF_BoundColl. SetBoundaryCapacity is used to set the capacity of FBoundaries before calling AddBoundary.

Protected procedure SetBoundaryStartAndEndTime(BoundaryCount: Integer; Item: TCustomModflowBoundaryItem; ItemIndex: Integer; AModel: TBaseModel); virtual;

SetBoundaryStartAndEndTime sets the TCustomBoundaryStorage.StartingTime and TCustomBoundaryStorage.EndingTime of the TCustomBoundaryStorage at ItemIndex in Boundaries to the values of StartTime and EndTime Descendants used BoundaryCount to set the length of array of records that define where and with what values the boundary condition apply. for the item in Boundaries at ItemIndex.

Protected procedure ClearTimeLists(AModel: TBaseModel);
 
Public procedure RemoveModelLink(AModel: TBaseModel);
 
Public procedure ClearBoundaries(AModel: TBaseModel);

ClearBoundaries frees all the TCustomBoundaryStorage owned by TCustomMF_BoundColl.

Public procedure Assign(Source: TPersistent); override;

Assign copies ParamName from Source and calls inherited Assign.

Public constructor Create(Boundary: TModflowBoundary; Model: TBaseModel; ScreenObject: TObject); override;

Create creates an instance of TCustomMF_BoundColl.

Public destructor Destroy; override;

Destroy destroys the current instance of TCustomMF_BoundColl. Do not call Destroy; call Free instead.

Public function IsSame(AnOrderedCollection: TOrderedCollection): boolean; override;

IsSame returns True if AnOrderedCollection is a TCustomMF_BoundColl and Param = the Param of AnOrderedCollection and the inherited IsSame returns True.

Public function TimeListCount(AModel: TBaseModel): integer; virtual;

TimeListCount is the number of TModflowTimeLists that can be accessed in TimeLists.

Public function DataSetUsed(DataArray: TDataArray; AModel: TBaseModel): boolean; virtual;

DataSetUsed returns True if Count > 0.

Public function GetBoundaryByStartTime(StartTime: double; AModel: TBaseModel): TCustomBoundaryStorage;
 
Public function GetItemByStartTime(StartTime: Double): TCustomModflowBoundaryItem;
 

Properties

Protected property TimeListLink: TTimeListModelLinkList read FTimeListLink;
 
Public property Boundaries[constIndex:integer;AModel:TBaseModel]: TCustomBoundaryStorage read GetBoundaries;

Boundaries provides access to TCustomBoundaryStorage for different time periods. In descendants, these TCustomBoundaryStorage define the locations, values, and times for the boundaries.

Public property BoundaryCount[AModel:TBaseModel]: integer read GetBoundaryCount;
 
Public property Param: TModflowTransientListParameter read GetParam write SetParam;

Param is the TModflowTransientListParameter (if any) of the current TCustomMF_BoundColl.

Public property TimeLists[Index:integer;AModel:TBaseModel]: TModflowTimeList read GetTimeList;

TimeLists provides access to the TModflowTimeLists defined in descendants. TimeLists is used in TfrmScreenObjectProperties.InitializeModflowBoundaryFrames.

Published property ParamName: string read GetParamName write SetParamName;

ParamName is the name of the TModflowTransientListParameter (if any) associated with this TCustomMF_BoundColl.

Generated by PasDoc 0.12.1 on 2013-05-13 15:41:44