Class TDrainReturn

Unit

ModflowDrtUnit

Declaration

type TDrainReturn = class(TGoPhastPersistent)

Description

Hierarchy

• TPersistent
• TGoPhastPersistent
• TDrainReturn

Overview

Fields

	FReturnObject: TReturnObject;
	FReturnCell: TReturnCell;
	FReturnLocation: TReturnLocation;
	FReturnChoice: TReturnChoice;

Methods

	procedure SetReturnCell(const Value: TReturnCell);
	procedure SetReturnChoice(const Value: TReturnChoice);
	procedure SetReturnLocation(const Value: TReturnLocation);
	procedure SetReturnObject(const Value: TReturnObject);
	function StoreReturnCell: boolean;
	function StoreReturnLocation: boolean;
	function StoreReturnObject: boolean;
	procedure Assign(Source: TPersistent); override;
	Constructor Create(Model: TBaseModel);
	Destructor Destroy; override;
	function ReturnCellLocation(AModel: TBaseModel): TCellLocation;

Properties

	property ReturnChoice: TReturnChoice read FReturnChoice write SetReturnChoice;
	property ReturnCell: TReturnCell read FReturnCell write SetReturnCell stored StoreReturnCell;
	property ReturnLocation: TReturnLocation read FReturnLocation write SetReturnLocation stored StoreReturnLocation;
	property ReturnObject: TReturnObject read FReturnObject write SetReturnObject stored StoreReturnObject;

Description

Fields

	FReturnObject: TReturnObject;

	FReturnCell: TReturnCell;

	FReturnLocation: TReturnLocation;

	FReturnChoice: TReturnChoice;

Methods

	procedure SetReturnCell(const Value: TReturnCell);

	procedure SetReturnChoice(const Value: TReturnChoice);

	procedure SetReturnLocation(const Value: TReturnLocation);

	procedure SetReturnObject(const Value: TReturnObject);

	function StoreReturnCell: boolean;

	function StoreReturnLocation: boolean;

	function StoreReturnObject: boolean;

	procedure Assign(Source: TPersistent); override;

	Constructor Create(Model: TBaseModel);

	Destructor Destroy; override;

	function ReturnCellLocation(AModel: TBaseModel): TCellLocation;
ReturnCellLocation returns the cell where the drain returns extracted water The cell numbers in the TCellLocation will be 1 based. If the TCellLocation.Layer = 0 no water is returned to the model.

Properties

	property ReturnChoice: TReturnChoice read FReturnChoice write SetReturnChoice;

	property ReturnCell: TReturnCell read FReturnCell write SetReturnCell stored StoreReturnCell;

	property ReturnLocation: TReturnLocation read FReturnLocation write SetReturnLocation stored StoreReturnLocation;

	property ReturnObject: TReturnObject read FReturnObject write SetReturnObject stored StoreReturnObject;