Skip to content

Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

  • namespace mgrid
    • struct Axis One grid axis: point count, spacing, and periodicity, with the index arithmetic every stencil / sweep / transfer needs. A bounded axis uses one-sided stencils at its ends and never wraps; a periodic axis has no ends (index arithmetic is mod n ).
    • class BoundaryConditions Container for boundary conditions on all four edges of a domain.
    • struct BoundaryLengthError Exception thrown when boundary condition arrays have mismatched lengths.
    • struct BoundaryPoint Boundary condition point (type and value).
    • struct Deriv Ten finite-difference partials at a point: dx, dxu, dz, dzu, dxx, dxxu, dzz, dzzu, dxz, dxzu.
    • class FDArray 2-D scalar field on a finite-difference grid: FDBase geometry plus an owningField2D of element values.
    • class FDBase
    • struct FDVecArray A 2-component vector field on a finite-difference grid.
    • class Field2D
    • struct InvalidBoundaryCondition Exception thrown when an invalid boundary condition is supplied.
    • class LinearMultigrid Linear full-multigrid (FMG) solver.
    • class MultigridBase Abstract base class for the multigrid solvers.
    • struct MultigridError Base exception for multigrid solver errors.
    • class NcWriter Incremental writer for a gridded solution file (netCDF-4).
    • class NonlinearMultigrid Nonlinear full-approximation-scheme (FAS) multigrid solver.
    • struct Settings Multigrid solver settings.
    • class Stack Grid-level hierarchy for a multigrid solve.
  • namespace std