Class TModflowSteadyParameter

DescriptionHierarchyFieldsMethodsProperties

Unit

ModflowParameterUnit

Declaration

type TModflowSteadyParameter = class(TModflowParameter)

Description

TModflowSteadyParameter is used for parameters in MODFLOW that have multiplier and zone arrays and do not vary in time.

Hierarchy

Overview

Fields

Private FMultiplierName: string;
Private FUseMultiplier: boolean;
Private FUseZone: boolean;
Private FZoneName: string;
Private FMultiplierArrayNames: TStringList;
Private FZoneArrayNames: TStringList;
Private FNamesToRemove: TStringList;

Methods

Private procedure SetMultiplierName(const Value: string);
Private procedure SetUseMultiplier(const Value: boolean);
Private procedure SetUseZone(const Value: boolean);
Private procedure SetZoneName(const Value: string);
Private procedure UpdateMultiplierName(const NewRoot: string);
Private procedure UpdateZoneName(const NewRoot: string);
Private function Collection: TModflowSteadyParameters;
Private procedure FillArrayNameList(List: TStringList; const ArrayTypeID: string; Const DefaultArrayRoot: string; AModel: TBaseModel);
Private procedure CreateNewDataSetVariables(const OldName, NewName: string);
Private procedure RemoveOldDataSetVariables;
Private procedure UpdateHfbParameterNames(const Value: string);
Private procedure UpdateFormulas(const OldName, NewName: string);
Private procedure UnlockDataSets;
Protected procedure SetParameterName(const Value: string); override;
Public procedure ClearArrayNames;
Public procedure Assign(Source: TPersistent); override;
Public constructor Create(Collection: TCollection); override;
Public destructor Destroy; override;
Public function IsSame(AnotherItem: TOrderedItem): boolean; override;
Published function MultiplierArrayName(ModflowLayer: integer; AModel: TBaseModel): string;
Published function ZoneArrayName(ModflowLayer: integer; AModel: TBaseModel): string;

Properties

Published property MultiplierName: string read FMultiplierName write SetMultiplierName;
Published property UseMultiplier: boolean read FUseMultiplier write SetUseMultiplier;
Published property UseZone: boolean read FUseZone write SetUseZone;
Published property ZoneName: string read FZoneName write SetZoneName;

Description

Fields

Private FMultiplierName: string;

See MultiplierName.

Private FUseMultiplier: boolean;

See UseMultiplier.

Private FUseZone: boolean;

See UseZone.

Private FZoneName: string;

See ZoneName.

Private FMultiplierArrayNames: TStringList;

FMultiplierArrayNames lists the Multiplier array names exported to MODFLOW.

See also
MultiplierArrayName
MultiplierArrayName lists the multiplier array names exported to MODFLOW.
Private FZoneArrayNames: TStringList;

FZoneArrayNames lists the Zone array names exported to MODFLOW.

See also
ZoneArrayName
ZoneArrayName lists the zone array names exported to MODFLOW.
Private FNamesToRemove: TStringList;
 

Methods

Private procedure SetMultiplierName(const Value: string);

See MultiplierName.

Private procedure SetUseMultiplier(const Value: boolean);

See UseMultiplier.

Private procedure SetUseZone(const Value: boolean);

See UseZone.

Private procedure SetZoneName(const Value: string);

See ZoneName.

Private procedure UpdateMultiplierName(const NewRoot: string);

UpdateMultiplierName is used in SetParameterName to change the name of the TDataArray used to define multiplier arrays related to this parameter.

Private procedure UpdateZoneName(const NewRoot: string);

UpdateZoneName is used in SetParameterName to change the name of the TDataArray used to define zone arrays related to this parameter.

Private function Collection: TModflowSteadyParameters;

Collection is the TModflowSteadyParameters that owns this TModflowSteadyParameter.

Private procedure FillArrayNameList(List: TStringList; const ArrayTypeID: string; Const DefaultArrayRoot: string; AModel: TBaseModel);

FillArrayNameList is used to update MultiplierArrayName and ZoneArrayName.

Private procedure CreateNewDataSetVariables(const OldName, NewName: string);
 
Private procedure RemoveOldDataSetVariables;
 
Private procedure UpdateHfbParameterNames(const Value: string);
 
Private procedure UpdateFormulas(const OldName, NewName: string);
 
Private procedure UnlockDataSets;
 
Protected procedure SetParameterName(const Value: string); override;

Besides setting the name of the parameter, SetParameterName also updates the names of the TDataArrays used to define multiplier and zone arrays.

Public procedure ClearArrayNames;
 
Public procedure Assign(Source: TPersistent); override;

Assign copies the source TModflowSteadyParameter to the current one.

Public constructor Create(Collection: TCollection); override;

Create creates an instance of TModflowSteadyParameter.

Public destructor Destroy; override;

Destroy destroys an instance of TModflowSteadyParameter.

Public function IsSame(AnotherItem: TOrderedItem): boolean; override;

IsSame calls inherited IsSame and then checks whether MultiplierName, UseMultiplier, UseZone, and MultiplierArrayName are the same as in the source item.

Published function MultiplierArrayName(ModflowLayer: integer; AModel: TBaseModel): string;

MultiplierArrayName lists the multiplier array names exported to MODFLOW.

Published function ZoneArrayName(ModflowLayer: integer; AModel: TBaseModel): string;

ZoneArrayName lists the zone array names exported to MODFLOW.

Properties

Published property MultiplierName: string read FMultiplierName write SetMultiplierName;

MultiplierName is the name of the TDataArray used to define MODFLOW multiplier arrays.

Published property UseMultiplier: boolean read FUseMultiplier write SetUseMultiplier;

UseMultiplier specifies whether this parameter will use a multiplier array.

Published property UseZone: boolean read FUseZone write SetUseZone;

UseZone specifies whether this parameter will use a zone array.

Published property ZoneName: string read FZoneName write SetZoneName;

ZoneName is the name of the TDataArray used to define MODFLOW zone arrays.

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