Class TCustomPackageWriter

DescriptionHierarchyFieldsMethodsProperties

Unit

CustomModflowWriterUnit

Declaration

type TCustomPackageWriter = class(TCustomModflowWriter)

Description

TCustomPackageWriter is an abstract base class used to generate input for MODFLOW for a specific package.

Hierarchy

Overview

Fields

Private FWarningRoot: string;

Methods

Protected procedure SetTimeListsUpToDate(TimeLists: TModflowBoundListOfTimeLists);
Protected function Package: TModflowPackageSelection; virtual; abstract;
Protected procedure WriteDataSet0;
Protected procedure UpdateNotUsedDisplay(TimeLists: TModflowBoundListOfTimeLists);
Protected procedure UpdateCellDisplay(CellList: TValueCellList; DataArrayList: TList; ParameterIndicies: TByteSet; Param: TModflowTransientListParameter = nil; UsedIndicies: TByteSet = []);
Protected function ExpandString(Source: string; ALength: integer): string;
Protected procedure IdentifyZoneClusters(var NCLU: Integer; var Clusters: TOneDIntegerArray; var UniformLayers: TBooleanDynArray; LayerCount: Integer; Param: TModflowSteadyParameter);
Protected Function UcodeObsNameOK(Const AName: string): boolean;
Protected procedure CheckCell(ValueCell: TValueCell; const PackageName: string);
Public destructor Destroy; override;

Description

Fields

Private FWarningRoot: string;
 

Methods

Protected procedure SetTimeListsUpToDate(TimeLists: TModflowBoundListOfTimeLists);
 
Protected function Package: TModflowPackageSelection; virtual; abstract;

Package identifies the package that is being exported.

Protected procedure WriteDataSet0;

WriteDataSet0 writes the comments for the current package. WriteDataSet0 also writes a comment identifying the package.

Protected procedure UpdateNotUsedDisplay(TimeLists: TModflowBoundListOfTimeLists);

UpdateNotUsedDisplay prepares the lists in TimeLists for display when the lists in question are not used.

Protected procedure UpdateCellDisplay(CellList: TValueCellList; DataArrayList: TList; ParameterIndicies: TByteSet; Param: TModflowTransientListParameter = nil; UsedIndicies: TByteSet = []);

UpdateCellDisplay updates the TDataArrays in DataArrayList using the cells CellList.

Parameters
ParameterIndicies
indicates which properties of the cells are affected by MODFLOW parameters.
Param
is a MODFLOW parameter that might affect the value of some cells.
See also
UpdateTransient2DArray
UpdateTransient2DArray updates DisplayArray with the contents of List.
Protected function ExpandString(Source: string; ALength: integer): string;

ExpandString adds spaces to Source until the result is at least as long as ALength.

Protected procedure IdentifyZoneClusters(var NCLU: Integer; var Clusters: TOneDIntegerArray; var UniformLayers: TBooleanDynArray; LayerCount: Integer; Param: TModflowSteadyParameter);

IdentifyZoneClusters is used to define parameter clusters for Param.

When IdentifyZoneClusters is called, Param must be a parameter for which the clusters need to be identified and LayerCount must be greater than or equal to the maximum number of clusters that could be defined for the parameter.

After IdentifyZoneClusters is called: NCLU will be equal to the number of layer clusters needed to be associated with Param.

Clusters will be an array with length equal to the LayerCount. The first NCLU items in Clusters will be the MODFLOW layers for which a cluster will need to be defined.

UniformLayers will be an array with length equal to the LayerCount. The first NCLU items in UniformLayers will indicate whether or not the cluster associated with that layer will be uniform.

The remaining items in Clusters and UniformLayers are undefined.

Protected Function UcodeObsNameOK(Const AName: string): boolean;
 
Protected procedure CheckCell(ValueCell: TValueCell; const PackageName: string);
 
Public destructor Destroy; override;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:29