Unit GoPhastTypes

Description

Uses

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

GoPhastTypes is used to define types, constants, and small classes used in a variety of places in GoPhast.

Uses

GR32
SysUtils
Types
Classes
FastGEO
Graphics

Overview

Classes, Interfaces, Objects and Records

Name	Description
record `TMinMax`	`TMinMax` records the minimum and maximum values assigned to a data set.
Class `TPhastCollection`	`TPhastCollection` invalidates the model when it is changed.
Class `TPhastCollectionItem`
Class `TIntegerItem`
Class `TIntegerCollection`
Class `TRealItem`
Class `TRealCollection`
Class `TRealStorage`
Class `TStringStorage`
Class `TGoPhastPersistent`
Class `TBaseModel`
Class `TLayerSort`

Functions and Procedures

function EvalAtToString(const Eval: TEvaluatedAt; const Model: TModelSelection; const Plural, TitleCase: boolean): string;

function ValidName(const OriginalName: string): string;

function RightCopy(const Source: string; LengthToCopy: integer): string;

function OrientationToViewDirection(Orientation: TDataSetOrientation): TViewDirection;

function StrToStatFlag(Const AStatFlagLabel: string): TStatFlag;

function StatFlatToStr(AStatFlag: TStatFlag): string;

function SortLayerSorts(Item1, Item2: Pointer): Integer;

Types

PReal = ˆReal;

TOneDRealArray = array of Double;

TOneDIntegerArray = array of integer;

TTwoDRealArray = array of TOneDRealArray;

TThreeDRealArray = array of TTwoDRealArray;

P2DRealPoint = TPoint2DPtr;

TRealPointArray = TPolygon2D;

T2DRealPointArray = array of TRealPointArray;

T2DBoolArray = array of array of boolean;

T3DRealPoint = TPoint3D;

P3DRealPoint = ˆT3DRealPoint;

TRealArray = array of Real;

T3DRealPointArray1 = array of T3DRealPoint;

T3DRealPointArray2 = array of T3DRealPointArray1;

T3DRealPointArray3 = array of array of array of T3DRealPoint;

TCursorGrid = (...);

TViewDirection = (...);

TViewDirections = set of TViewDirection;

TDataColumns = (...);

TDataLock = set of TDataColumns;

TDataSetOrientation = (...);

TDataSetOrientations = set of TDataSetOrientation;

TElevationCount = (...);

TEvaluatedAt = (...);

TLgrCellTreatment = (...);

TFrequencyUnits = (...);

TTimeUnits = (...);

TLengthUnits = (...);

TInverseLengthUnits = (...);

TVolumeUnits = (...);

TPhastSolver = (...);

TInterpolationDirection = (...);

PInterpolationDirection = ˆTInterpolationDirection;

TPrintFrequencyRows = (...);

TPhastBoundaryTypes = (...);

TModflowBoundaryType = (...);

TWellElevationFormat = (...);

TModelSelection = (...);

TGrowthMethod = (...);

TAssignmentLocation = (...);

TByteSet = set of byte;

TIface = (...);

TStatFlag = (...);

TObservationPurpose = (...);

TUpdateMethod = (...);

TObservationType = (...);

TDisplayChoice = (...);

TPointArray = array of TPoint;

Constants

TimeEpsilon = 1e-6;

kModelTop = 'Model_Top';

BlankSpaces = ' ';

MRU_Section = 'MostRecentlyUsed';

StrModelTop = kModelTop;

StrWritingDataSet1 = ' Writing Data Set 1.';

StrWritingDataSet2 = ' Writing Data Set 2.';

StrWritingDataSet3 = ' Writing Data Set 3.';

StrWritingDataSet4 = ' Writing Data Set 4.';

StrWritingDataSet5 = ' Writing Data Set 5.';

StrWritingDataSet6 = ' Writing Data Set 6.';

StrWritingDataSet7 = ' Writing Data Set 7.';

StrWritingDataSet8 = ' Writing Data Set 8.';

StrWritingDataSet10 = ' Writing Data Set 10.';

StrWritingDataSet14 = ' Writing Data Set 14.';

StrWritingDataSet15 = ' Writing Data Set 15.';

StrWritingDataSet16 = ' Writing Data Set 16.';

StrWritingDataSet17 = ' Writing Data Set 17.';

StrWritingDataSet22 = ' Writing Data Set 22.';

StrWritingDataSet23 = ' Writing Data Set 23.';

StrWritingDataSet24 = ' Writing Data Set 24.';

StrWritingDataSet25 = ' Writing Data Set 25.';

StrWritingDataSet26 = ' Writing Data Set 26.';

StrWritingDataSet27 = ' Writing Data Set 27.';

StrWritingDataSet28 = ' Writing Data Set 28.';

StrWritingDataSet29 = ' Writing Data Set 29.';

StrWritingDataSet30 = ' Writing Data Set 30.';

StrWritingDataSet31 = ' Writing Data Set 31.';

rsNewDataSet = 'New data set';

rsSetValueOfEnclosed = 'Set values of enclosed ';

rsSetValueOfIntersected = 'Set values of intersected ';

rsSetValueOf = 'Set values of ';

rsByInterpolation = ' by interpolation';

StrLowerLimit = 'Lower limit';

StrUpperLimit = 'Upper limit';

StrObjectIntersectLength = 'ObjectIntersectLength';

StrObjectSectionIntersectLength = 'ObjectSectionIntersectLength';

StrObjectIntersectArea = 'ObjectIntersectArea';

StrObjectArea = 'ObjectArea';

StrObjectLength = 'ObjectLength';

StrLayerBoundaryPosition = 'LayerBoundaryPosition';

StrStartingTime = 'Starting time';

StrEndingTime = 'Ending time';

StrPumpingRate = 'Pumping rate';

StrConductance = 'Conductance';

StrConductanceMultipl = ' conductance multiplier';

StrRiverStage = 'River stage';

StrRiverBottom = 'River bottom';

StrBoundaryHead = 'Boundary head';

StrDrainElevation = 'Drain elevation';

StrStartingHead = 'Starting head';

StrEndingHead = 'Ending head';

StrElevation = 'Elevation';

StrVariance = 'Variance (0)';

StrStdDev = 'Standard dev. (1)';

StrCoefVar = 'Coef. of var. (2)';

StrWt = 'Weight (3)';

StrSqRtWt = 'Sq. rt. of weight (4)';

EndOfLine = sLineBreak;

StrStressPeriodLabel = 'Stress Period: ';

StrTimeStepLabel = 'Time Step: ';

StrElapsedTimeLabel = 'Elapsed Time: ';

StrTransportStep = 'Transport Step: ';

StrParentModel = 'Parent model';

StrYouNeedToSelectA = 'You need to select a row in the grid before clickin' +
  'g the Insert button.';

ReadWritePermissions = 0;

clTransparent32 : TColor32 = 0;

SelectEpsilon = 5;

StrNoBoundaryConditio = 'No boundary conditions assigned to the %s because' +
  ' the object does not set the values of either enclosed or intersected cel' +
  'ls.';

StrErrorObjectDuplicateTimes = 'Error; Object = %0:s Duplicate Times = %1:s';

StrErrorObjectEarlyTimes = 'Error; Object = %0:s Early Times = %1:s';

StrErrorObjectLateTimes = 'Error; Object = %0:s Late Times = %1:s';

StrObjectS = 'Object: %s';

StrObjectSTimeG = 'Object: %0:s; Time: %1:g';

StrAssignedBy0sWit = 'Assigned by %0:s with formula = "%1:s."';

Variables

ObservationStatFlagLabels: TStringList = nil;

PredictionStatFlagLabels: TStringList = nil;

Description

Functions and Procedures

function EvalAtToString(const Eval: TEvaluatedAt; const Model: TModelSelection; const Plural, TitleCase: boolean): string;

function ValidName(const OriginalName: string): string;

function RightCopy(const Source: string; LengthToCopy: integer): string;

function OrientationToViewDirection(Orientation: TDataSetOrientation): TViewDirection;

function StrToStatFlag(Const AStatFlagLabel: string): TStatFlag;

function StatFlatToStr(AStatFlag: TStatFlag): string;

function SortLayerSorts(Item1, Item2: Pointer): Integer;

Types

PReal = ˆReal;

defines TColor32.

TOneDRealArray = array of Double;

TOneDRealArray is a one-dimensional array of doubles.

TOneDIntegerArray = array of integer;

TOneDIntegerArray is a one-dimensional array of integers.

TTwoDRealArray = array of TOneDRealArray;

TTwoDRealArray is a two-dimensional array of doubles.

TThreeDRealArray = array of TTwoDRealArray;

TThreeDRealArray is a three-dimensional array of doubles.

P2DRealPoint = TPoint2DPtr;

P2DRealPoint is a pointer to a TPoint2D.

TRealPointArray = TPolygon2D;

TRealPointArray is a one-dimensional array of T2DRealPoints.

T2DRealPointArray = array of TRealPointArray;

T2DRealPointArray is a two-dimensional array of T2DRealPoints.

T2DBoolArray = array of array of boolean;

T2DBoolArray is a two-dimensional array of booleans.

T3DRealPoint = TPoint3D;

T3DRealPoint represents a 3D point with real-number coordinates.

P3DRealPoint = ˆT3DRealPoint;

TRealArray = array of Real;

T3DRealPointArray1 = array of T3DRealPoint;

T3DRealPointArray1 is a 1D array of T3DRealPoints.

T3DRealPointArray2 = array of T3DRealPointArray1;

T3DRealPointArray2 is a 2D array of T3DRealPoints.

T3DRealPointArray3 = array of array of array of T3DRealPoint;

T3DRealPointArray3 is a 3D array of T3DRealPoints.

TCursorGrid = (...);

TCursorGrid is used to indicate which view of the model the cursor is over.

Values

cgNone:
cgTop:
cgFront:
cgSide:

TViewDirection = (...);

TViewDirection is used to describe the direction TScreenObjects are viewed from.

Values

vdTop:
vdFront:
vdSide:

TViewDirections = set of TViewDirection;

TDataColumns = (...);

TDataColumns is used to specify the columns in the table on TfrmDataSets.

Values

dcName: = name of the TDataArray.
dcType: = the type of data DataType (boolean, integer, real number, or string) stored by the TDataArray.
dcOrientation: = the Orientation of the TDataArray.
dcEvaluatedAt: = the EvaluatedAt of the TDataArray.
dcUnits: = the Units of the TDataArray.
dcFormula: = the Formula of the TDataArray.
dcInterpolation: = the TwoDInterpolator of the TDataArray.

TDataLock = set of TDataColumns;

TDataLock specifies which values in the table on TfrmDataSets the user can edit. only columns not included in TDataLock can be edited.

TDataSetOrientation = (...);

TDataSetOrientation is used in TDataArray.Orientation to indicate whether the TDataArray is a 2D or 3D data set and, if it is 2D, which face of the grid it is associated with.

Values

dsoTop: 2D top face
dsoFront: 2D front face
dsoSide: 2D side face
dso3D: 3D

TDataSetOrientations = set of TDataSetOrientation;

TElevationCount = (...);

TElevationCount is used in specifying the number of elevations associated with a TScreenObject.

Values

ecZero:
ecOne:
ecTwo:

TEvaluatedAt = (...);

TEvaluatedAt is used to specify whether a data set is evaluated at element centers or at nodes.

Values

eaBlocks:
eaNodes:

TLgrCellTreatment = (...);

Values

lctUse:
lctIgnore:
lctZero:

TFrequencyUnits = (...);

TFrequencyUnits represents the frequencies with which data can be printed in PHAST.

Values

fuDefault:
fuSeconds:
fuMinutes:
fuHours:
fuDays:
fuYears:
fuStep:
fuEnd:

TTimeUnits = (...);

TTimeUnits represents the time units recognized by PHAST.

Values

tuSeconds:
tuMinutes:
tuHours:
tuDays:
tuYears:

TLengthUnits = (...);

TLengthUnits represents the length units recognized by PHAST.

Values

luInches:
luFeet:
luMiles:
luMillimeters:
luCentimeters:
luMeters:
luKilometers:

TInverseLengthUnits = (...);

TInverseLengthUnits represents the 1/length units recognized by PHAST.

Values

iluInches:
iluFeet:
iluMiles:
iluMillimeters:
iluCentimeters:
iluMeters:
iluKilometers:

TVolumeUnits = (...);

TVolumeUnits represents the volume units recognized by PHAST.

Values

vuGallons:
vuInches3:
vuFeet3:
vuMiles3:
vuLiters:
vuMillimeters3:
vuCentimeters3:
vuMeters3:
vuKilometers3:

TPhastSolver = (...);

TPhastSolver represents the solvers used by PHAST.

Values

psDirect:
psIterative:

TInterpolationDirection = (...);

TInterpolationDirection determines whether "PHAST" style interpolation is used or "PHAST" style mixtures. If "PHAST" style interpolation is used, it also determines the coordinate direction. See TPhastInterpolationValues.

Values

pidX: = Interpolate in the X direction.
pidY: = Interpolate in the Y direction.
pidZ: = Interpolate in the Z direction.
pidMix: = Use "PHAST" style mixtures.

PInterpolationDirection = ˆTInterpolationDirection;

PInterpolationDirection is a pointer to a TInterpolationDirection.

  PInterpolationDirection = ˆTInterpolationDirection;

TPrintFrequencyRows = (...);

TPrintFrequencyRows represent the items whose print frequencies can be specified in PHAST.

Values

pfrName:
pfrTime:
pfrFlowRate:
pfrComponents:
pfrConductance:
pfrFlowBalance:
pfrChemPrint:
pfrHDFChem:
pfrHDFHeads:
pfrHDFVelocity:
pfrHeads:
pfrProgress:
pfrRestart:
pfrVelocities:
pfrWells:
pfrXYZChem:
pfrXYZComponents:
pfrXYZHeads:
pfrXYZVelocities:
pfrXYZWells:
pfrBoundaryConditions:
pfrDefault:

TPhastBoundaryTypes = (...);

TPhastBoundaryTypes represents the types of boundary

Values

btNone: = no boundary condition
btSpecifiedHead: = Specified head boundary condition
btFlux: = Flux boundary condition
btLeaky: = Leaky boundary condition
btRiver: = River boundary condition
btWell: = Well boundary condition

TModflowBoundaryType = (...);

Values

mbtNone:
mbtCHD:

TWellElevationFormat = (...);

TWellElevationFormat specifies how elevations are specified in the well boundary condition. See WellElevationFormat.

Values

wefElevation:
wefDepth:

TModelSelection = (...);

TModelSelection is used to indicate what type of model is active. The type of model should never be set to msUndefined.

Values

msUndefined:
msPhast:
msModflow:
msModflowLGR:
msModflowNWT:

TGrowthMethod = (...);

TGrowthMethod is used to indicate how the spacing of layers within a unit is specified. The layers are spaced uniformly. The layers increase in thickness upward. The layers increase in thickness downward. The layers increase in thickness toward the middle of the unit from both the top and bottom. The layers increase in thickness toward both the top and bottom of the unit from the middle. The thickness of each layer is specified individually.

Values

gmUniform:
gmUp:
gmDown:
gmMiddle:
gmEdge:
gmCustom:

TAssignmentLocation = (...);

TAssignmentLocation indicates the locations at which a TScreenObject should assign values to cells in a TDataArray

Values

alAll: Assign values to all locations.
alFirstVertex: Assign values to cells at the location of the first vertex in the TScreenObject.
alLastVertex: Assign values to cells at the location of the last vertex in the TScreenObject.

TByteSet = set of byte;

TIface = (...);

Values

iIndeterminant:
iHorizontal:
iInternal:
iLeft:
iRight:
iFront:
iBack:
iBottom:
iTop:

TStatFlag = (...);

Values

stVariance:
stStandardDev:
stCoefVar:
stWeight:
stSquaredWeight:

TObservationPurpose = (...);

Values

ofObserved:
ofPredicted:
ofInacative:

TUpdateMethod = (...);

TUpdateMethod is used in AssignTransient2DArray.

Values

umAssign: Replace existing values with new values.
umAdd: Add new values to existing values.

TObservationType = (...);

In MT3DMS transport observations, observation results can be specified either at a specific time or at a desired frequency using the same variable. TObservationType is used to indicate which form is to be used.

Values

otTime:
otFrequency:

TDisplayChoice = (...);

Values

dcColor:
dcContour:
dcNone:

TPointArray = array of TPoint;

Constants

TimeEpsilon = 1e-6;

kModelTop = 'Model_Top';

BlankSpaces = ' ';

BlankSpaces is used when writing the PHAST input file to insert a consistent number of blank spaces.

  BlankSpaces = '      ';

MRU_Section = 'MostRecentlyUsed';

MRU_Section is the section name in the ini file that holds the names of the most recently opened files.

StrModelTop = kModelTop;

StrWritingDataSet1 = ' Writing Data Set 1.';

StrWritingDataSet2 = ' Writing Data Set 2.';

StrWritingDataSet3 = ' Writing Data Set 3.';

StrWritingDataSet4 = ' Writing Data Set 4.';

StrWritingDataSet5 = ' Writing Data Set 5.';

StrWritingDataSet6 = ' Writing Data Set 6.';

StrWritingDataSet7 = ' Writing Data Set 7.';

StrWritingDataSet8 = ' Writing Data Set 8.';

StrWritingDataSet10 = ' Writing Data Set 10.';

StrWritingDataSet14 = ' Writing Data Set 14.';

StrWritingDataSet15 = ' Writing Data Set 15.';

StrWritingDataSet16 = ' Writing Data Set 16.';

StrWritingDataSet17 = ' Writing Data Set 17.';

StrWritingDataSet22 = ' Writing Data Set 22.';

StrWritingDataSet23 = ' Writing Data Set 23.';

StrWritingDataSet24 = ' Writing Data Set 24.';

StrWritingDataSet25 = ' Writing Data Set 25.';

StrWritingDataSet26 = ' Writing Data Set 26.';

StrWritingDataSet27 = ' Writing Data Set 27.';

StrWritingDataSet28 = ' Writing Data Set 28.';

StrWritingDataSet29 = ' Writing Data Set 29.';

StrWritingDataSet30 = ' Writing Data Set 30.';

StrWritingDataSet31 = ' Writing Data Set 31.';

rsNewDataSet = 'New data set';

rsNewDataSet is used as the default name for a new data set.

  rsNewDataSet = 'New data set';

rsSetValueOfEnclosed = 'Set values of enclosed ';

rsSetValueOfEnclosed is used to set captions for several radio buttons. frmScreenObjectPropertiesUnit.TfrmScreenObjectProperties.SetCheckBoxCaptions)

Variables

ObservationStatFlagLabels: TStringList = nil;

PredictionStatFlagLabels: TStringList = nil;

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

Unit GoPhastTypes

Description

Uses

Overview

Classes, Interfaces, Objects and Records

Functions and Procedures

Types

Constants

Variables

Description

Functions and Procedures

Types

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Values

Constants

See also

See also

See also

See also

Variables