AdvanceOptions Class Reference

#include <AdvanceOptions.h>

Public Types
enum	TakeTimeStepOptionEnum { takeStepAndApplyBoundaryConditions, takeStepButDoNotApplyBoundaryConditions, applyBoundaryConditionsOnly }
enum	GridChangesEnum { noChangeToGrid, newAmrGrid }

Public Member Functions
	AdvanceOptions ()
	Constructor for the AdvanceStepsOptions class. This class holds options that are passed to the DomainSolver time stepping functions such as takeTimeStep, takeTimeStepFE, takeTimeStepPC, ...
	~AdvanceOptions ()
	Destructor for the AdvanceStepsOptions class.
	AdvanceOptions (const AdvanceOptions &x)
	Copy constructor.
AdvanceOptions &	operator= (const AdvanceOptions &x)
	Equals operator.

Public Attributes
TakeTimeStepOptionEnum	takeTimeStepOption
int	numberOfCorrectorSteps
GridChangesEnum	gridChanges
bool	correctionIterationsHaveConverged

Member Enumeration Documentation

enum AdvanceOptions::GridChangesEnum

Enumerator
noChangeToGrid
newAmrGrid

enum AdvanceOptions::TakeTimeStepOptionEnum

Enumerator
takeStepAndApplyBoundaryConditions
takeStepButDoNotApplyBoundaryConditions
applyBoundaryConditionsOnly

Constructor & Destructor Documentation

AdvanceOptions::AdvanceOptions

(

)

Constructor for the AdvanceStepsOptions class. This class holds options that are passed to the DomainSolver time stepping functions such as takeTimeStep, takeTimeStepFE, takeTimeStepPC, ...

References correctionIterationsHaveConverged, gridChanges, noChangeToGrid, numberOfCorrectorSteps, takeStepAndApplyBoundaryConditions, and takeTimeStepOption.

AdvanceOptions::~AdvanceOptions

(

)

Destructor for the AdvanceStepsOptions class.

AdvanceOptions::AdvanceOptions

(

const AdvanceOptions &

x

)

Copy constructor.

References x.

Member Function Documentation

AdvanceOptions & AdvanceOptions::operator=

(

const AdvanceOptions &

x

)

Equals operator.

References gridChanges, numberOfCorrectorSteps, and takeTimeStepOption.

Member Data Documentation

bool AdvanceOptions::correctionIterationsHaveConverged

Referenced by DomainSolver::advanceAdamsPredictorCorrectorNew(), DomainSolver::advanceImplicitMultiStepNew(), AdvanceOptions(), DomainSolver::takeTimeStepAF(), DomainSolver::takeTimeStepIM(), and DomainSolver::takeTimeStepPC().

GridChangesEnum AdvanceOptions::gridChanges

Referenced by AdvanceOptions(), operator=(), Cgsm::startTimeStep(), DomainSolver::startTimeStepAF(), DomainSolver::startTimeStepFE(), DomainSolver::startTimeStepIM(), DomainSolver::startTimeStepPC(), and DomainSolver::takeTimeStepFE().

int AdvanceOptions::numberOfCorrectorSteps

Referenced by DomainSolver::advanceAdamsPredictorCorrectorNew(), DomainSolver::advanceForwardEulerNew(), DomainSolver::advanceImplicitMultiStepNew(), AdvanceOptions(), operator=(), Cgsm::startTimeStep(), DomainSolver::startTimeStepAF(), DomainSolver::startTimeStepFE(), DomainSolver::startTimeStepIM(), and DomainSolver::startTimeStepPC().

TakeTimeStepOptionEnum AdvanceOptions::takeTimeStepOption

Referenced by AdvanceOptions(), operator=(), Cgsm::takeTimeStep(), and DomainSolver::takeTimeStepFE().

---

The documentation for this class was generated from the following files:

• AdvanceOptions.h
• AdvanceOptions.C