Class TFluxObsWriter

DescriptionHierarchyFieldsMethodsProperties

Unit

CustomModflowWriterUnit

Declaration

type TFluxObsWriter = class(TCustomListWriter)

Description

TFluxObsWriter is used for packages that have an associated flux observation package. TFluxObsWriter writes the input for both the boundary condition and the observations.

Hierarchy

Overview

Methods

Private function GetFluxType(ObservationGroup: TFluxObservationGroup): string;
Private procedure RemoveWarningGroups(ObservationGroup: TFluxObservationGroup);
Protected function ObservationPackage: TModflowPackageSelection; virtual; abstract;
Protected class function ObservationExtension: string; virtual; abstract;
Protected class function ObservationOutputExtension: string; virtual; abstract;
Protected function ObservationFileName(AFileName: string): string;
Protected function ObservationOutputFileName(AFileName: string): string;
Protected procedure WriteObservationDataSet4(ObservationGroup: TFluxObservationGroup; DataSet4: TStringList);
Protected procedure WriteObservationDataSet5(DataSet5: TStringList; ObservationGroup: TFluxObservationGroup; AllCells: TList); virtual;
Protected procedure WriteFluxObsFile(const AFileName, OutputUnitId, PackageAbbreviation, DataSet1Comment, DataSet2Comment, DataSet3Comment: string; Observations: TFluxObservationGroups; Purpose: TObservationPurpose);
Protected procedure WriteZeroConductanceCell(ACell: TValueCell; DataSet5: TStringList); virtual;
Protected procedure WriteObservationCell(ACell: TValueCell; DataSet5: TStringList; var Expression: TExpression; DataSets, Variables: TList; ObsFactor: TObservationFactor);
Protected procedure WriteObservationCells(Variables, DataSets: TList; var Expression: TExpression; DataSet5: TStringList; AllCells: TList; ScreenObject: TScreenObject; ObsFactor: TObservationFactor); virtual;
Protected function ObsNameWarningString: string; virtual; abstract;

Description

Methods

Private function GetFluxType(ObservationGroup: TFluxObservationGroup): string;
 
Private procedure RemoveWarningGroups(ObservationGroup: TFluxObservationGroup);
 
Protected function ObservationPackage: TModflowPackageSelection; virtual; abstract;
 
Protected class function ObservationExtension: string; virtual; abstract;

ObservationExtension is the file extension used for the observation input file.

Protected class function ObservationOutputExtension: string; virtual; abstract;

ObservationOutputExtension is the file extension used for the observation output file.

Protected function ObservationFileName(AFileName: string): string;

ObservationFileName returns the name of the Observation input file.

Protected function ObservationOutputFileName(AFileName: string): string;

ObservationOutputFileName returns the name of the Observation output file.

Protected procedure WriteObservationDataSet4(ObservationGroup: TFluxObservationGroup; DataSet4: TStringList);

WriteObservationDataSet4 writes OBSNAM IREFSP TOFFSET FLWOBS for the flux observations.

Protected procedure WriteObservationDataSet5(DataSet5: TStringList; ObservationGroup: TFluxObservationGroup; AllCells: TList); virtual;

WriteObservationDataSet5 writes the observation cells to be included in the observation to DataSet5 for a TFluxObservationGroup.

Parameters
AllCells
is a list of the cells from the corresponding flux package.
Protected procedure WriteFluxObsFile(const AFileName, OutputUnitId, PackageAbbreviation, DataSet1Comment, DataSet2Comment, DataSet3Comment: string; Observations: TFluxObservationGroups; Purpose: TObservationPurpose);

WriteFluxObsFile writes a flux observation file.

Protected procedure WriteZeroConductanceCell(ACell: TValueCell; DataSet5: TStringList); virtual;

WriteZeroConductanceCell writes a cell with a factor of zero in order to ensure that MODFLOW skips the cell in the observation.

Protected procedure WriteObservationCell(ACell: TValueCell; DataSet5: TStringList; var Expression: TExpression; DataSets, Variables: TList; ObsFactor: TObservationFactor);

WriteObservationCell writes the layer, row, column and factor for the ACell to DataSet5.

Parameters
Expression
determines what "Factor" should be.
Variables
is a list of TCustomVariables used by Expression.
DataSets
is a list of TDataArrays corresponding to the TCustomVariables in Variables.
Protected procedure WriteObservationCells(Variables, DataSets: TList; var Expression: TExpression; DataSet5: TStringList; AllCells: TList; ScreenObject: TScreenObject; ObsFactor: TObservationFactor); virtual;

WriteObservationCells writes the cells to be include in the observation to DataSet5.

Parameters
Variables
is a list of TCustomVariables used by Expression.
DataSets
is a list of TDataArrays corresponding to the TCustomVariables in Variables.
Expression
determines what "Factor" should be for each cell.
AllCells
is a list of TValueCells. from the corresponding flux package.
ScreenObject
is the TScreenObject that defines the cells to be exported.
Protected function ObsNameWarningString: string; virtual; abstract;
 
Generated by PasDoc 0.12.1 on 2013-05-13 15:41:29