Class TModflowStressPeriod

Unit

ModflowTimeUnit

Declaration

type TModflowStressPeriod = class(TCollectionItem)

Description

TModflowStressPeriod represents a single stress period in MODFLOW.

Hierarchy

TCollectionItem
TModflowStressPeriod

Overview

Fields

	`FEndTime: double;`
	`FMaxLengthOfFirstTimeStep: double;`
	`FPeriodLength: double;`
	`FStartTime: double;`
	`FStressPeriodType: TStressPeriodType;`
	`FTimeStepMultiplier: double;`
	`FDrawDownReference: boolean;`

Methods

	`procedure InvalidateModel;`
	`procedure SetEndTime(const Value: double);`
	`procedure SetMaxLengthOfFirstTimeStep(const Value: double);`
	`procedure SetPeriodLength(const Value: double);`
	`procedure SetStartTime(const Value: double);`
	`procedure SetStressPeriodType(const Value: TStressPeriodType);`
	`procedure SetTimeStepMultiplier(const Value: double);`
	`procedure SetDrawDownReference(const Value: boolean);`
	`procedure Assign(Source: TPersistent); override;`
	`constructor Create(Collection: TCollection); override;`
	`destructor Destroy; override;`
	`function NumberOfSteps: integer;`
	`function LengthOfFirstTimeStep: double;`

Properties

	`property DrawDownReference: boolean read FDrawDownReference write SetDrawDownReference;`
	`property EndTime: double read FEndTime write SetEndTime;`
	`property MaxLengthOfFirstTimeStep: double read FMaxLengthOfFirstTimeStep write SetMaxLengthOfFirstTimeStep;`
	`property PeriodLength: double read FPeriodLength write SetPeriodLength;`
	`property StartTime: double read FStartTime write SetStartTime;`
	`property StressPeriodType: TStressPeriodType read FStressPeriodType write SetStressPeriodType;`
	`property TimeStepMultiplier: double read FTimeStepMultiplier write SetTimeStepMultiplier;`

Description

Fields

	`FEndTime: double;`
See EndTime.

	`FMaxLengthOfFirstTimeStep: double;`
See MaxLengthOfFirstTimeStep.

	`FPeriodLength: double;`
See PeriodLength.

	`FStartTime: double;`
See StartTime.

	`FStressPeriodType: TStressPeriodType;`
See StressPeriodType.

	`FTimeStepMultiplier: double;`
See TimeStepMultiplier.

	`FDrawDownReference: boolean;`

Methods

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

	`procedure SetEndTime(const Value: double);`
See EndTime.

	`procedure SetMaxLengthOfFirstTimeStep(const Value: double);`
See MaxLengthOfFirstTimeStep.

	`procedure SetPeriodLength(const Value: double);`
See PeriodLength.

	`procedure SetStartTime(const Value: double);`
See StartTime.

	`procedure SetStressPeriodType(const Value: TStressPeriodType);`
See StressPeriodType.

	`procedure SetTimeStepMultiplier(const Value: double);`
See TimeStepMultiplier.

	`procedure SetDrawDownReference(const Value: boolean);`

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

	`constructor Create(Collection: TCollection); override;`
`Create` initializes the properties of the `TModflowStressPeriod` and calls InvalidateModel.

	`destructor Destroy; override;`
`Destroy` calls InvalidateModel.

	`function NumberOfSteps: integer;`
`NumberOfSteps` is the number of steps in a stress period.

	`function LengthOfFirstTimeStep: double;`

Properties

	`property DrawDownReference: boolean read FDrawDownReference write SetDrawDownReference;`
If `DrawDownReference` is true, the head at the end of this stress period will be used as a reference head for computing drawdown.

	`property EndTime: double read FEndTime write SetEndTime;`
`EndTime` is the time of the end of the stress period. `EndTime` is not exported but it is used in TfrmModflowTime to calculate the length of the stress period (PeriodLength).

	`property MaxLengthOfFirstTimeStep: double read FMaxLengthOfFirstTimeStep write SetMaxLengthOfFirstTimeStep;`
`MaxLengthOfFirstTimeStep` is the maximum allowable length (as specified by the user) of the first time step in a stress period.

	`property PeriodLength: double read FPeriodLength write SetPeriodLength;`
`PeriodLength` is the length of the stress period.

	`property StartTime: double read FStartTime write SetStartTime;`
`StartTime` is the time of the start of the stress period. `StartTime` is not exported but it is used in TfrmModflowTime to calculate the length of the stress period (PeriodLength).

	`property StressPeriodType: TStressPeriodType read FStressPeriodType write SetStressPeriodType;`
`StressPeriodType` indicates whether this is a steady-state or transient stress period.

	`property TimeStepMultiplier: double read FTimeStepMultiplier write SetTimeStepMultiplier;`
`TimeStepMultiplier` indicates the fraction by which each time step increases in size over the length of the previous time step in the same stress period.

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