Class TModflowStressPeriods

Unit

ModflowTimeUnit

Declaration

type TModflowStressPeriods = class(TCollection)

Description

TModflowStressPeriods is a collection of the data defining all the stress periods in the model.

Hierarchy

TCollection
TModflowStressPeriods

Overview

Fields

FModel: TBaseModel;

Methods

	`function GetItems(Index: Integer): TModflowStressPeriod;`
	`procedure InvalidateModel;`
	`procedure SetItems(Index: Integer; const Value: TModflowStressPeriod);`
	`function GetNumberOfSteps: integer;`
	`procedure Assign(Source: TPersistent); override;`
	`constructor Create(Model: TBaseModel);`
	`procedure WriteStressPeriods(const DiscretizationWriter: TObject);`
	`procedure WriteMt3dmsStressPeriods(const Mt3dmsBasicWriter: TObject);`
	`function TransientModel: boolean;`
	`Function CompletelyTransient: boolean;`
	`procedure FillPickListWithEndTimes(Grid: TRbwDataGrid4; Col: integer);`
	`procedure FillPickListWithStartTimes(Grid: TRbwDataGrid4; Col: integer);`
	`procedure TimeToPeriodAndStep(ATime: double; out Period, Step: integer);`
	`procedure FillStringsWithStartTimes(Strings: TStrings);`
	`procedure FillStringsWithEndTimes(Strings: TStrings);`
	`function MaxStepsInAnyStressPeriod: integer;`
	`function FindStressPeriod(ATime: double): integer;`

Properties

	`property Items[Index:Integer]: TModflowStressPeriod read GetItems write SetItems;`
	`property NumberOfSteps: integer read GetNumberOfSteps;`

Description

Fields

	`FModel: TBaseModel;`
`FModel` is either nil or a TPhastModel.

Methods

	`function GetItems(Index: Integer): TModflowStressPeriod;`
See Items.

	`procedure InvalidateModel;`
`InvalidateModel` calls Invalidate indirectly.

	`procedure SetItems(Index: Integer; const Value: TModflowStressPeriod);`
See Items.

	`function GetNumberOfSteps: integer;`

	`procedure Assign(Source: TPersistent); override;`
`Assign` copies Source to the current `TModflowStressPeriods`.

	`constructor Create(Model: TBaseModel);`
`Create` creates an instance of `TModflowStressPeriods`. Model must be either nil or a TPhastModel.

	`procedure WriteStressPeriods(const DiscretizationWriter: TObject);`
`WriteStressPeriods` writes the stress periods to the MODFLOW discretization file.

	`procedure WriteMt3dmsStressPeriods(const Mt3dmsBasicWriter: TObject);`

	`function TransientModel: boolean;`
`TransientModel` returns true if any stress period in the model is transient.

	`Function CompletelyTransient: boolean;`
`CompletelyTransient` returns `True` if every stress period is transient.

	`procedure FillPickListWithEndTimes(Grid: TRbwDataGrid4; Col: integer);`

	`procedure FillPickListWithStartTimes(Grid: TRbwDataGrid4; Col: integer);`

	`procedure TimeToPeriodAndStep(ATime: double; out Period, Step: integer);`
`TimeToPeriodAndStep` determines the stress period and time step corresponding to a particular time. Period and Step are zero based.

	`procedure FillStringsWithStartTimes(Strings: TStrings);`

	`procedure FillStringsWithEndTimes(Strings: TStrings);`

	`function MaxStepsInAnyStressPeriod: integer;`

	`function FindStressPeriod(ATime: double): integer;`

Properties

	`property Items[Index:Integer]: TModflowStressPeriod read GetItems write SetItems;`
`Items` is used to access a TModflowStressPeriod stored in `TModflowStressPeriods`.

	`property NumberOfSteps: integer read GetNumberOfSteps;`

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