Class TSteadyFlowOptions

Unit

Declaration

type TSteadyFlowOptions = class(TPersistent)

Description

TSteadyFlowOptions is used to store options related to the STEADY_FLOW data block in PHAST.

Hierarchy

TPersistent
TSteadyFlowOptions

Overview

Fields

	`FFlowBalanceTolerance: double;`
	`FHeadChangeLimit: double;`
	`FHeadTolerance: double;`
	`FIterations: integer;`
	`FMaximumTimeStep: double;`
	`FMinimumTimeStep: double;`
	`FSteadyFlow: boolean;`
	`FUseDefaultHeadChangeLimit: boolean;`
	`FUseDefaultMaximumTimeStep: boolean;`
	`FUseDefaultMinimumTimeStep: boolean;`

Methods

	`procedure SetFlowBalanceTolerance(const Value: double);`
	`procedure SetHeadChangeLimit(const Value: double);`
	`procedure SetHeadTolerance(const Value: double);`
	`procedure SetIterations(const Value: integer);`
	`procedure SetMaximumTimeStep(const Value: double);`
	`procedure SetMinimumTimeStep(const Value: double);`
	`procedure SetSteadyFlow(const Value: boolean);`
	`procedure SetUseDefaultHeadChangeLimit(const Value: boolean);`
	`procedure SetUseDefaultMaximumTimeStep(const Value: boolean);`
	`procedure SetUseDefaultMinimumTimeStep(const Value: boolean);`
	`procedure Assign(Source: TPersistent); override;`
	`constructor Create;`

Properties

	`property FlowBalanceTolerance: double read FFlowBalanceTolerance write SetFlowBalanceTolerance;`
	`property HeadChangeLimit: double read FHeadChangeLimit write SetHeadChangeLimit;`
	`property HeadTolerance: double read FHeadTolerance write SetHeadTolerance;`
	`property Iterations: integer read FIterations write SetIterations default 100;`
	`property MaximumTimeStep: double read FMaximumTimeStep write SetMaximumTimeStep;`
	`property MinimumTimeStep: double read FMinimumTimeStep write SetMinimumTimeStep;`
	`property SteadyFlow: boolean read FSteadyFlow write SetSteadyFlow;`
	`property UseDefaultHeadChangeLimit: boolean read FUseDefaultHeadChangeLimit write SetUseDefaultHeadChangeLimit default True;`
	`property UseDefaultMaximumTimeStep: boolean read FUseDefaultMaximumTimeStep write SetUseDefaultMaximumTimeStep default True;`
	`property UseDefaultMinimumTimeStep: boolean read FUseDefaultMinimumTimeStep write SetUseDefaultMinimumTimeStep default True;`

Description

Fields

	`FFlowBalanceTolerance: double;`
`FFlowBalanceTolerance`: double; See FlowBalanceTolerance.

	`FHeadChangeLimit: double;`
`FHeadChangeLimit`: double; See HeadChangeLimit.

	`FHeadTolerance: double;`
`FHeadTolerance`: double; See HeadTolerance.

	`FIterations: integer;`
`FIterations`: integer; See Iterations.

	`FMaximumTimeStep: double;`
`FMaximumTimeStep`: double; See MaximumTimeStep.

	`FMinimumTimeStep: double;`
`FMinimumTimeStep`: double; See MinimumTimeStep.

	`FSteadyFlow: boolean;`
`FSteadyFlow`: boolean; See SteadyFlow.

	`FUseDefaultHeadChangeLimit: boolean;`
`FUseDefaultHeadChangeLimit`: boolean; See UseDefaultHeadChangeLimit.

	`FUseDefaultMaximumTimeStep: boolean;`
`FUseDefaultMaximumTimeStep`: boolean; See UseDefaultMaximumTimeStep.

	`FUseDefaultMinimumTimeStep: boolean;`
`FUseDefaultMinimumTimeStep`: boolean; See UseDefaultMinimumTimeStep.

Methods

	`procedure SetFlowBalanceTolerance(const Value: double);`
See FlowBalanceTolerance.

	`procedure SetHeadChangeLimit(const Value: double);`
See HeadChangeLimit.

	`procedure SetHeadTolerance(const Value: double);`
See HeadTolerance.

	`procedure SetIterations(const Value: integer);`
See Iterations.

	`procedure SetMaximumTimeStep(const Value: double);`
See MaximumTimeStep.

	`procedure SetMinimumTimeStep(const Value: double);`
See MinimumTimeStep.

	`procedure SetSteadyFlow(const Value: boolean);`
See SteadyFlow.

	`procedure SetUseDefaultHeadChangeLimit(const Value: boolean);`
See UseDefaultHeadChangeLimit.

	`procedure SetUseDefaultMaximumTimeStep(const Value: boolean);`
See UseDefaultMaximumTimeStep.

	`procedure SetUseDefaultMinimumTimeStep(const Value: boolean);`
See UseDefaultMinimumTimeStep.

	`procedure Assign(Source: TPersistent); override;`
If Source is a `TSteadyFlowOptions`, `Assign` copies Source to the object that called `Assign`.

	`constructor Create;`
`Create` creates an instance of `TSteadyFlowOptions`

Properties

	`property FlowBalanceTolerance: double read FFlowBalanceTolerance write SetFlowBalanceTolerance;`
`FlowBalanceTolerance` is the error tolerance for the flow balance in PHAST.

	`property HeadChangeLimit: double read FHeadChangeLimit write SetHeadChangeLimit;`
`HeadChangeLimit` is the maximum head change in one time step in PHAST.

	`property HeadTolerance: double read FHeadTolerance write SetHeadTolerance;`
`HeadTolerance` is the error tolerance for the head in PHAST.

	`property Iterations: integer read FIterations write SetIterations default 100;`
`Iterations` is the maximum number of iterations in PHAST.

	`property MaximumTimeStep: double read FMaximumTimeStep write SetMaximumTimeStep;`
`MaximumTimeStep` is the maximum time-step size in PHAST.

	`property MinimumTimeStep: double read FMinimumTimeStep write SetMinimumTimeStep;`
`MinimumTimeStep` is the minimum time-step size in PHAST.

	`property SteadyFlow: boolean read FSteadyFlow write SetSteadyFlow;`
`SteadyFlow` species whether or not the PHAST is a steady-state simulation.

	`property UseDefaultHeadChangeLimit: boolean read FUseDefaultHeadChangeLimit write SetUseDefaultHeadChangeLimit default True;`
`UseDefaultHeadChangeLimit` specifies whether PHAST should use the default head-change limit or used HeadChangeLimit.

	`property UseDefaultMaximumTimeStep: boolean read FUseDefaultMaximumTimeStep write SetUseDefaultMaximumTimeStep default True;`
`UseDefaultMaximumTimeStep` specifies whether PHAST should use the default maximum time-step size or used MaximumTimeStep.

	`property UseDefaultMinimumTimeStep: boolean read FUseDefaultMinimumTimeStep write SetUseDefaultMinimumTimeStep default True;`
`UseDefaultMinimumTimeStep` specifies whether PHAST should use the default minimum time-step size or used MinimumTimeStep.

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