A geometrically stretched vertical grid: dz_k = dz0 * ratio^k. More...
#include <ERF_GridUtils.H>
Public Attributes | |
| amrex::Real | dz0 {amrex::Real(0.0)} |
| thickness of the first layer, as actually used More... | |
| amrex::Real | ratio {amrex::Real(1.0)} |
| layer-to-layer stretch factor More... | |
| amrex::Real | residual {amrex::Real(0.0)} |
| sum of the layers minus z_top, at exit More... | |
| bool | uniform {false} |
| true when the requested dz0 could not be honored More... | |
| bool | converged {false} |
| true when |residual| <= tol More... | |
Detailed Description
A geometrically stretched vertical grid: dz_k = dz0 * ratio^k.
The three numbers that define the grid, plus whether the solve that produced them actually converged, so a caller can fail loudly instead of using a bad factor.
Member Data Documentation
◆ converged
| bool erf_grid_utils::GeometricStretch::converged {false} |
true when |residual| <= tol
Referenced by erf_grid_utils::geometric_stretch(), and init_zlevels().
◆ dz0
| amrex::Real erf_grid_utils::GeometricStretch::dz0 {amrex::Real(0.0)} |
thickness of the first layer, as actually used
Referenced by erf_grid_utils::build_geometric_zlevels(), erf_grid_utils::geometric_stretch(), and init_zlevels().
◆ ratio
| amrex::Real erf_grid_utils::GeometricStretch::ratio {amrex::Real(1.0)} |
layer-to-layer stretch factor
Referenced by erf_grid_utils::build_geometric_zlevels(), erf_grid_utils::geometric_stretch(), and init_zlevels().
◆ residual
| amrex::Real erf_grid_utils::GeometricStretch::residual {amrex::Real(0.0)} |
sum of the layers minus z_top, at exit
Referenced by erf_grid_utils::geometric_stretch().
◆ uniform
| bool erf_grid_utils::GeometricStretch::uniform {false} |
true when the requested dz0 could not be honored
Referenced by erf_grid_utils::geometric_stretch(), and init_zlevels().
The documentation for this struct was generated from the following file:
- Source/Utils/ERF_GridUtils.H
