Class TSolutionOptions

DescriptionHierarchyFieldsMethodsProperties

Unit

PhastModelUnit

Declaration

type TSolutionOptions = class(TComponent)

Description

TSolutionOptions specifies options related to the solution method in PHAST.

Hierarchy

Overview

Fields

Private FCrossDispersion: boolean;
Private FMaximumIterations: integer;
Private FSaveDirections: integer;
Private FSolverType: TPhastSolver;
Private FSpaceDifferencing: double;
Private FTimeDifferencing: double;
Private FTimeDifferencingSet: boolean;
Private FTolerance: double;
Private FToleranceSet: boolean;
Private FRebalanceByCell: boolean;
Private FRebalanceFraction: TRealStorage;

Methods

Private procedure SetCrossDispersion(const Value: boolean);
Private procedure SetMaximumIterations(const Value: integer);
Private procedure SetSaveDirections(const Value: integer);
Private procedure SetSolverType(const Value: TPhastSolver);
Private procedure SetSpaceDifferencing(const Value: double);
Private procedure SetTimeDifferencing(const Value: double);
Private procedure SetTolerance(const Value: double);
Private procedure SetRebalanceByCell(const Value: boolean);
Private procedure SetRebalanceFraction(const Value: TRealStorage);
Protected procedure Initialize;
Protected procedure Loaded; override;
Public procedure Assign(Source: TPersistent); override;
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;

Properties

Published property CrossDispersion: boolean read FCrossDispersion write SetCrossDispersion stored True;
Published property MaximumIterations: integer read FMaximumIterations write SetMaximumIterations default 500;
Published property RebalanceFraction: TRealStorage read FRebalanceFraction write SetRebalanceFraction stored True;
Published property RebalanceByCell: boolean read FRebalanceByCell write SetRebalanceByCell;
Published property SaveDirections: integer read FSaveDirections write SetSaveDirections default 10;
Published property SolverType: TPhastSolver read FSolverType write SetSolverType default psIterative;
Published property SpaceDifferencing: double read FSpaceDifferencing write SetSpaceDifferencing stored True;
Published property TimeDifferencing: double read FTimeDifferencing write SetTimeDifferencing stored True;
Published property Tolerance: double read FTolerance write SetTolerance stored True;

Description

Fields

Private FCrossDispersion: boolean;

See CrossDispersion.

Private FMaximumIterations: integer;

See MaximumIterations.

Private FSaveDirections: integer;

See SaveDirections.

Private FSolverType: TPhastSolver;

See SolverType.

Private FSpaceDifferencing: double;

See SpaceDifferencing.

Private FTimeDifferencing: double;

See TimeDifferencing.

Private FTimeDifferencingSet: boolean;

Values of zero are never stored for real-number properties in Delphi. FTimeDifferencingSet is used to get around this limitation so that if a value of zero for TimeDifferencing is specified by the user, it can be recovered correctly when reading the file.

Private FTolerance: double;

See Tolerance.

Private FToleranceSet: boolean;

Values of zero are never stored for real-number properties in Delphi. FToleranceSet is used to get around this limitation so that if a value of zero for Tolerance is specified by the user, it can be recovered correctly when reading the file.

Private FRebalanceByCell: boolean;
 
Private FRebalanceFraction: TRealStorage;
 

Methods

Private procedure SetCrossDispersion(const Value: boolean);

See CrossDispersion.

Private procedure SetMaximumIterations(const Value: integer);

See MaximumIterations.

Private procedure SetSaveDirections(const Value: integer);

See SaveDirections.

Private procedure SetSolverType(const Value: TPhastSolver);

See SolverType.

Private procedure SetSpaceDifferencing(const Value: double);

See SpaceDifferencing.

Private procedure SetTimeDifferencing(const Value: double);

See TimeDifferencing.

Private procedure SetTolerance(const Value: double);

See Tolerance.

Private procedure SetRebalanceByCell(const Value: boolean);
 
Private procedure SetRebalanceFraction(const Value: TRealStorage);
 
Protected procedure Initialize;

Initialize initializes all published properties.

Protected procedure Loaded; override;

Loaded checks FTimeDifferencingSet and FToleranceSet. If one of them is false, the corresponding property is set to zero.

Public procedure Assign(Source: TPersistent); override;

If Source is a TSolutionOptions, Assign copies Source to the object that called Assign.

Public constructor Create(AOwner: TComponent); override;

Create creates an instance of TSolutionOptions

Public destructor Destroy; override;
 

Properties

Published property CrossDispersion: boolean read FCrossDispersion write SetCrossDispersion stored True;

CrossDispersion specifies whether PHAST should use cross-dispersion.

Published property MaximumIterations: integer read FMaximumIterations write SetMaximumIterations default 500;

MaximumIterations specifies the maximum number of iterations in PHAST.

Published property RebalanceFraction: TRealStorage read FRebalanceFraction write SetRebalanceFraction stored True;
 
Published property RebalanceByCell: boolean read FRebalanceByCell write SetRebalanceByCell;
 
Published property SaveDirections: integer read FSaveDirections write SetSaveDirections default 10;

SaveDirections specifies the number of save-directions in PHAST.

Published property SolverType: TPhastSolver read FSolverType write SetSolverType default psIterative;

SolverType specifies which solver to use in PHAST.

Published property SpaceDifferencing: double read FSpaceDifferencing write SetSpaceDifferencing stored True;

SpaceDifferencing specifies the space-differencing in PHAST.

Published property TimeDifferencing: double read FTimeDifferencing write SetTimeDifferencing stored True;

TimeDifferencing specifies the time-differencing in PHAST.

Published property Tolerance: double read FTolerance write SetTolerance stored True;

Tolerance specifies the tolerance in PHAST.

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