CMGOptions Struct Reference

Structure containing multigrid options. More...

#include <option_structure.hpp>

Public Attributes
su2double	MG_Smooth_Res_Threshold {0.0}
	RMS reduction threshold for MG smoothing early exit.
su2double	MG_Smooth_Coeff {0.0}
	Jacobi smoother coefficient for coarse-grid correction.
unsigned long	MG_Min_MeshSize {0}
	Minimum CVs on coarsest MG level, over all ranks.
std::vector< unsigned short >	MG_PreSmooth
	Multigrid pre-smoothing iterations per level.
std::vector< unsigned short >	MG_PostSmooth
	Multigrid post-smoothing iterations per level.
std::vector< unsigned short >	MG_CorrecSmooth
	Multigrid Jacobi correction-smoothing per level.
std::vector< su2double >	MG_CflScaling
	Per-level CFL scaling factors relative to the previous (finer) level. Entry [i] scales level i+1 from level i. Size = nMGLevels.
bool	MG_Smooth_EarlyExit {false}
	Enable early exit for MG smoothing iterations.
bool	MG_Smooth_Output {false}
	Output compact per-cycle smoothing summary.
su2double	MG_Smooth_StagnationTol {0.0}
	Stagnation early exit: stop if current_rms >= prev_rms * tol. 0 = disabled.
bool	MG_Implicit_Lines {false}
	Enable implicit-lines agglomeration from walls.
unsigned long	MG_Startup_Iter {100}
	Iterations per mesh during FMG startup, and the length of each level's CFL ramp. 0 = no iteration budget.
su2double	MG_Startup_Convergence {-2.0}
	FMG: orders of magnitude (log10) that CONV_FIELD must drop on the active level before promoting to the next finer one. Negative is a drop, as for CONV_RESIDUAL_MINVAL.
su2double	MG_Startup_Stagnation {0.99}
	FMG: promote when the residual ratio between successive iterations exceeds this. 0 = disabled.
unsigned long	MG_Startup_Stagnation_Iter {5}
	FMG: consecutive stalled iterations required before promoting. 0 = disabled.

Detailed Description

Structure containing multigrid options.

Member Data Documentation

MG_CflScaling

std::vector<su2double> CMGOptions::MG_CflScaling

Per-level CFL scaling factors relative to the previous (finer) level. Entry [i] scales level i+1 from level i. Size = nMGLevels.

MG_CorrecSmooth

std::vector<unsigned short> CMGOptions::MG_CorrecSmooth

Multigrid Jacobi correction-smoothing per level.

MG_Implicit_Lines

bool CMGOptions::MG_Implicit_Lines {false}

Enable implicit-lines agglomeration from walls.

MG_Min_MeshSize

unsigned long CMGOptions::MG_Min_MeshSize {0}

Minimum CVs on coarsest MG level, over all ranks.

MG_PostSmooth

std::vector<unsigned short> CMGOptions::MG_PostSmooth

Multigrid post-smoothing iterations per level.

MG_PreSmooth

std::vector<unsigned short> CMGOptions::MG_PreSmooth

Multigrid pre-smoothing iterations per level.

MG_Smooth_Coeff

su2double CMGOptions::MG_Smooth_Coeff {0.0}

Jacobi smoother coefficient for coarse-grid correction.

MG_Smooth_EarlyExit

bool CMGOptions::MG_Smooth_EarlyExit {false}

Enable early exit for MG smoothing iterations.

MG_Smooth_Output

bool CMGOptions::MG_Smooth_Output {false}

Output compact per-cycle smoothing summary.

MG_Smooth_Res_Threshold

su2double CMGOptions::MG_Smooth_Res_Threshold {0.0}

RMS reduction threshold for MG smoothing early exit.

MG_Smooth_StagnationTol

su2double CMGOptions::MG_Smooth_StagnationTol {0.0}

Stagnation early exit: stop if current_rms >= prev_rms * tol. 0 = disabled.

MG_Startup_Convergence

su2double CMGOptions::MG_Startup_Convergence {-2.0}

FMG: orders of magnitude (log10) that CONV_FIELD must drop on the active level before promoting to the next finer one. Negative is a drop, as for CONV_RESIDUAL_MINVAL.

MG_Startup_Iter

unsigned long CMGOptions::MG_Startup_Iter {100}

Iterations per mesh during FMG startup, and the length of each level's CFL ramp. 0 = no iteration budget.

MG_Startup_Stagnation

su2double CMGOptions::MG_Startup_Stagnation {0.99}

FMG: promote when the residual ratio between successive iterations exceeds this. 0 = disabled.

MG_Startup_Stagnation_Iter

unsigned long CMGOptions::MG_Startup_Stagnation_Iter {5}

FMG: consecutive stalled iterations required before promoting. 0 = disabled.

---

The documentation for this struct was generated from the following file:

• Common/include/option_structure.hpp