Class TCustomListWriter

DescriptionHierarchyFieldsMethodsProperties

Unit

CustomModflowWriterUnit

Declaration

type TCustomListWriter = class(TCustomParameterTransientWriter)

Description

TCustomListWriter is used as a base class for writing typical boundary condition files that allow for both parameter and non-parameter cells.

Hierarchy

Overview

Methods

Protected procedure CountCells(var MaximumNumberOfCells: Integer);
Protected procedure CountParametersAndParameterCells( var ParamCount, ParamCellCount: integer);
Protected procedure GetOption(var Option: string); virtual;
Protected procedure WriteCell(Cell: TValueCell; const DataSetIdentifier, VariableIdentifiers: string); virtual; abstract;
Protected procedure WriteParameterDefinitions(const DS3, DS3Instances, DS4A, DataSetIdentifier, VariableIdentifiers, ErrorRoot: string; AssignmentMethod: TUpdateMethod; MultiplierArrayNames: TTransientMultCollection; ZoneArrayNames: TTransientZoneCollection); override;
Protected procedure WriteStressPeriods(const VariableIdentifiers, DataSetIdentifier, DS5, D7PNameIname, D7PName: string); override;
Public procedure UpdateDisplay(TimeLists: TModflowBoundListOfTimeLists; ParameterIndicies: TByteSet);

Description

Methods

Protected procedure CountCells(var MaximumNumberOfCells: Integer);

CountCells counts the maximum number of cells used any stress period. This value is returned in MaximumNumberOfCells.

Protected procedure CountParametersAndParameterCells( var ParamCount, ParamCellCount: integer);

CountParametersAndParameterCells counts the number of parameters and the maximum number of cells defined by parameters. If a parameter has no cells associated with it, its name will be erased from FParamValues which will cause a warning message to be displayed later on.

See also
ParameterCount
ParameterCount is the number of parameters used by the package.
Protected procedure GetOption(var Option: string); virtual;

GetOption returns the 'Option" used in many packages for suppressing the printing of lists of cells.

Protected procedure WriteCell(Cell: TValueCell; const DataSetIdentifier, VariableIdentifiers: string); virtual; abstract;

WriteCell is an abstract method for writes a cell.

Parameters
DataSetIdentifier
DataSetIdentifier identifies the data set that is being exported.
VariableIdentifiers
VariableIdentifiers identifies the variables being exported when the names of some variables vary.
Protected procedure WriteParameterDefinitions(const DS3, DS3Instances, DS4A, DataSetIdentifier, VariableIdentifiers, ErrorRoot: string; AssignmentMethod: TUpdateMethod; MultiplierArrayNames: TTransientMultCollection; ZoneArrayNames: TTransientZoneCollection); override;

WriteParameterDefinitions writes the definitions of parameters including the lists of cells.

Parameters
DS3
DS3 identifies the data set containing PARNAM PARTYP Parval NLST and those variable names.
DS3Instances
DS3Instances identifies the variables associated with parameters instances.
DS4A
DS4A identifies the data set containing INSTNAM. when parameter instances are being defined.
DataSetIdentifier
DataSetIdentifier is passed to WriteCell.
VariableIdentifiers
VariableIdentifiers is passed to WriteCell.
ErrorRoot
ErrorRoot is used in a format statement to create an error message when a parameter has no associated cells. It should have %s in it somewhere which will be filled in with the type of parameter being exported.
ParameterType
ParameterType is the type of parameter associated with the package being exported.
Protected procedure WriteStressPeriods(const VariableIdentifiers, DataSetIdentifier, DS5, D7PNameIname, D7PName: string); override;

WriteStressPeriods writes the non-parameter cells and the names of the parameter instance for each stress period.

Parameters
DataSetIdentifier
DataSetIdentifier is passed to WriteCell.
VariableIdentifiers
VariableIdentifiers is passed to WriteCell.
Public procedure UpdateDisplay(TimeLists: TModflowBoundListOfTimeLists; ParameterIndicies: TByteSet);

Check that the cell is in an active cell. UpdateDisplay is used to update the display of transient data used to color the grid.

Parameters
TimeLists
TimeLists is a list of TModflowBoundaryDisplayTimeLists that are to be updated. The order of the TModflowBoundaryDisplayTimeLists in TimeLists is important. The position in the list must be same as the index value used to access TValueCell.RealValue and TValueCell.RealAnnotation.
ParameterIndicies
The values included in ParameterIndicies indicate which TModflowBoundaryDisplayTimeLists in TimeLists are affected by MODFLOW parameters.
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:29