Struct mgrid::Settings

ClassList > mgrid > Settings

Multigrid solver settings.

• #include <settings.hpp>

Public Attributes

Type	Name
double	aspectRatio = {1.0} Aspect ratio of the domain.
int	maximumIterations = {400} Maximum solver iterations.
CycleType	mgCycleType = {wCycle} V- or W-cycle.
int	minimumResolution = {4} Resolution on the coarsest grid.
int	numberOfGrids = {8} Total number of grid levels.
unsigned long	postMGRelaxIter = {2} Post-correction relaxation sweeps.
unsigned long	preMGRelaxIter = {1} Pre-correction relaxation sweeps.
double	residualTolerance = {1e-10} Residual stopping tolerance.
bool	xPeriodic = {false} x-axis wraps periodically.
bool	zPeriodic = {false} z-axis wraps periodically.

Public Attributes Documentation

variable aspectRatio

Aspect ratio of the domain.

double mgrid::Settings::aspectRatio;

---

variable maximumIterations

Maximum solver iterations.

int mgrid::Settings::maximumIterations;

---

variable mgCycleType

V- or W-cycle.

CycleType mgrid::Settings::mgCycleType;

---

variable minimumResolution

Resolution on the coarsest grid.

int mgrid::Settings::minimumResolution;

---

variable numberOfGrids

Total number of grid levels.

int mgrid::Settings::numberOfGrids;

---

variable postMGRelaxIter

Post-correction relaxation sweeps.

unsigned long mgrid::Settings::postMGRelaxIter;

---

variable preMGRelaxIter

Pre-correction relaxation sweeps.

unsigned long mgrid::Settings::preMGRelaxIter;

---

variable residualTolerance

Residual stopping tolerance.

double mgrid::Settings::residualTolerance;

---

variable xPeriodic

x-axis wraps periodically.

bool mgrid::Settings::xPeriodic;

---

variable zPeriodic

z-axis wraps periodically.

bool mgrid::Settings::zPeriodic;

---

---

The documentation for this class was generated from the following file include/multigrid/settings.hpp